diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index e44b0f82929..21ecf3ac93d 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - name: 💬 General Question - url: https://github.com/awslabs/aws-sdk-kotlin/discussions/new/choose + url: https://github.com/aws/aws-sdk-kotlin/discussions/new/choose about: Please ask and answer questions as a discussion thread \ No newline at end of file diff --git a/.github/actions/setup-build/action.yml b/.github/actions/setup-build/action.yml index 23ee306ecd9..906ee1052b5 100644 --- a/.github/actions/setup-build/action.yml +++ b/.github/actions/setup-build/action.yml @@ -9,7 +9,7 @@ runs: uses: actions/checkout@v4 with: path: 'aws-kotlin-repo-tools' - repository: 'awslabs/aws-kotlin-repo-tools' + repository: 'aws/aws-kotlin-repo-tools' ref: '0.4.2' sparse-checkout: | .github @@ -21,14 +21,6 @@ runs: path: 'smithy-kotlin' repository: 'smithy-lang/smithy-kotlin' - # FIXME Remove this checkout of aws-crt-kotlin once K/N artifacts are published to Maven - - name: Checkout aws-crt-kotlin - uses: ./aws-kotlin-repo-tools/.github/actions/checkout-head - with: - # checkout aws-crt-kotlin as a sibling which will automatically make it an included build (transitively, through smithy-kotlin) - path: 'aws-crt-kotlin' - repository: 'awslabs/aws-crt-kotlin' - - name: Configure JDK uses: actions/setup-java@v3 with: diff --git a/.github/scripts/run-codebuild-batch-job.sh b/.github/scripts/run-codebuild-batch-job.sh index 75fbfef303b..67451916ad4 100755 --- a/.github/scripts/run-codebuild-batch-job.sh +++ b/.github/scripts/run-codebuild-batch-job.sh @@ -95,7 +95,7 @@ START_RESULT=$( --project-name ${PROJECT_NAME} \ --source-version $SOURCE_VERSION \ --environment-variables-override file:///tmp/gh_env_vars.json \ - --source-location-override "https://github.com/awslabs/$GITHUB_REPOSITORY_NO_ORG.git" + --source-location-override "https://github.com/aws/$GITHUB_REPOSITORY_NO_ORG.git" ) if [ "$?" != "0" ]; then diff --git a/.github/workflows/changelog-verification.yml b/.github/workflows/changelog-verification.yml index 457764177f5..913fad5c95f 100644 --- a/.github/workflows/changelog-verification.yml +++ b/.github/workflows/changelog-verification.yml @@ -21,4 +21,4 @@ jobs: aws-region: us-west-2 - name: Verify changelog - uses: awslabs/aws-kotlin-repo-tools/.github/actions/changelog-verification@main \ No newline at end of file + uses: aws/aws-kotlin-repo-tools/.github/actions/changelog-verification@main \ No newline at end of file diff --git a/.github/workflows/codebuild-ci.yml b/.github/workflows/codebuild-ci.yml index c366e538217..0951c5eff69 100644 --- a/.github/workflows/codebuild-ci.yml +++ b/.github/workflows/codebuild-ci.yml @@ -43,6 +43,9 @@ jobs: if: github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' runs-on: ubuntu-latest steps: + - name: Set start timestamp + id: start + run: printf 'timestamp=%(%s)T\n' >> "$GITHUB_OUTPUT" - name: Verify PRs are not running malicious code if: ${{ (inputs.aws-sdk-kotlin-pr != '' || inputs.smithy-kotlin-pr != '') && inputs.check-pr == false }} run: | @@ -53,6 +56,8 @@ jobs: with: role-to-assume: ${{ secrets.CI_AWS_ROLE_ARN }} aws-region: us-west-2 + - name: Setup kat + uses: aws/aws-kotlin-repo-tools/.github/actions/setup-kat@main - name: Run E2E Tests id: e2e-tests uses: aws-actions/aws-codebuild-run-build@v1 @@ -68,11 +73,33 @@ jobs: echo "cancelling in-progress build: id=$BUILD_ID" aws codebuild stop-build --id $BUILD_ID fi + - name: Calculate duration + id: end + if: always() + run: | + printf -v now '%(%s)T' + duration=$(( now - ${{ steps.start.outputs.timestamp }} )) + echo "duration=$duration" >> "$GITHUB_OUTPUT" + - name: Emit metrics + if: always() # run this step even if previous steps failed or the job is canceled + uses: aws/aws-kotlin-repo-tools/.github/actions/emit-metrics@main + with: + namespace: CI Metrics + dimensions: | + Product=aws-sdk-kotlin + JobName=${{ github.job }} + Branch=${{ github.base_ref || github.ref_name }} + metrics: | + WorkflowSucceeded:${{ job.status == 'success' && '1' || '0' }}:Count + WorkflowDuration:${{ steps.end.outputs.duration }}:Seconds service-check-batch-and-artifact-size-metrics: if: github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' runs-on: ubuntu-latest steps: + - name: Set start timestamp + id: start + run: printf 'timestamp=%(%s)T\n' >> "$GITHUB_OUTPUT" - name: Verify PRs are not running malicious code if: ${{ (inputs.aws-sdk-kotlin-pr != '' || inputs.smithy-kotlin-pr != '') && inputs.check-pr == false }} run: | @@ -85,8 +112,10 @@ jobs: with: role-to-assume: ${{ secrets.CI_AWS_ROLE_ARN }} aws-region: us-west-2 + - name: Setup kat + uses: aws/aws-kotlin-repo-tools/.github/actions/setup-kat@main - name: Configure Gradle - uses: awslabs/aws-kotlin-repo-tools/.github/actions/configure-gradle@main + uses: aws/aws-kotlin-repo-tools/.github/actions/configure-gradle@main - name: Run Service Check Batch and Calculate Artifact Size Metrics id: svc-check-batch run: | @@ -144,7 +173,7 @@ jobs: run: ./gradlew analyzeArtifactSizeMetrics - name: Show Results - uses: awslabs/aws-kotlin-repo-tools/.github/actions/artifact-size-metrics/show-results@main + uses: aws/aws-kotlin-repo-tools/.github/actions/artifact-size-metrics/show-results@main - name: Evaluate Result if: ${{ !contains(github.event.pull_request.labels.*.name, 'acknowledge-artifact-size-increase') }} @@ -155,6 +184,25 @@ jobs: echo If this is expected please add the 'acknowledge-artifact-size-increase' label to this pull request. exit 1 } + - name: Calculate duration + id: end + if: always() + run: | + printf -v now '%(%s)T' + duration=$(( now - ${{ steps.start.outputs.timestamp }} )) + echo "duration=$duration" >> "$GITHUB_OUTPUT" + - name: Emit metrics + if: always() # run this step even if previous steps failed or the job is canceled + uses: aws/aws-kotlin-repo-tools/.github/actions/emit-metrics@main + with: + namespace: CI Metrics + dimensions: | + Product=aws-sdk-kotlin + JobName=${{ github.job }} + Branch=${{ github.base_ref || github.ref_name }} + metrics: | + WorkflowSucceeded:${{ job.status == 'success' && '1' || '0' }}:Count + WorkflowDuration:${{ steps.end.outputs.duration }}:Seconds release-artifact-size-metrics: if: github.event_name == 'release' @@ -168,7 +216,7 @@ jobs: role-to-assume: ${{ secrets.CI_AWS_ROLE_ARN }} aws-region: us-west-2 - name: Configure Gradle - uses: awslabs/aws-kotlin-repo-tools/.github/actions/configure-gradle@main + uses: aws/aws-kotlin-repo-tools/.github/actions/configure-gradle@main - name: Calculate Artifact Size Metrics id: svc-check-batch run: | diff --git a/.github/workflows/codegen-preview.yml b/.github/workflows/codegen-preview.yml index 58b45dc0dfd..805ab049077 100644 --- a/.github/workflows/codegen-preview.yml +++ b/.github/workflows/codegen-preview.yml @@ -48,7 +48,7 @@ jobs: path: 'aws-sdk-kotlin' - uses: actions/checkout@v4 with: - repository: 'awslabs/aws-kotlin-repo-tools' + repository: 'aws/aws-kotlin-repo-tools' path: 'aws-kotlin-repo-tools' - uses: actions/checkout@v4 with: diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index 1cd7964974f..7f011b1e143 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -4,8 +4,9 @@ on: pull_request: workflow_dispatch: -permissions: { } - +permissions: + id-token: write + contents: read # Allow one instance of this workflow per pull request, and cancel older runs when new changes are pushed concurrency: group: ci-pr-${{ github.ref }} @@ -29,6 +30,9 @@ jobs: - 17 - 21 steps: + - name: Set start timestamp + id: start + run: printf 'timestamp=%(%s)T\n' >> "$GITHUB_OUTPUT" - name: Checkout sources uses: actions/checkout@v4 with: @@ -36,9 +40,16 @@ jobs: - name: Setup Build uses: ./aws-sdk-kotlin/.github/actions/setup-build - name: Configure Gradle - uses: awslabs/aws-kotlin-repo-tools/.github/actions/configure-gradle@main + uses: aws/aws-kotlin-repo-tools/.github/actions/configure-gradle@main with: working-directory: ./aws-sdk-kotlin + - name: Configure AWS Credentials + uses: aws-actions/configure-aws-credentials@v4 + with: + role-to-assume: ${{ secrets.CI_AWS_ROLE_ARN }} + aws-region: us-west-2 + - name: Setup kat + uses: aws/aws-kotlin-repo-tools/.github/actions/setup-kat@main - name: Test working-directory: ./aws-sdk-kotlin shell: bash @@ -46,6 +57,25 @@ jobs: pwd ls -lsa ./gradlew -Ptest.java.version=${{ matrix.java-version }} jvmTest --stacktrace + - name: Calculate duration + id: end + if: always() + run: | + printf -v now '%(%s)T' + duration=$(( now - ${{ steps.start.outputs.timestamp }} )) + echo "duration=$duration" >> "$GITHUB_OUTPUT" + - name: Emit metrics + if: always() # run this step even if previous steps failed or the job is canceled + uses: aws/aws-kotlin-repo-tools/.github/actions/emit-metrics@main + with: + namespace: CI Metrics + dimensions: | + Product=aws-sdk-kotlin + JobName=${{ github.job }}(${{ matrix.java-version }}) + Branch=${{ github.base_ref || github.ref_name }} + metrics: | + WorkflowSucceeded:${{ job.status == 'success' && '1' || '0' }}:Count + WorkflowDuration:${{ steps.end.outputs.duration }}:Seconds - name: Save Test Reports if: failure() uses: actions/upload-artifact@v4 @@ -60,6 +90,10 @@ jobs: matrix: os: [ ubuntu-latest, macos-latest, windows-latest ] steps: + - name: Set start timestamp + id: start + shell: bash + run: echo "timestamp=$(date +%s)" >> "$GITHUB_OUTPUT" - name: Checkout sources uses: actions/checkout@v4 with: @@ -68,19 +102,26 @@ jobs: - name: Setup Build uses: ./aws-sdk-kotlin/.github/actions/setup-build - # FIXME Re-enable Kotlin/Native builds when artifacts are available - - name: Disable Kotlin/Native builds - shell: bash - run: | - echo -e "\naws.kotlin.native=false" >> ./aws-sdk-kotlin/gradle.properties - echo -e "\naws.kotlin.native=false" >> ./smithy-kotlin/gradle.properties - echo -e "\naws.kotlin.native=false" >> ./aws-crt-kotlin/gradle.properties - + - name: Configure AWS Credentials + uses: aws-actions/configure-aws-credentials@v4 + with: + role-to-assume: ${{ secrets.CI_AWS_ROLE_ARN }} + aws-region: us-west-2 + - name: Setup kat + uses: aws/aws-kotlin-repo-tools/.github/actions/setup-kat@main - name: Configure Gradle - smithy-kotlin - uses: awslabs/aws-kotlin-repo-tools/.github/actions/configure-gradle@main + uses: aws/aws-kotlin-repo-tools/.github/actions/configure-gradle@main with: working-directory: ./smithy-kotlin + - name: Disable native builds # FIXME remove this step once K/N is merged + shell: bash + run: | + echo "Appending aws.kotlin.native=false to smithy-kotlin/gradle.properties..." + echo -e "\n\naws.kotlin.native=false" >> ./smithy-kotlin/gradle.properties + echo "Appending aws.kotlin.native=false to aws-sdk-kotlin/gradle.properties..." + echo -e "\n\naws.kotlin.native=false" >> ./aws-sdk-kotlin/gradle.properties + - name: Build smithy-kotlin working-directory: ./smithy-kotlin shell: bash @@ -91,7 +132,7 @@ jobs: ./gradlew publishToMavenLocal - name: Configure Gradle aws-sdk-kotlin - uses: awslabs/aws-kotlin-repo-tools/.github/actions/configure-gradle@main + uses: aws/aws-kotlin-repo-tools/.github/actions/configure-gradle@main with: working-directory: ./aws-sdk-kotlin @@ -106,6 +147,26 @@ jobs: ./gradlew test jvmTest ./gradlew testAllProtocols + - name: Calculate duration + id: end + if: always() + shell: bash + run: | + now=$(date +%s) + duration=$(( now - ${{ steps.start.outputs.timestamp }} )) + echo "duration=$duration" >> "$GITHUB_OUTPUT" + - name: Emit metrics + if: always() # run this step even if previous steps failed or the job is canceled + uses: aws/aws-kotlin-repo-tools/.github/actions/emit-metrics@main + with: + namespace: CI Metrics + dimensions: | + Product=aws-sdk-kotlin + JobName=${{ github.job }}(${{ matrix.os }}) + Branch=${{ github.base_ref || github.ref_name }} + metrics: | + WorkflowSucceeded:${{ job.status == 'success' && '1' || '0' }}:Count + WorkflowDuration:${{ steps.end.outputs.duration }}:Seconds - name: Save Test Reports if: failure() uses: actions/upload-artifact@v4 diff --git a/.github/workflows/kat-transform.yml b/.github/workflows/kat-transform.yml index 18864ac28e4..4f4b9dae8a9 100644 --- a/.github/workflows/kat-transform.yml +++ b/.github/workflows/kat-transform.yml @@ -39,12 +39,12 @@ jobs: aws-region: us-west-2 - name: Configure Gradle - uses: awslabs/aws-kotlin-repo-tools/.github/actions/configure-gradle@main + uses: aws/aws-kotlin-repo-tools/.github/actions/configure-gradle@main with: working-directory: ./aws-sdk-kotlin - name: Setup kat - uses: awslabs/aws-kotlin-repo-tools/.github/actions/setup-kat@main + uses: aws/aws-kotlin-repo-tools/.github/actions/setup-kat@main - name: Build working-directory: ./aws-sdk-kotlin diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 685a682143d..3071907672e 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -25,7 +25,7 @@ jobs: - name: Checkout sources uses: actions/checkout@v4 - name: Configure Gradle - uses: awslabs/aws-kotlin-repo-tools/.github/actions/configure-gradle@main + uses: aws/aws-kotlin-repo-tools/.github/actions/configure-gradle@main - name: Lint ${{ env.PACKAGE_NAME }} run: | ./gradlew ktlint diff --git a/.github/workflows/merge-main.yml b/.github/workflows/merge-main.yml index 8924b931f74..baadfc1e6e3 100644 --- a/.github/workflows/merge-main.yml +++ b/.github/workflows/merge-main.yml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Merge main - uses: awslabs/aws-kotlin-repo-tools/.github/actions/merge-main@main + uses: aws/aws-kotlin-repo-tools/.github/actions/merge-main@main with: ci-user-pat: ${{ secrets.CI_USER_PAT }} exempt-branches: # Add any if required diff --git a/.github/workflows/minor-version-bump.yml b/.github/workflows/minor-version-bump.yml new file mode 100644 index 00000000000..ef10fe70d9c --- /dev/null +++ b/.github/workflows/minor-version-bump.yml @@ -0,0 +1,11 @@ +name: Minor version bump check +on: + pull_request: + +jobs: + minor-version-bump-check: + permissions: {} + runs-on: ubuntu-latest + steps: + - name: Minor version bump check + uses: awslabs/aws-kotlin-repo-tools/.github/actions/minor-version-bump@main diff --git a/.github/workflows/release-readiness.yml b/.github/workflows/release-readiness.yml index 929dae539c4..f013cd05100 100644 --- a/.github/workflows/release-readiness.yml +++ b/.github/workflows/release-readiness.yml @@ -21,7 +21,7 @@ jobs: path: 'aws-sdk-kotlin' - name: Configure Gradle - uses: awslabs/aws-kotlin-repo-tools/.github/actions/configure-gradle@main + uses: aws/aws-kotlin-repo-tools/.github/actions/configure-gradle@main with: working-directory: ./aws-sdk-kotlin @@ -36,7 +36,7 @@ jobs: ./gradlew -Paws.kotlin.native=false build - name: Checkout smithy-kotlin - uses: awslabs/aws-kotlin-repo-tools/.github/actions/checkout-head@main + uses: aws/aws-kotlin-repo-tools/.github/actions/checkout-head@main with: path: 'smithy-kotlin' repository: 'smithy-lang/smithy-kotlin' diff --git a/.github/workflows/sync-mirror.yml b/.github/workflows/sync-mirror.yml index bc806b75fef..be04ce98af5 100644 --- a/.github/workflows/sync-mirror.yml +++ b/.github/workflows/sync-mirror.yml @@ -10,13 +10,13 @@ permissions: { } jobs: git-sync: # Only sync when pushing to source repo - if: github.repository == 'awslabs/aws-sdk-kotlin' + if: github.repository == 'aws/aws-sdk-kotlin' runs-on: ubuntu-latest steps: - name: git-sync uses: wei/git-sync@v3 with: - source_repo: "https://aws-sdk-kotlin-ci:${{ secrets.CI_USER_PAT }}@github.com/awslabs/aws-sdk-kotlin.git" + source_repo: "https://aws-sdk-kotlin-ci:${{ secrets.CI_USER_PAT }}@github.com/aws/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_repo: "https://aws-sdk-kotlin-ci:${{ secrets.CI_USER_PAT }}@github.com/aws/private-aws-sdk-kotlin-staging.git" destination_branch: "main" diff --git a/.github/workflows/update-release-branch.yml b/.github/workflows/update-release-branch.yml index aaf9cb72a41..4961d49a590 100644 --- a/.github/workflows/update-release-branch.yml +++ b/.github/workflows/update-release-branch.yml @@ -40,7 +40,7 @@ jobs: role-to-assume: ${{ secrets.CI_AWS_ROLE_ARN }} aws-region: us-west-2 - name: Setup kat - uses: awslabs/aws-kotlin-repo-tools/.github/actions/setup-kat@main + uses: aws/aws-kotlin-repo-tools/.github/actions/setup-kat@main - uses: actions/checkout@v4 with: ref: 'main' @@ -58,7 +58,7 @@ jobs: java-version: 17 cache: 'gradle' - name: Configure Gradle - uses: awslabs/aws-kotlin-repo-tools/.github/actions/configure-gradle@main + uses: aws/aws-kotlin-repo-tools/.github/actions/configure-gradle@main - name: Check merge base shell: bash run: | @@ -129,7 +129,7 @@ jobs: echo "duration=$duration" >> "$GITHUB_OUTPUT" - name: Emit metrics if: always() # run this step even if previous steps failed or the job is canceled - uses: awslabs/aws-kotlin-repo-tools/.github/actions/emit-metrics@main + uses: aws/aws-kotlin-repo-tools/.github/actions/emit-metrics@main with: namespace: CI Metrics dimensions: | diff --git a/CHANGELOG.md b/CHANGELOG.md index 58361f40151..dfabb6de272 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,817 @@ # Changelog +## [1.5.52] - 10/01/2025 + +### Features +* (**chimesdkmeetings**) Add support to receive dual stack MediaPlacement URLs in Chime Meetings SDK +* (**cleanrooms**) This release introduces data access budgets to control how many times a table can be used for queries and jobs in a collaboration. +* (**cleanroomsml**) This release introduces data access budgets to view how many times an input channel can be used for ML jobs in a collaboration. +* (**ivsrealtime**) Remove incorrect ReadOnly trait on IVS RealTime ImportPublicKey API +* (**pcs**) Added the UpdateCluster API action to modify cluster configurations, and Slurm custom settings for queues. + +### Documentation +* (**databasemigrationservice**) This is a doc-only update, revising text for kms-key-arns. +* (**ecs**) This is a documentation only Amazon ECS release that adds additional information for health checks. + +## [1.5.51] - 09/30/2025 + +### Features +* (**applicationsignals**) Amazon CloudWatch Application Signals is introducing the Application Map to give users a more comprehensive view of their service health. Users will now be able to group services, track their latest deployments, and view automated audit findings concerning service performance. +* (**bedrockagentcorecontrol**) Tagging support for AgentCore Gateway +* (**chimesdkvoice**) Added support for IPv4-only and dual-stack network configurations for VoiceConnector and CreateVoiceConnector API. +* (**connectcases**) This release adds support for two new related item types: ConnectCase for linking Amazon Connect cases and Custom for user-defined related items with configurable fields. +* (**customerprofiles**) This release introduces ListProfileHistoryRecords and GetProfileHistoryRecord APIs for comprehensive profile history tracking with complete audit trails of creation, updates, merges, deletions, and data ingestion events. +* (**datasync**) Added support for FIPS VPC endpoints in FIPS-enabled AWS Regions. +* (**datazone**) This release adds support for creation of EMR on EKS Connections in Amazon DataZone. +* (**directoryservice**) AWS Directory service now supports IPv6-native and dual-stack configurations for AWS Managed Microsoft AD, AD Connector, and Simple AD (dual-stack only). Additionally, AWS Managed Microsoft AD Standard Edition directories can be upgraded to Enterprise Edition directories through a single API call. +* (**ecs**) This release adds support for Managed Instances on Amazon ECS. +* (**fsx**) Add Dual-Stack support for Amazon FSx for NetApp ONTAP and Windows File Server +* (**mediatailor**) Adding TPS Traffic Shaping to Prefetch Schedules +* (**rds**) Enhanced RDS error handling: Added DBProxyEndpointNotFoundFault, DBShardGroupNotFoundFault, KMSKeyNotAccessibleFault for snapshots/restores/backups, NetworkTypeNotSupported, StorageTypeNotSupportedFault for restores, and granular state validation faults. Changed DBInstanceNotReadyFault to HTTP 400. +* (**transfer**) Add support for updating server identity provider type + +### Documentation +* (**quicksight**) added warnings to a few CLI pages + +## [1.5.50] - 09/29/2025 + +### Features +* (**bedrock**) Release for fixing GetFoundationModel API behavior. Imported and custom models have their own exclusive API and GetFM should not accept those ARNS as input +* (**bedrockruntime**) New stop reason for Converse and ConverseStream +* (**imagebuilder**) This release introduces several new features and improvements to enhance pipeline management, logging, and resource configuration. +* (**vpclattice**) Adds support for specifying the number of IPv4 addresses in each ENI for the resource gateway for VPC Lattice. + +## [1.5.49] - 09/26/2025 + +## [1.5.48] - 09/26/2025 + +### Features +* (**bedrockagentruntime**) This release enhances the information provided through Flow Traces. New information includes source/next node tracking, execution chains for complex nodes, dependency action (operation) details, and dependency traces. +* (**bedrockdataautomation**) Added support for configurable Speaker Labeling and Channel Labeling features for Audio modality. +* (**billing**) Add ability to combine custom billing views to create new consolidated views. +* (**connect**) Adds supports for manual contact picking (WorkList) operations on Routing Profiles, Agent Management and SearchContacts APIs. +* (**costexplorer**) Support for payer account dimension and billing view health status. +* (**dynamodbstreams**) Added support for IPv6 compatible endpoints for DynamoDB Streams. +* (**redshift**) Support tagging and tag propagation to IAM Identity Center for Redshift Idc Applications + +### Documentation +* (**ec2**) This release includes documentation updates for Amazon EBS General Purpose SSD (gp3) volumes with larger size and higher IOPS and throughput. + +## [1.5.47] - 09/25/2025 + +### Features +* (**glue**) Update GetConnection(s) API to return KmsKeyArn & Add 63 missing connection types +* (**lightsail**) Attribute HTTP binding update for Get/Delete operations +* (**networkfirewall**) Network Firewall now introduces Reject and Alert action support for stateful domain list rule groups, providing customers with more granular control over their network traffic. + +## [1.5.46] - 09/24/2025 + +### Features +* (**cloudwatch**) Fix default dualstack FIPS endpoints in AWS GovCloud(US) regions +* (**dax**) This release adds support for IPv6-only, DUAL_STACK DAX instances + +### Documentation +* (**appstream**) G6f instance support for AppStream 2.0 +* (**kms**) Documentation only updates for KMS. +* (**neptune**) Doc-only update to address customer use. + +## [1.5.45] - 09/23/2025 + +### Features +* (**cleanrooms**) Added support for running incremental ID mapping for rule-based workflows. +* (**ec2**) Add Amazon EC2 R8gn instance types +* (**entityresolution**) Support incremental id mapping workflow for AWS Entity Resolution +* (**ssm**) Added Dualstack support to GetDeployablePatchSnapshotForInstance +* (**ssoadmin**) Add support for encryption at rest with Customer Managed KMS Key in AWS IAM Identity Center +* (**ssooidc**) This release includes exception definition and documentation updates. + +### Miscellaneous +* Upgrade to Gradle 9.0.0 + +## [1.5.44] - 09/22/2025 + +### Features +* (**eks**) Adds support for RepairConfig overrides and configurations in EKS Managed Node Groups. +* (**imagebuilder**) Version ARNs are no longer required for the EC2 Image Builder list-image-build-version, list-component-build-version, and list-workflow-build-version APIs. Calling these APIs without the ARN returns all build versions for the given resource type in the requesting account. + +### Documentation +* (**batch**) Starting in JAN 2026, AWS Batch will change the default AMI for new Amazon ECS compute environments from Amazon Linux 2 to Amazon Linux 2023. We recommend migrating AWS Batch Amazon ECS compute environments to Amazon Linux 2023 to maintain optimal performance and security. + +## [1.5.43] - 09/19/2025 + +### Features +* (**bedrockagentcorecontrol**) Add tagging and VPC support to AgentCore Runtime, Code Interpreter, and Browser resources. Add support for configuring request headers in Runtime. Fix AgentCore Runtime shape names. +* (**configservice**) Add UNKNOWN state to RemediationExecutionState and add IN_PROGRESS/EXITED/UNKNOWN states to RemediationExecutionStepState. +* (**connect**) This release adds a persistent connection field to UserPhoneConfig that maintains agent's softphone media connection for faster call connections. +* (**licensemanagerusersubscriptions**) Added support for cross-account Active Directories. +* (**medialive**) Add MinBitrate for QVBR mode under H264/H265/AV1 output codec. Add GopBReference, GopNumBFrames, SubGopLength fields under H265 output codec. + +### Documentation +* (**kendraranking**) Model whitespace change - no client difference +* (**sqs**) Update invalid character handling documentation for SQS SendMessage API + +## [1.5.42] - 09/18/2025 + +### Features +* (**bedrock**) Release includes an increase to the maximum policy build document size, an update to DeleteAutomatedReasoningPolicyBuildWorkflow to add ResourceInUseException, and corrections to UpdateAutomatedReasoningPolicyTestCaseRequest. +* (**budgets**) Added BillingViewHealthStatus Exception which is thrown when a Budget is created or updated with a Billing View that is not in the HEALTHY status +* (**chimesdkmessaging**) Amazon Chime SDK Messaging GetMessagingSessionEndpoint API now returns dual-stack WebSocket endpoints supporting IPv4/IPv6. +* (**ec2**) Allowed AMIs adds support for four new parameters - marketplaceProductCodes, deprecationTimeCondition, creationDateCondition and imageNames + +## [1.5.41] - 09/17/2025 + +### Features +* (**ec2**) Add mac-m4.metal and mac-m4pro.metal instance types. +* (**networkfirewall**) Network Firewall now prevents TLS handshakes with the target server until after the Server Name Indication (SNI) has been seen and verified. The monitoring dashboard now provides deeper insights into PrivateLink endpoint candidates and offers filters based on IP addresses and protocol. +* (**pcs**) Add support for Amazon EC2 Capacity Blocks for ML + +## [1.5.40] - 09/16/2025 + +### Features +* (**budgets**) Add support for custom time periods in budget configuration +* (**cloudwatchlogs**) Cloudwatch Logs added support for 2 new API parameters in metric and subscription filter APIs to filter log events based on system field values and emit system field values as dimensions and send them to customer destination as additional metadata. +* (**ivsrealtime**) IVS now offers customers the ability to control the positioning of participants in both grid and PiP layouts based on custom attribute values in participant tokens. +* (**osis**) Adds support for cross-account ingestion for push-based sources. This includes resource policies for sharing pipelines across accounts and features for managing pipeline endpoints which enable accessing pipelines across different VPCs, including VPCs in other accounts. + +## [1.5.39] - 09/15/2025 + +### Features +* (**costexplorer**) Added endpoint support for eusc-de-east-1 region. +* (**medicalimaging**) Added support for OpenID Connect (OIDC) custom authorizer +* (**observabilityadmin**) CloudWatch Observability Admin adds the ability to enable telemetry centralization in customers' Organizations. The release introduces new APIs to manage centralization rules, which define settings to replicate telemetry data to a central destination in the customers' Organization. +* (**s3control**) Introduce three new encryption filters: EncryptionType (SSE-S3, SSE-KMS, DSSE-KMS, SSE-C, NOT-SSE), KmsKeyArn (for SSE-KMS and DSSE-KMS), and BucketKeyEnabled (for SSE-KMS). + +## [1.5.38] - 09/12/2025 + +### Features +* (**paymentcryptography**) Add support for certificates to be signed by 3rd party certificate authorities. New API GetCertificateSigningRequest API and support for providing certificates at run-time for tr-34 import/export + +### Documentation +* Improve documentation for [`AwsRetryPolicy`](https://docs.aws.amazon.com/sdk-for-kotlin/api/latest/aws-http/aws.sdk.kotlin.runtime.http.retries/-aws-retry-policy/) + +## [1.5.37] - 09/11/2025 + +### Features +* (**amp**) Add Vended Logs APIs for Amazon Prometheus Managed Collector +* (**datazone**) adding IAM principal id to IAM user profile details +* (**ecs**) This release supports hook details for Amazon ECS lifecycle hooks. +* (**emrcontainers**) Added nodeLabel support in container provider to aid hardware isolation support for virtual cluster and security configuration. +* (**evs**) CreateEnvironment API now supports parameters (isHcxPublic & hcxNetworkAclId) for HCX migration via public internet, adding flexibility for migration scenarios. New APIs have been added for associating (AssociateEipToVlan) & disassociating (DisassociateEipFromVlan) Elastic IP (EIP) addresses. +* (**guardduty**) Updated Java SDK implementation of entity set status in GuardDuty API. +* (**medialive**) AWS Elemental MediaLive adds a new feature in MediaPackage output group that enables MediaPackage V2 users to control HLS-related parameters directly in MediaLive. These parameter settings are then reflected in MediaPackage outputs, providing more streamlined control over HLS configurations. +* (**quicksight**) This release adds support for Account level custom permissions, additional Dashboard Options, and Null support for Q&A. +* (**rds**) Adds support for end-to-end IAM authentication in RDS Proxy for MySQL, MariaDB, and PostgreSQL engines. + +## [1.5.36] - 09/10/2025 + +### Features +* (**networkflowmonitor**) Added new enum value (AWS::Region) for type field under MonitorLocalResource and MonitorRemoteResource. Workload Insights and Monitor top contributors queries now support a new DestinationCategory (INTER_REGION). +* (**paymentcryptography**) AWS Payment Cryptography Service now supports Multi-Region key replication. Customers can choose to automatically distribute keys across AWS Regions. + +## [1.5.34] - 09/08/2025 + +### Features +* (**iotsitewise**) Add ComputationModelVersion support in IoT SiteWise APIs +* (**s3**) This release includes backward compatibility work on the "Expires" parameter. +* (**securityhub**) This release adds the RESOURCE_NOT_FOUND error code as a possible value in responses to the following operations: BatchGetStandardsControlAssociations, BatchUpdateStandardsControlAssociations, and BatchGetSecurityControls. + +## [1.5.33] - 09/05/2025 + +### Features +* (**sagemaker**) Release IPv6 support with dualstack in SageMaker Notebooks, Tiered Storage Checkpointing Support in SageMaker HyperPod and P5.4xlarge instance type for SageMaker Hosting. + +### Documentation +* (**ecs**) This is a documentation only release that adds additional information for Amazon ECS Availability Zone rebalancing. +* (**pcs**) Documentation-only update to add AccountingStorageEnforce to SlurmCustomSetting. + +## [1.5.32] - 09/04/2025 + +### Features +* (**cleanrooms**) Add support for configurable compute sizes for PySpark jobs. +* (**cloudformation**) ListHookResults API now supports retrieving invocation results for all CloudFormation Hooks (previously limited to create change set and Cloud Control operations) with new optional parameters for filtering by Hook status and ARN. +* (**ec2**) Add m8i, m8i-flex and i8ge instance types. +* (**opensearchserverless**) Add support for Federal Information Processing Standards (FIPS) and Federal Risk and Authorization Management Program (FedRAMP) compliance +* (**rds**) Added new EndpointNetworkType and TargetConnectionNetworkType fields in Proxy APIs to support IPv6 +* (**verifiedpermissions**) Amazon Verified Permissions / Features : Adds support for datetime and duration attribute values. + +## [1.5.31] - 09/03/2025 + +### Features +* (**cleanrooms**) Added support for adding new data provider members to an existing collaboration. +* (**cleanroomsml**) AWS Clean Rooms ML adds log sanitization for privacy-enhanced error summaries, supports new instance types for custom models providing better performance and lower costs, and deprecates P3-series instances. +* (**cloudfront**) Adding an optional field IpAddressType in CustomOriginConfig +* (**mq**) Add CONFIG_MANAGED as a supported AuthenticationStrategy for Amazon MQ for RabbitMQ brokers. Make username and password optional on broker creation for CONFIG_MANAGED brokers. +* (**rds**) This release adds support for MasterUserAuthenticationType parameter on CreateDBInstance, ModifyDBInstance, CreateDBCluster, and ModifyDBCluster operations. +* (**route53**) Amazon Route 53 now supports the Asia Pacific (New Zealand) Region (ap-southeast-6) for latency records, geoproximity records, and private DNS for Amazon VPCs in that region. +* (**route53domains**) Added new ExtraParams AU_ELIGIBILITY_TYPE, AU_POLICY_REASON, and AU_REGISTRANT_NAME +* (**transcribestreaming**) This release adds support for automatic language identification in AWS Transcribe Call Analytics + +## [1.5.30] - 09/02/2025 + +### Features +* (**ec2**) MaximumEbsAttachments and AttachmentLimitType fields added to DescribeInstanceTypesResponse. G6f, Gr6f, R8i, R8i-flex and p5.4xlarge instance types added to InstanceTypes enum. +* (**neptune**) Removed the deprecated marker from publiclyAccessible parameter from DbInstance, CreateDbInstance and ModifyDbInstance and added relevant usage information for the parameter. +* (**notifications**) Added Org support for notifications: - `ListMemberAccounts` gets member accounts list, `AssociateOrganizationalUnit` links OU to notification configuration, `DisassociateOrganizationalUnit` removes OU from notification configuration, `ListOrganizationalUnits` shows OUs configured for notifications. +* (**workmail**) Make RoleArn an optional parameter for the PutEmailMonitoringConfiguration API, and add UnsupportedOperationException to RegisterToWorkMail. + +### Miscellaneous +* Remove SMS service + +## [1.5.29] - 08/29/2025 + +### Features +* (**bedrockruntime**) Fixed stop sequence limit for converse API. +* (**ec2**) Release shows new route types such as filtered and advertisement. +* (**xray**) AWS X-Ray Features: Support Sampling Rate Boost On Anomaly + +## [1.5.28] - 08/28/2025 + +### Features +* (**amplify**) Remove incorrect endpoint tests +* (**applicationautoscaling**) Remove incorrect endpoint tests +* (**applicationcostprofiler**) Remove incorrect endpoint tests +* (**autoscalingplans**) Remove incorrect endpoint tests +* (**bedrockruntime**) Remove incorrect endpoint tests +* (**cloud9**) Remove incorrect endpoint tests +* (**cloudhsmv2**) Remove incorrect endpoint tests +* (**cloudsearchdomain**) Remove incorrect endpoint tests +* (**codedeploy**) Remove incorrect endpoint tests +* (**codegurureviewer**) Remove incorrect endpoint tests +* (**connect**) AgentStatusDrillDown feature in GetCurrentMetricData API. Adding AGENT_STATUS as filter and grouping in GetCurrentMetricData API +* (**connectcampaigns**) Remove incorrect endpoint tests +* (**databrew**) Remove incorrect endpoint tests +* (**dynamodb**) Remove incorrect endpoint tests +* (**ec2**) This release adds support for copying Amazon EBS snapshot and AMIs to and from Local Zones. +* (**ec2instanceconnect**) Remove incorrect endpoint tests +* (**ecr**) Remove incorrect endpoint tests +* (**emr**) Remove incorrect endpoint tests +* (**entityresolution**) Remove incorrect endpoint tests +* (**eventbridge**) Remove incorrect endpoint tests +* (**fis**) Remove incorrect endpoint tests +* (**fms**) Remove incorrect endpoint tests +* (**geomaps**) Remove incorrect endpoint tests +* (**geoplaces**) Remove incorrect endpoint tests +* (**glue**) Adding support to fetch TargetDatabase field during GetDatabases with AttributesToGet +* (**healthlake**) Add ValidationLevel parameter to StartFHIRImportJob API, allowing users to specify a FHIR validation level for their asynchronous import jobs. +* (**inspectorscan**) Remove incorrect endpoint tests +* (**internetmonitor**) Remove incorrect endpoint tests +* (**kinesis**) Remove incorrect endpoint tests +* (**licensemanagerusersubscriptions**) Remove incorrect endpoint tests +* (**machinelearning**) Remove incorrect endpoint tests +* (**managedblockchainquery**) Remove incorrect endpoint tests +* (**marketplacedeployment**) Remove incorrect endpoint tests +* (**mediastoredata**) Remove incorrect endpoint tests +* (**mturk**) Remove incorrect endpoint tests +* (**networkfirewall**) Remove incorrect endpoint tests +* (**oam**) Remove incorrect endpoint tests +* (**omics**) Adds Amazon ECR pull through cache support to AWS HealthOmics, so you can more easily use container images from external sources. +* (**opensearch**) Remove incorrect endpoint tests +* (**osis**) Remove incorrect endpoint tests +* (**pcs**) Remove incorrect endpoint tests +* (**pinpointsmsvoice**) Remove incorrect endpoint tests +* (**pinpointsmsvoicev2**) Remove incorrect endpoint tests +* (**pipes**) Remove incorrect endpoint tests +* (**quicksight**) Remove incorrect endpoint tests +* (**rds**) Added RDS HTTP Endpoint feature support flag to DescribeOrderableDBInstanceOptions API +* (**rekognition**) Remove incorrect endpoint tests +* (**route53domains**) Remove incorrect endpoint tests +* (**savingsplans**) Remove incorrect endpoint tests +* (**scheduler**) Remove incorrect endpoint tests +* (**servicequotas**) Remove incorrect endpoint tests +* (**ses**) Remove incorrect endpoint tests +* (**sesv2**) Remove incorrect endpoint tests +* (**ssmguiconnect**) Remove incorrect endpoint tests +* (**ssmincidents**) Remove incorrect endpoint tests +* (**ssmsap**) Added support for Configuration Checks on SAP HANA Applications. +* (**sso**) Remove incorrect endpoint tests +* (**swf**) Remove incorrect endpoint tests +* (**timestreamquery**) Remove incorrect endpoint tests +* (**waf**) Remove incorrect endpoint tests +* (**workmailmessageflow**) Remove incorrect endpoint tests +* (**xray**) Remove incorrect endpoint tests + +### Documentation +* (**apprunner**) Doc only updates for APIs and and datatypes related to IPAddressType and Subnets for IPv6 dualstack support. + +## [1.5.27] - 08/27/2025 + +### Features +* (**acmpca**) Remove incorrect endpoint tests +* (**amplifybackend**) Remove incorrect endpoint tests +* (**amplifyuibuilder**) Remove incorrect endpoint tests +* (**appconfigdata**) Remove incorrect endpoint tests +* (**applicationdiscoveryservice**) Remove incorrect endpoint tests +* (**applicationinsights**) Remove incorrect endpoint tests +* (**apptest**) Remove incorrect endpoint tests +* (**bedrockagentcore**) Remove incorrect endpoint tests +* (**chime**) Remove incorrect endpoint tests +* (**chimesdkidentity**) Remove incorrect endpoint tests +* (**chimesdkmeetings**) Remove incorrect endpoint tests +* (**chimesdkvoice**) Remove incorrect endpoint tests +* (**cleanroomsml**) Remove incorrect endpoint tests +* (**codebuild**) Remove incorrect endpoint tests +* (**codeconnections**) Remove incorrect endpoint tests +* (**codeguruprofiler**) Remove incorrect endpoint tests +* (**computeoptimizer**) Remove incorrect endpoint tests +* (**datapipeline**) Remove incorrect endpoint tests +* (**directoryservice**) Add APIs for CA AutoEnrollment support: DescribeCAEnrollmentPolicy, EnableCAEnrollmentPolicy and DisableCAEnrollmentPolicy. +* (**eks**) Add support for on-demand refresh of EKS cluster insights +* (**elasticache**) Remove incorrect endpoint tests +* (**evidently**) Remove incorrect endpoint tests +* (**frauddetector**) Remove incorrect endpoint tests +* (**inspector**) Remove incorrect endpoint tests +* (**iot**) Remove incorrect endpoint tests +* (**iotfleetwise**) Remove incorrect endpoint tests +* (**iotwireless**) Remove incorrect endpoint tests +* (**ivschat**) Remove incorrect endpoint tests +* (**ivsrealtime**) Remove incorrect endpoint tests +* (**kafkaconnect**) Remove incorrect endpoint tests +* (**kinesisvideo**) Remove incorrect endpoint tests +* (**kinesisvideomedia**) Remove incorrect endpoint tests +* (**kms**) Remove incorrect endpoint tests +* (**lakeformation**) Remove incorrect endpoint tests +* (**lexmodelbuildingservice**) Remove incorrect endpoint tests +* (**marketplacereporting**) Remove incorrect endpoint tests +* (**medicalimaging**) Remove incorrect endpoint tests +* (**mgn**) Remove incorrect endpoint tests +* (**migrationhubconfig**) Remove incorrect endpoint tests +* (**neptune**) Remove incorrect endpoint tests +* (**neptunegraph**) Add StartGraph and StopGraph operations to Neptune Analytics +* (**omics**) Remove incorrect endpoint tests +* (**paymentcryptographydata**) Remove incorrect endpoint tests +* (**personalize**) Remove incorrect endpoint tests +* (**pi**) Remove incorrect endpoint tests +* (**qapps**) Remove incorrect endpoint tests +* (**qldbsession**) Remove incorrect endpoint tests +* (**redshift**) Remove incorrect endpoint tests +* (**robomaker**) Remove incorrect endpoint tests +* (**s3tables**) Remove incorrect endpoint tests +* (**sagemaker**) This release adds support for AutoScaling on SageMaker HyperPod. +* (**schemas**) Remove incorrect endpoint tests +* (**snowdevicemanagement**) Remove incorrect endpoint tests +* (**sns**) Remove incorrect endpoint tests +* (**supplychain**) Remove incorrect endpoint tests +* (**textract**) Remove incorrect endpoint tests +* (**timestreamwrite**) Remove incorrect endpoint tests +* (**voiceid**) Remove incorrect endpoint tests +* (**vpclattice**) Remove incorrect endpoint tests +* (**workdocs**) Remove incorrect endpoint tests +* (**workmail**) Remove incorrect endpoint tests + +### Documentation +* (**batch**) Added ECS_AL2023_NVIDIA as an option for Ec2Configuration.imageType. + +## [1.5.26] - 08/26/2025 + +### Features +* (**appconfig**) Remove incorrect endpoint tests +* (**appmesh**) Remove incorrect endpoint tests +* (**apprunner**) Remove incorrect endpoint tests +* (**arczonalshift**) This release adds new API options to enable allowed windows and multiple alarms for practice runs. +* (**bedrockagentcorecontrol**) Remove incorrect endpoint tests +* (**cleanrooms**) Remove incorrect endpoint tests +* (**cloudwatch**) Remove incorrect endpoint tests +* (**codecommit**) Remove incorrect endpoint tests +* (**codestarconnections**) Remove incorrect endpoint tests +* (**comprehendmedical**) Remove incorrect endpoint tests +* (**connectcontactlens**) Remove incorrect endpoint tests +* (**connectparticipant**) Amazon Connect Participant Service: Remove unused fields from WebRTCConnection +* (**controlcatalog**) Remove incorrect endpoint tests +* (**datasync**) Remove incorrect endpoint tests +* (**dlm**) Remove incorrect endpoint tests +* (**drs**) Remove incorrect endpoint tests +* (**ec2**) Add new APIs for viewing how your shared AMIs are used by other accounts, and identify resources in your account that are dependent on particular AMIs +* (**elastictranscoder**) Remove incorrect endpoint tests +* (**evs**) Remove incorrect endpoint tests +* (**finspace**) Remove incorrect endpoint tests +* (**gamelift**) Remove incorrect endpoint tests +* (**georoutes**) Added RouteFerryNotice PotentialViolatedVehicleRestrictionUsage value for CalculateRoutes. This value indicates when the Route is potentially forbidden for the given vehicle profile. +* (**glacier**) Remove incorrect endpoint tests +* (**globalaccelerator**) Remove incorrect endpoint tests +* (**greengrass**) Remove incorrect endpoint tests +* (**identitystore**) Remove incorrect endpoint tests +* (**imagebuilder**) Remove incorrect endpoint tests +* (**iotjobsdataplane**) Remove incorrect endpoint tests +* (**iotsecuretunneling**) Remove incorrect endpoint tests +* (**iottwinmaker**) Remove incorrect endpoint tests +* (**kafka**) Remove incorrect endpoint tests +* (**licensemanagerlinuxsubscriptions**) Remove incorrect endpoint tests +* (**lookoutvision**) Remove incorrect endpoint tests +* (**m2**) Remove incorrect endpoint tests +* (**migrationhub**) Remove incorrect endpoint tests +* (**migrationhubrefactorspaces**) Remove incorrect endpoint tests +* (**mq**) Remove incorrect endpoint tests +* (**neptunedata**) Remove incorrect endpoint tests +* (**pcaconnectorscep**) Remove incorrect endpoint tests +* (**personalizeevents**) Remove incorrect endpoint tests +* (**pinpoint**) Remove incorrect endpoint tests +* (**polly**) Remove incorrect endpoint tests +* (**ram**) Remove incorrect endpoint tests +* (**rbin**) Remove incorrect endpoint tests +* (**rdsdata**) Remove incorrect endpoint tests +* (**resourceexplorer2**) Remove incorrect endpoint tests +* (**route53**) Remove incorrect endpoint tests +* (**route53recoverycluster**) Remove incorrect endpoint tests +* (**sagemakergeospatial**) Remove incorrect endpoint tests +* (**secretsmanager**) Remove incorrect endpoint tests +* (**securityhub**) Remove incorrect endpoint tests +* (**servicecatalogappregistry**) Remove incorrect endpoint tests +* (**signer**) Remove incorrect endpoint tests +* (**socialmessaging**) Remove incorrect endpoint tests +* (**ssm**) Remove incorrect endpoint tests +* (**ssmsap**) Remove incorrect endpoint tests +* (**ssooidc**) Remove incorrect endpoint tests +* (**tnb**) Remove incorrect endpoint tests +* (**transfer**) Remove incorrect endpoint tests +* (**trustedadvisor**) Remove incorrect endpoint tests +* (**wafregional**) Remove incorrect endpoint tests +* (**workspaces**) Remove incorrect endpoint tests + +### Fixes +* Stop erroneously using `ProfileCredentialsProvider.profileName` to initialize IMDS instance profile + +### Miscellaneous +* Remove OpsWorks and OpsWorks-CM service clients from SDK because the [service has reached End Of Life](https://docs.aws.amazon.com/opsworks/latest/userguide/stacks-eol-faqs.html) + +## [1.5.25] - 08/25/2025 + +### Features +* (**acm**) Remove incorrect endpoint tests +* (**aiops**) Remove incorrect endpoint tests +* (**appflow**) Remove incorrect endpoint tests +* (**appsync**) Remove incorrect endpoint tests +* (**athena**) Remove incorrect endpoint tests +* (**autoscaling**) Remove incorrect endpoint tests +* (**b2bi**) Updated APIs to support custom validation rules. +* (**bedrock**) Remove incorrect endpoint tests +* (**bedrockagent**) Remove incorrect endpoint tests +* (**bedrockdataautomation**) Remove incorrect endpoint tests +* (**bedrockdataautomationruntime**) Remove incorrect endpoint tests +* (**braket**) Remove incorrect endpoint tests +* (**chatbot**) Remove incorrect endpoint tests +* (**chimesdkmediapipelines**) Remove incorrect endpoint tests +* (**chimesdkmessaging**) Remove incorrect endpoint tests +* (**cloudcontrol**) Remove incorrect endpoint tests +* (**cloudformation**) Remove incorrect endpoint tests +* (**cloudsearch**) Remove incorrect endpoint tests +* (**cloudtraildata**) Remove incorrect endpoint tests +* (**cloudwatchevents**) Remove incorrect endpoint tests +* (**cloudwatchlogs**) Remove incorrect endpoint tests +* (**codeartifact**) Remove incorrect endpoint tests +* (**codestarnotifications**) Remove incorrect endpoint tests +* (**connectparticipant**) Remove incorrect endpoint tests +* (**controltower**) Remove incorrect endpoint tests +* (**costandusagereportservice**) Remove incorrect endpoint tests +* (**datazone**) Releasing the following features - Asset classification that lets users use restricted terms for classifying assets if they have the right permissions. Also adding a new enum value "Moving" to project status. +* (**dax**) Remove incorrect endpoint tests +* (**devicefarm**) Remove incorrect endpoint tests +* (**devopsguru**) Remove incorrect endpoint tests +* (**directconnect**) Remove incorrect endpoint tests +* (**docdbelastic**) Remove incorrect endpoint tests +* (**ec2**) Added IPv6 support for AWS Client VPN. +* (**eks**) Remove incorrect endpoint tests +* (**emrcontainers**) Remove incorrect endpoint tests +* (**finspacedata**) Remove incorrect endpoint tests +* (**forecast**) Remove incorrect endpoint tests +* (**fsx**) Remove incorrect endpoint tests +* (**groundstation**) Remove incorrect endpoint tests +* (**health**) Remove incorrect endpoint tests +* (**iotdataplane**) Remove incorrect endpoint tests +* (**iotfleethub**) Remove incorrect endpoint tests +* (**iotsitewise**) Remove incorrect endpoint tests +* (**kendra**) Remove incorrect endpoint tests +* (**keyspaces**) Remove incorrect endpoint tests +* (**kinesisanalytics**) Remove incorrect endpoint tests +* (**kinesisvideoarchivedmedia**) Remove incorrect endpoint tests +* (**lambda**) Remove incorrect endpoint tests +* (**lexmodelsv2**) Remove incorrect endpoint tests +* (**lexruntimeservice**) Remove incorrect endpoint tests +* (**licensemanager**) Remove incorrect endpoint tests +* (**lookoutequipment**) Remove incorrect endpoint tests +* (**mailmanager**) Remove incorrect endpoint tests +* (**marketplacecatalog**) Remove incorrect endpoint tests +* (**mediaconvert**) This release adds support for input rendition selection for HLS input, adds new Share API to enable sharing jobs with AWS Support for support investigations, and adds INCLUDE_AS_TS to iFrameOnlyManifest setting for HLS outputs. +* (**mediapackagevod**) Remove incorrect endpoint tests +* (**mediastore**) Remove incorrect endpoint tests +* (**migrationhubstrategy**) Remove incorrect endpoint tests +* (**odb**) Remove incorrect endpoint tests +* (**opensearchserverless**) Remove incorrect endpoint tests +* (**opsworkscm**) Remove incorrect endpoint tests +* (**outposts**) Remove incorrect endpoint tests +* (**pcaconnectorad**) Remove incorrect endpoint tests +* (**personalizeruntime**) Remove incorrect endpoint tests +* (**qbusiness**) The Amazon Q Business GetDocumentContent operation now supports retrieval of the extracted text content in JSON format. +* (**redshiftserverless**) Remove incorrect endpoint tests +* (**repostspace**) Remove incorrect endpoint tests +* (**resiliencehub**) Remove incorrect endpoint tests +* (**resourcegroupstaggingapi**) Remove incorrect endpoint tests +* (**sagemakeredge**) Remove incorrect endpoint tests +* (**sagemakerfeaturestoreruntime**) Remove incorrect endpoint tests +* (**sagemakerruntime**) Remove incorrect endpoint tests +* (**serverlessapplicationrepository**) Remove incorrect endpoint tests +* (**servicecatalog**) Remove incorrect endpoint tests +* (**sfn**) Remove incorrect endpoint tests +* (**shield**) Remove incorrect endpoint tests +* (**snowball**) Remove incorrect endpoint tests +* (**ssoadmin**) Remove incorrect endpoint tests +* (**storagegateway**) Remove incorrect endpoint tests +* (**support**) Remove incorrect endpoint tests +* (**supportapp**) Remove incorrect endpoint tests +* (**taxsettings**) Remove incorrect endpoint tests +* (**timestreaminfluxdb**) Add MAINTENANCE status for DbInstance and DbCluster +* (**transcribe**) Remove incorrect endpoint tests +* (**transcribestreaming**) Remove incorrect endpoint tests +* (**translate**) Remove incorrect endpoint tests +* (**wellarchitected**) Remove incorrect endpoint tests +* (**workspacesthinclient**) Remove incorrect endpoint tests + +### Documentation +* (**codegurusecurity**) Documentation update to notify users of the discontinuation of Amazon CodeGuru Security. +* (**sqs**) Documentation update for Amazon SQS Supports Large Payload Message feature + +## [1.5.24] - 08/22/2025 + +### Features +* (**account**) Remove incorrect endpoint tests +* (**apigateway**) Remove incorrect endpoint tests +* (**apigatewayv2**) Remove incorrect endpoint tests +* (**b2bi**) Remove incorrect endpoint tests +* (**clouddirectory**) Remove incorrect endpoint tests +* (**codepipeline**) Remove incorrect endpoint tests +* (**cognitosync**) Remove incorrect endpoint tests +* (**dataexchange**) Remove incorrect endpoint tests +* (**docdb**) Remove incorrect endpoint tests +* (**elasticloadbalancing**) Remove incorrect endpoint tests +* (**emrserverless**) Remove incorrect endpoint tests +* (**firehose**) Remove incorrect endpoint tests +* (**healthlake**) Remove incorrect endpoint tests +* (**iotanalytics**) Remove incorrect endpoint tests +* (**launchwizard**) Remove incorrect endpoint tests +* (**location**) Remove incorrect endpoint tests +* (**macie2**) Remove incorrect endpoint tests +* (**marketplacecommerceanalytics**) Remove incorrect endpoint tests +* (**medialive**) AWS Elemental MediaLive now has a field called "SubtitleRows" for controlling subtitle row count for DVB-Sub and Burn-In captions outputs +* (**memorydb**) Remove incorrect endpoint tests +* (**migrationhuborchestrator**) Remove incorrect endpoint tests +* (**networkmonitor**) Remove incorrect endpoint tests +* (**organizations**) Remove incorrect endpoint tests +* (**paymentcryptography**) Remove incorrect endpoint tests +* (**pricing**) Remove incorrect endpoint tests +* (**proton**) Remove incorrect endpoint tests +* (**qconnect**) Releasing model ID support for UpdateAIPrompt +* (**qldb**) Remove incorrect endpoint tests +* (**redshiftdata**) Remove incorrect endpoint tests +* (**rolesanywhere**) Remove incorrect endpoint tests +* (**route53recoveryreadiness**) Remove incorrect endpoint tests +* (**rum**) Remove incorrect endpoint tests +* (**sagemaker**) Launch SageMaker Notebook Instances support for AL2023 along with P6-B200 instance type and Rootless Docker support for SageMaker Studio. +* (**sagemakera2iruntime**) Remove incorrect endpoint tests +* (**sagemakermetrics**) Remove incorrect endpoint tests +* (**simspaceweaver**) Remove incorrect endpoint tests +* (**sqs**) Remove incorrect endpoint tests +* (**synthetics**) Added multi browser support for synthetics canaries, Increased ephemeral storage limit from 5GB to 10GB +* (**wafv2**) test and verified, safe to release + +### Documentation +* (**rds**) Updates Amazon RDS documentation for Db2 read-only replicas. +* (**servicediscovery**) Updating SDK examples after launch of shared AWS Cloud Map namespaces + +## [1.5.23] - 08/21/2025 + +### Features +* (**accessanalyzer**) Remove incorrect endpoint tests +* (**amp**) Remove incorrect endpoint tests +* (**apigatewaymanagementapi**) Remove incorrect endpoint tests +* (**appfabric**) Remove incorrect endpoint tests +* (**appintegrations**) Remove incorrect endpoint tests +* (**appstream**) Remove incorrect endpoint tests +* (**artifact**) Remove incorrect endpoint tests +* (**auditmanager**) Remove incorrect endpoint tests +* (**backup**) Remove incorrect endpoint tests +* (**backupgateway**) Remove incorrect endpoint tests +* (**bedrockagentruntime**) Remove incorrect endpoint tests +* (**billingconductor**) Remove incorrect endpoint tests +* (**cloudfront**) Remove incorrect endpoint tests +* (**cloudhsm**) Remove incorrect endpoint tests +* (**cloudtrail**) Remove incorrect endpoint tests +* (**cognitoidentity**) Remove incorrect endpoint tests +* (**comprehend**) Remove incorrect endpoint tests +* (**configservice**) Remove incorrect endpoint tests +* (**connect**) Remove incorrect endpoint tests +* (**connectcampaignsv2**) Remove incorrect endpoint tests +* (**connectcases**) Remove incorrect endpoint tests +* (**costoptimizationhub**) Remove incorrect endpoint tests +* (**customerprofiles**) Remove incorrect endpoint tests +* (**databasemigrationservice**) Remove incorrect endpoint tests +* (**deadline**) Remove incorrect endpoint tests +* (**directoryservice**) Remove incorrect endpoint tests +* (**directoryservicedata**) Remove incorrect endpoint tests +* (**dynamodbstreams**) Remove incorrect endpoint tests +* (**ebs**) Remove incorrect endpoint tests +* (**ecrpublic**) Remove incorrect endpoint tests +* (**elasticbeanstalk**) Remove incorrect endpoint tests +* (**elasticloadbalancingv2**) Remove incorrect endpoint tests +* (**elasticsearchservice**) Remove incorrect endpoint tests +* (**forecastquery**) Remove incorrect endpoint tests +* (**gameliftstreams**) The default application in a stream group can now be changed at any time using UpdateStreamGroup to update the DefaultApplicationIdentifier. +* (**glue**) Added support for preprocessing queries in Data Quality operations through new DataQualityGlueTable structure. +* (**grafana**) Remove incorrect endpoint tests +* (**greengrassv2**) Remove incorrect endpoint tests +* (**guardduty**) Remove Pattern trait from email field +* (**inspector2**) Remove incorrect endpoint tests +* (**iotdeviceadvisor**) Remove incorrect endpoint tests +* (**iotevents**) Remove incorrect endpoint tests +* (**ioteventsdata**) Remove incorrect endpoint tests +* (**iotthingsgraph**) Remove incorrect endpoint tests +* (**ivs**) Remove incorrect endpoint tests +* (**kinesisvideosignaling**) Remove incorrect endpoint tests +* (**kinesisvideowebrtcstorage**) Remove incorrect endpoint tests +* (**lexruntimev2**) Remove incorrect endpoint tests +* (**lightsail**) Remove incorrect endpoint tests +* (**lookoutmetrics**) Remove incorrect endpoint tests +* (**managedblockchain**) Remove incorrect endpoint tests +* (**marketplaceagreement**) Remove incorrect endpoint tests +* (**mediaconnect**) Remove incorrect endpoint tests +* (**mediaconvert**) Remove incorrect endpoint tests +* (**mediapackage**) Remove incorrect endpoint tests +* (**mediapackagev2**) Remove incorrect endpoint tests +* (**mediatailor**) Remove incorrect endpoint tests +* (**mwaa**) Remove incorrect endpoint tests +* (**observabilityadmin**) Remove incorrect endpoint tests +* (**panorama**) Remove incorrect endpoint tests +* (**pinpointemail**) Remove incorrect endpoint tests +* (**resourcegroups**) Remove incorrect endpoint tests +* (**route53profiles**) Remove incorrect endpoint tests +* (**route53resolver**) Remove incorrect endpoint tests +* (**s3outposts**) Remove incorrect endpoint tests +* (**securitylake**) Remove incorrect endpoint tests +* (**ssmquicksetup**) Remove incorrect endpoint tests +* (**sts**) Remove incorrect endpoint tests +* (**timestreaminfluxdb**) Remove incorrect endpoint tests +* (**verifiedpermissions**) Remove incorrect endpoint tests +* (**wisdom**) Remove incorrect endpoint tests +* (**workspacesweb**) Remove incorrect endpoint tests + +### Documentation +* (**ecs**) This is a documentation only release that adds additional information for the update-service request parameters. +* (**ssmcontacts**) Doc-only updates for Incident Manager Contacts August 2025 + +## [1.5.22] - 08/20/2025 + +### Features +* (**bedrockruntime**) Launch CountTokens API to allow token counting +* (**billing**) Clarify IPv4 and IPv6 endpoints +* (**budgets**) Remove incorrect endpoint tests +* (**cognitoidentityprovider**) This release adds support for the new Terms APIs which allow displaying Terms of Use and Privacy Policy on the Managed Login user-registration page. +* (**costexplorer**) Remove incorrect endpoint tests +* (**datazone**) This release supports policy grant identifier for cloud formation integration +* (**detective**) Remove incorrect endpoint tests +* (**dynamodb**) Remove incorrect endpoint tests +* (**efs**) Remove incorrect endpoint tests +* (**eks**) EKS Add-ons Custom Namespace Support +* (**iam**) Remove incorrect endpoint tests +* (**kinesis**) Remove incorrect endpoint tests +* (**kinesisanalyticsv2**) Adds Key Management Service (KMS) support allowing customer-managed key (CMK) encryption for Flink application data. +* (**marketplaceentitlementservice**) Remove incorrect endpoint tests +* (**marketplacemetering**) Remove incorrect endpoint tests +* (**networkmanager**) Remove incorrect endpoint tests +* (**pinpointsmsvoicev2**) This change added InternationalSendingEnbaled as part of describe/Update/Request phone number API response, and as part of update/Request phone number API request +* (**route53recoverycontrolconfig**) Remove incorrect endpoint tests +* (**sagemaker**) This release adds 1/ Launch ml.p5.4xlarge instance in Processing jobs, Training jobs and Training Plan 2/ Makes S3Uri to be required for S3FileSystem and S3FileSystemConfig. +* (**sesv2**) Remove incorrect endpoint tests + +## [1.5.21] - 08/19/2025 + +### Features +* (**cleanrooms**) Support error message configuration for analysis templates +* (**ec2**) Add support for "warning" volume status. +* (**polly**) Added support for new output format - Opus. + +## [1.5.20] - 08/18/2025 + +### Features +* (**bcmdashboards**) Billing and Cost Management Dashboards enables users to create dashboards that combine multiple visualizations of cost and usage data. Users can create, manage, and share dashboards. Tags are also available for dashboards. +* (**connect**) Amazon Connect Service Feature: Add support to enable multi-user in-app, web, and video calling. +* (**connectparticipant**) Amazon Connect Service Feature: Add support to enable multi-user in-app, web, and video calling. +* (**s3control**) Adds support for Compute checksum functionality in Amazon S3 Batch Operations. You can now calculate checksums for a list of objects using supported algorithms in Amazon S3, without requiring a restore or download +* (**sagemaker**) Customer managed keys now available for volume encryption of SageMaker HyperPod clusters. + +### Documentation +* (**batch**) Added default_x86_64 and default_arm64 as values to the instanceTypes field. + +## [1.5.19] - 08/15/2025 + +### Features +* (**amp**) Add Resource-based Policy APIs for Amazon Prometheus +* (**bedrockagent**) This release adds support for saving Bedrock Flows while node configuration is still in progress, even if the Flow is not yet able to be invoked +* (**glue**) AWS Glue Zero ETL now supports On-demand snapshot load + +## [1.5.18] - 08/14/2025 + +### Features +* (**arcregionswitch**) Endpoint rule test and documentation update. +* (**bcmrecommendedactions**) Initial SDK release for AWS Billing and Cost Management Recommended Actions. +* (**directconnect**) Added pagination support for DescribeHostedConnections, DescribeVirtualInterfaces, DescribeConnections, DescribeInterconnects, DescribeLags. Added asnLong support for BGP peer operations which supports a large range. +* (**dynamodb**) This release 1/ Adds support for throttled keys mode for CloudWatch Contributor Insights, 2/ Adds throttling reasons to exceptions across dataplane APIs. 3/ Explicitly models ThrottlingException as a class in statically typed languages. Refer to the launch day blog post for more details. +* (**ec2**) This release adds ModifyInstanceConnectEndpoint API to update configurations on existing EC2 Instance Connect Endpoints and improves IPv6 support through dualstack DNS names for EC2 Instance Connect Endpoints. +* (**fsx**) Amazon FSx for NetApp ONTAP 2nd generation file systems now support decreasing SSD storage capacity. +* (**glue**) AWS Glue now supports Trusted Identity Propagation. +* (**guardduty**) Added support for entity lists. +* (**medialive**) CMAF Ingest output groups in MediaLive can now accept one additional destination url for single pipeline channels and up to two additional destination urls for standard channels. +* (**pcs**) Updated the regex pattern and description of iamInstanceProfileArn in the CreateComputeNodeGroup and UpdateComputeNodeGroup API actions. Name and path requirements apply to the ARN of the IAM role associated with the instance profile and not the ARN of the instance profile. +* (**servicediscovery**) Added support for cross account through Id parameter overloading with ARN and allow owner account for some APIs instead of ARN +* (**workspaces**) New APIs introduced to import WorkSpaces BYOL image using a new process that leveraged EC2 Image Builder. WorkSpaces tests and fixes your image's compatibility issues and supports customized VM images. + +### Documentation +* (**qapps**) Documentation update for Amazon Q Apps API Reference + +## [1.5.17] - 08/13/2025 + +### Features +* (**braket**) Add support for Braket program sets. +* (**datazone**) Adds support for account pools and project profile account decoupling +* (**fsx**) Add Dual-Stack support for Amazon FSx for OpenZFS file systems +* (**partnercentralselling**) Add Tagging Support for Opportunity resources +* (**sagemaker**) This release introduces compute quota for GPU, Trainium accelerators, vCPU, and vCPU memory utilization across teams in HyperPod clusters +* (**securityir**) Added support for Organizational Unit-level Membership configuration and the ability to resume a cancelled membership. + +## [1.5.16] - 08/12/2025 + +### Features +* (**backupsearch**) Using recommended smithy trait to generate regional endpoints for Backup Search +* (**codebuild**) AWS CodeBuild now supports PullRequestBuildPolicy in webhook object. +* (**ec2**) Release to allow route table association with a PublicIpv4Pool. +* (**organizations**) This release introduces 2 new APIs in Organizations: 1. ListAccountsWithInvalidEffectivePolicy 2. ListEffectivePolicyValidationErrors +* (**sagemaker**) IAM Identity Center trusted identity propagation is now supported in SageMaker Studio. +* (**transcribe**) AWS HealthScribe now supports specifying preferred patient pronouns through the MedicalScribeContext parameter for use in the generated clinical notes. +* (**transcribestreaming**) AWS HealthScribe now supports specifying preferred patient pronouns through the MedicalScribeContext parameter for use in the generated clinical notes. + +## [1.5.15] - 08/11/2025 + +### Features +* (**bedrock**) This release includes model updates and enhanced SDK documentation for union fields in automated reasoning policy components. Added docs cover policy definitions, mutations (add/update for rules/types/variables), build assets, workflow sources, test results, and tag exception handling. +* (**cognitoidentityprovider**) Remove SigV4 auth requirement for GetTokensFromRefreshToken +* (**connect**) Updating SearchUserHierarchyGroups API +* (**deadline**) Adds support for Wait and Save feature in service-managed fleets +* (**ec2**) This release adds AvailabilityZoneId support for CreateVolume, DescribeVolume, LaunchTemplates, RunInstances, DescribeInstances, CreateDefaultSubnet, SpotInstances, and CreateDefaultSubnet APIs. +* (**quicksight**) Add RowAxisDisplayOptions and ColumnAxisDisplayOptions to HeatMapConfiguration, add Actions to PluginVisual, increase limit for CalculatedFields list +* (**ssoadmin**) Added support for managing user background session for applications + +### Documentation +* (**evs**) Update for general availability of Amazon Elastic VMware Service (EVS). +* (**lambda**) Doc-only update for Lambda that updates the maximum payload size for response streaming invocations to 200 MB. + +## [1.5.14] - 08/08/2025 + +### Features +* (**applicationsignals**) Removed incorrect endpoint tests +* (**backupsearch**) Removed incorrect endpoint tests +* (**bcmpricingcalculator**) Removed incorrect endpoint tests +* (**billing**) Removed incorrect endpoint tests +* (**connect**) This release adds a new API GetContactMetrics for Amazon Connect. +* (**dsql**) Removed incorrect endpoint tests +* (**gameliftstreams**) Removed incorrect endpoint tests +* (**inspector2**) Add CVSSV4 to Vulnerability Search API and update enable/disable account id list length to 5 +* (**invoicing**) Removed incorrect endpoint tests +* (**iotdataplane**) Adding DeleteConnection API to IoT Data Plane +* (**iotmanagedintegrations**) Removed incorrect endpoint tests +* (**keyspacesstreams**) Removed incorrect endpoint tests +* (**mpa**) Removed incorrect endpoint tests +* (**networkflowmonitor**) Removed incorrect endpoint tests +* (**notifications**) Removed incorrect endpoint tests +* (**notificationscontacts**) Removed incorrect endpoint tests +* (**partnercentralselling**) Removed incorrect endpoint tests +* (**s3vectors**) Removed incorrect endpoint tests +* (**sagemaker**) Adds support for GB200 UltraServers in Amazon SageMaker training jobs, training plans, and HyperPod clusters +* (**securityir**) Removed incorrect endpoint tests +* (**workspacesinstances**) Removed incorrect endpoint tests + +### Documentation +* (**transcribe**) Update documentation to use key ARN only in OutputEncryptionKMSKeyId request parameter + +## [1.5.13] - 08/07/2025 + +### Features +* (**cloudfront**) Added new viewer security policy, TLSv1.3_2025, for CloudFront. +* (**codebuild**) AWS CodeBuild now supports comment-based pull request control. +* (**glue**) AWS Glue Data Catalog now supports Iceberg Optimization settings at the Catalog level, and supports new options to control the optimization job run rate. +* (**guardduty**) Added support for VPC owner account ID associated with DNS request in the GuardDuty finding. + +### Documentation +* (**batch**) This feature allows customers to use AWS Batch with Linux with ARM64 CPU Architecture with Fargate Spot compute support. +* (**gameliftstreams**) Adds Proton 9.0-2 to the list of runtime environment options available when creating an Amazon GameLift Streams application + +## [1.5.12] - 08/06/2025 + +### Features +* (**budgets**) Adds support for billing views. Billing views let you control access to cost and usage data through an AWS resource, streamlining the process of sharing cost and usage data across account boundaries. With this release, you can now create and view budgets based on billing views. +* (**ec2**) Mark Elastic Inference Accelerators and Elastic Graphics Processor parameters as deprecated on the RunInstances and LaunchTemplate APIs. +* (**opensearchserverless**) Features: add Index APIs in OpenSearchServerless to support managed semantic enrichment +* (**qbusiness**) Amazon Q Business now supports the GetDocumentContent() API that enables customers to securely access the source documents through clickable citation links at query time + +### Documentation +* (**appstream**) Added support for G6 instances + ## [1.5.11] - 08/05/2025 ### Features diff --git a/CODEOWNERS b/CODEOWNERS index 4725d413f0f..9eb496aef59 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1 +1 @@ -* @awslabs/aws-sdk-kotlin-sde +* @aws/aws-sdk-kotlin-team diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d2f5b74549..6239dd04097 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ information to effectively respond to your bug report or contribution. ## The AWS SDK for Kotlin is built from multiple GitHub repositories -1. This repository ([awslabs/aws-sdk-kotlin](https://github.com/awslabs/aws-sdk-kotlin)) +1. This repository ([aws/aws-sdk-kotlin](https://github.com/aws/aws-sdk-kotlin)) This repository contains code generation for AWS specific services, and a corresponding runtime to support the generated code. @@ -98,7 +98,7 @@ of your request may disagree and ask that you add one anyway. "type": "feature", "description": "Add multiplatform support for URL parsing", "issues": [ - "awslabs/aws-sdk-kotlin#12345" + "aws/aws-sdk-kotlin#12345" ] } ``` @@ -235,7 +235,7 @@ opensource-codeofconduct@amazon.com with any additional questions or comments. If you discover a potential security issue in this project we ask that you **do not** create a public GitHub issue. -Please refer to our [security policy](https://github.com/awslabs/aws-sdk-kotlin/security/policy) for how to notify us. +Please refer to our [security policy](https://github.com/aws/aws-sdk-kotlin/security/policy) for how to notify us. ## Licensing diff --git a/README.md b/README.md index cdf7ea5eb4d..7033d195925 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ [![Apache 2 licensed][apache-badge]][apache-url] [![Maven][maven-badge]][maven-url] [apache-badge]: https://img.shields.io/badge/license-APACHE2-blue.svg -[apache-url]: https://github.com/awslabs/aws-sdk-kotlin/blob/main/LICENSE +[apache-url]: https://github.com/aws/aws-sdk-kotlin/blob/main/LICENSE [maven-badge]: https://img.shields.io/maven-central/v/aws.sdk.kotlin/s3.svg?label=Maven [maven-url]: https://search.maven.org/search?q=g:aws.sdk.kotlin -This repo contains the AWS SDK for Kotlin and its [public roadmap](https://github.com/awslabs/aws-sdk-kotlin/projects/2). +This repo contains the AWS SDK for Kotlin and its [public roadmap](https://github.com/aws/aws-sdk-kotlin/projects/2). ## Getting Started @@ -24,7 +24,7 @@ See the [Getting Started Guide](docs/GettingStarted.md) to learn how to use the The SDK uses **GitHub Issues** to track feature requests and issues with the SDK. In addition, we use **GitHub Projects** to provide a high level overview of our roadmap and the features we are actively working on. -You can provide feedback or report a bug by submitting an [issue](https://github.com/awslabs/aws-sdk-kotlin/issues/new/choose). +You can provide feedback or report a bug by submitting an [issue](https://github.com/aws/aws-sdk-kotlin/issues/new/choose). This is the preferred mechanism to give feedback so that other users can engage in the conversation, +1 issues, etc. ## Contributing @@ -146,7 +146,7 @@ See [Debugging](docs/debugging.md) ## Security -Please refer to our [security policy](https://github.com/awslabs/aws-sdk-kotlin/security/policy). +Please refer to our [security policy](https://github.com/aws/aws-sdk-kotlin/security/policy). ## Supported targets diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/ProfileCredentialsProvider.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/ProfileCredentialsProvider.kt index 0b21677ee5e..de987a6905a 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/ProfileCredentialsProvider.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/ProfileCredentialsProvider.kt @@ -106,10 +106,11 @@ public class ProfileCredentialsProvider @InternalSdkApi constructor( private val namedProviders = mapOf( "Environment" to EnvironmentCredentialsProvider(platformProvider::getenv), "Ec2InstanceMetadata" to ImdsCredentialsProvider( - instanceProfileName = profileName, - client = ImdsClient { - platformProvider = this@ProfileCredentialsProvider.platformProvider - engine = httpClient + client = lazy { + ImdsClient { + platformProvider = this@ProfileCredentialsProvider.platformProvider + engine = httpClient + } }, platformProvider = platformProvider, ), diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/auth/ResolveAuthSchemePreference.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/auth/ResolveAuthSchemePreference.kt index 41071beb707..f06879eaf44 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/auth/ResolveAuthSchemePreference.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/auth/ResolveAuthSchemePreference.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.runtime.config.auth import aws.sdk.kotlin.runtime.InternalSdkApi diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/checksums/ResolveFlexibleChecksumsConfig.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/checksums/ResolveFlexibleChecksumsConfig.kt index 5925fb858f0..1859c5b43fe 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/checksums/ResolveFlexibleChecksumsConfig.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/checksums/ResolveFlexibleChecksumsConfig.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.runtime.config.checksums import aws.sdk.kotlin.runtime.InternalSdkApi 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 89c7d8c4729..07d4a81ec61 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 @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.runtime.config.imds import aws.sdk.kotlin.runtime.InternalSdkApi diff --git a/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/auth/credentials/ExecuteCommandTest.kt b/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/auth/credentials/ExecuteCommandTest.kt index c27a3503d3d..ad20fe34d5b 100644 --- a/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/auth/credentials/ExecuteCommandTest.kt +++ b/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/auth/credentials/ExecuteCommandTest.kt @@ -1,11 +1,16 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + import aws.sdk.kotlin.runtime.auth.credentials.executeCommand import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProviderException import aws.smithy.kotlin.runtime.util.OsFamily import aws.smithy.kotlin.runtime.util.PlatformProvider -import kotlinx.coroutines.TimeoutCancellationException import kotlinx.coroutines.test.runTest import kotlin.test.Test import kotlin.test.assertEquals +import kotlin.test.assertFails import kotlin.test.assertFailsWith class ExecuteCommandTest { @@ -33,7 +38,7 @@ class ExecuteCommandTest { @Test fun testExecutionTimedOut() = runTest { - assertFailsWith { + assertFails { executeCommand( command = "this won't be executed", platformProvider = provider, diff --git a/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/auth/credentials/ImdsCredentialsProviderTestResources.kt b/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/auth/credentials/ImdsCredentialsProviderTestResources.kt index e5ddb3b191d..0b991dcb716 100644 --- a/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/auth/credentials/ImdsCredentialsProviderTestResources.kt +++ b/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/auth/credentials/ImdsCredentialsProviderTestResources.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.runtime.auth.credentials // language=JSON diff --git a/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/util/AwsBusinessMetricsTestUtils.kt b/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/util/AwsBusinessMetricsTestUtils.kt index 71467475b34..dbc213438f9 100644 --- a/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/util/AwsBusinessMetricsTestUtils.kt +++ b/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/util/AwsBusinessMetricsTestUtils.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.runtime.util import aws.sdk.kotlin.runtime.http.interceptors.businessmetrics.AwsBusinessMetric diff --git a/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/util/VerifyingInstanceMetadataProvider.kt b/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/util/VerifyingInstanceMetadataProvider.kt index 0adf75e08a3..4e37042b325 100644 --- a/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/util/VerifyingInstanceMetadataProvider.kt +++ b/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/util/VerifyingInstanceMetadataProvider.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.runtime.util import aws.sdk.kotlin.runtime.config.imds.InstanceMetadataProvider diff --git a/aws-runtime/aws-config/jvm/test/aws/sdk/kotlin/runtime/auth/credentials/ProfileCredentialsProviderTestJVM.kt b/aws-runtime/aws-config/jvm/test/aws/sdk/kotlin/runtime/auth/credentials/ProfileCredentialsProviderTestJVM.kt index 802f8f253db..3cc0e2f5cd4 100644 --- a/aws-runtime/aws-config/jvm/test/aws/sdk/kotlin/runtime/auth/credentials/ProfileCredentialsProviderTestJVM.kt +++ b/aws-runtime/aws-config/jvm/test/aws/sdk/kotlin/runtime/auth/credentials/ProfileCredentialsProviderTestJVM.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.runtime.auth.credentials import aws.sdk.kotlin.runtime.auth.credentials.internal.credentials diff --git a/aws-runtime/aws-config/mingw/src/aws/sdk/kotlin/runtime/auth/credentials/executeCommandMingw.kt b/aws-runtime/aws-config/mingw/src/aws/sdk/kotlin/runtime/auth/credentials/executeCommandMingw.kt new file mode 100644 index 00000000000..96cdcb35528 --- /dev/null +++ b/aws-runtime/aws-config/mingw/src/aws/sdk/kotlin/runtime/auth/credentials/executeCommandMingw.kt @@ -0,0 +1,179 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ +package aws.sdk.kotlin.runtime.auth.credentials + +import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProviderException +import aws.smithy.kotlin.runtime.io.internal.SdkDispatchers +import aws.smithy.kotlin.runtime.time.Clock +import aws.smithy.kotlin.runtime.util.PlatformProvider +import kotlinx.cinterop.* +import kotlinx.coroutines.withContext +import platform.posix._wunlink +import platform.windows.* + +@OptIn(ExperimentalForeignApi::class) +private fun String.wideCString(mem: MemScope) = wcstr.getPointer(mem) + +@OptIn(ExperimentalForeignApi::class) +internal actual suspend fun executeCommand( + command: String, + platformProvider: PlatformProvider, + maxOutputLengthBytes: Long, + timeoutMillis: Long, + clock: Clock, +): Pair = withContext(SdkDispatchers.IO) { + memScoped { + // 1) temp path + file + val tmpDirBuf = allocArray(MAX_PATH) + val gotTmp = GetTempPathW(MAX_PATH.toUInt(), tmpDirBuf) + if (gotTmp == 0u) error("GetTempPathW failed") + + val tmpNameBuf = allocArray(MAX_PATH) + val tmpDirStr = tmpDirBuf.toKString() + val gotName = GetTempFileNameW(tmpDirStr, "KNR", 0u, tmpNameBuf) + if (gotName == 0u) error("GetTempFileNameW failed") + val outPath: String = tmpNameBuf.toKString() + + // 2) create output (inherit) + val sa = alloc().apply { + nLength = sizeOf().toUInt() + bInheritHandle = TRUE + lpSecurityDescriptor = null + } + + var hOut: HANDLE? = CreateFileW( + /* lpFileName = */ outPath, + /* dwDesiredAccess = */ GENERIC_WRITE.toUInt(), + /* dwShareMode = */ (FILE_SHARE_READ or FILE_SHARE_WRITE).toUInt(), + /* lpSecurityAttributes = */ sa.ptr, + /* dwCreationDisposition = */ CREATE_ALWAYS.toUInt(), + /* dwFlagsAndAttributes = */ FILE_ATTRIBUTE_NORMAL.toUInt(), + /* hTemplateFile = */ null, + ) + if (hOut == INVALID_HANDLE_VALUE) error("CreateFileW failed for temp output (GetLastError=${GetLastError()})") + + // Ensure the handle is marked inheritable (some setups ignore SA if handle flags were flipped later) + if (hOut != null && hOut != INVALID_HANDLE_VALUE) { + SetHandleInformation(hOut, HANDLE_FLAG_INHERIT.toUInt(), HANDLE_FLAG_INHERIT.toUInt()) + } + + try { + // 3) resolve shell (always cmd.exe) + val comspecBuf = allocArray(MAX_PATH) + val comspecLen = GetEnvironmentVariableW("ComSpec", comspecBuf, MAX_PATH.toUInt()) + val cmdExe: String = if (comspecLen > 0u) comspecBuf.toKString() else "C:\\Windows\\System32\\cmd.exe" + + // mutable command line buffer + val cmdLineStr = "/C $command" + val cmdLineBuf = cmdLineStr.wideCString(this) + + // 4) launch with redirected stdio + val si = alloc().apply { + cb = sizeOf().toUInt() + dwFlags = STARTF_USESTDHANDLES.toUInt() + hStdOutput = hOut + hStdError = hOut + hStdInput = GetStdHandle(STD_INPUT_HANDLE.toUInt()) + } + val pi = alloc() + + val created = CreateProcessW( + /* lpApplicationName = */ cmdExe, + /* lpCommandLine = */ cmdLineBuf, + /* lpProcessAttributes = */ null, + /* lpThreadAttributes = */ null, + /* bInheritHandles = */ TRUE, + /* dwCreationFlags = */ CREATE_NO_WINDOW.toUInt(), + /* lpEnvironment = */ null, + /* lpCurrentDirectory = */ null, + /* lpStartupInfo = */ si.ptr, + /* lpProcessInformation = */ pi.ptr, + ) + if (created == 0) error("CreateProcessW failed (GetLastError=${GetLastError()})") + + try { + // 5) wait + timeout + val waitRc: UInt = WaitForSingleObject(pi.hProcess, timeoutMillis.toUInt()) + if (waitRc == WAIT_TIMEOUT.toUInt()) { + TerminateProcess(pi.hProcess, 124u) + if (hOut != null && hOut != INVALID_HANDLE_VALUE) { + CloseHandle(hOut) + hOut = null + } + CloseHandle(pi.hThread) + CloseHandle(pi.hProcess) + _wunlink(outPath.wideCString(this)) + error("Process timed out after ${timeoutMillis}ms") + } + + // 6) exit code + val exitCodeVar = alloc() + if (GetExitCodeProcess(pi.hProcess, exitCodeVar.ptr) == 0) { + exitCodeVar.value = 0xFFFFFFFFu + } + val exitCode = exitCodeVar.value.toInt() + + // 🔑 Close writer before reading back + if (hOut != null && hOut != INVALID_HANDLE_VALUE) { + FlushFileBuffers(hOut) + CloseHandle(hOut) + hOut = null + } + + // 7) read back bounded + val hIn: HANDLE? = CreateFileW( + /* lpFileName = */ outPath, + /* dwDesiredAccess = */ GENERIC_READ.toUInt(), + /* dwShareMode = */ (FILE_SHARE_READ or FILE_SHARE_WRITE).toUInt(), + /* lpSecurityAttributes = */ null, + /* dwCreationDisposition = */ OPEN_EXISTING.toUInt(), + /* dwFlagsAndAttributes = */ FILE_ATTRIBUTE_NORMAL.toUInt(), + /* hTemplateFile = */ null, + ) + if (hIn == INVALID_HANDLE_VALUE) { + _wunlink(outPath.wideCString(this)) + CloseHandle(pi.hThread) + CloseHandle(pi.hProcess) + return@memScoped exitCode to "" + } + + val sb = StringBuilder() + val buf = ByteArray(4096) + val bytesReadVar = alloc() + var total = 0L + try { + while (true) { + val toRead = minOf(buf.size.toLong(), maxOutputLengthBytes - total).toInt() + if (toRead <= 0) { + CloseHandle(hIn) + _wunlink(outPath.wideCString(this)) + throw CredentialsProviderException("Process output exceeded limit of $maxOutputLengthBytes bytes") + } + val n = buf.usePinned { + val ok = ReadFile(hIn, it.addressOf(0), toRead.toUInt(), bytesReadVar.ptr, null) + if (ok == 0 || bytesReadVar.value == 0u) 0 else bytesReadVar.value.toInt() + } + if (n <= 0) break + total += n + sb.append(buf.decodeToString(0, n)) + } + } finally { + CloseHandle(hIn) + _wunlink(outPath.wideCString(this)) + } + + exitCode to sb.toString() + } finally { + CloseHandle(pi.hThread) + CloseHandle(pi.hProcess) + } + } finally { + if (hOut != null && hOut != INVALID_HANDLE_VALUE) { + CloseHandle(hOut) + hOut = 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 85cc27aacea..0a85db0f72e 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 @@ -8,6 +8,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.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/native/src/aws/sdk/kotlin/runtime/auth/credentials/executeCommandNative.kt b/aws-runtime/aws-config/posix/src/aws/sdk/kotlin/runtime/auth/credentials/executeCommandPosix.kt similarity index 86% rename from aws-runtime/aws-config/native/src/aws/sdk/kotlin/runtime/auth/credentials/executeCommandNative.kt rename to aws-runtime/aws-config/posix/src/aws/sdk/kotlin/runtime/auth/credentials/executeCommandPosix.kt index 2d7c21dd9b7..36df93b835f 100644 --- a/aws-runtime/aws-config/native/src/aws/sdk/kotlin/runtime/auth/credentials/executeCommandNative.kt +++ b/aws-runtime/aws-config/posix/src/aws/sdk/kotlin/runtime/auth/credentials/executeCommandPosix.kt @@ -47,19 +47,9 @@ internal actual suspend fun executeCommand( close(writeFd) } - val shell = when (platformProvider.osInfo().family) { - OsFamily.Windows -> "C:\\Windows\\System32\\cmd.exe" - else -> "/bin/sh" - } - - val shellArg = when (platformProvider.osInfo().family) { - OsFamily.Windows -> "/C" - else -> "-c" - } - memScoped { - val argv = (arrayOf(shell, shellArg, command).map { it.cstr.ptr } + null).toCValues() - execvp(shell, argv) + val argv = (arrayOf("/bin/sh", "-c", command).map { it.cstr.ptr } + null).toCValues() + execvp("/bin/sh", argv) } _exit(127) // If exec fails } @@ -79,6 +69,7 @@ internal actual suspend fun executeCommand( throw CredentialsProviderException("Process output exceeded limit of $maxOutputLengthBytes bytes") } + @OptIn(UnsafeNumber::class) val rc = read(readFd, buffer.refTo(0), nBytes.toULong()).toInt() if (rc <= 0) break totalBytesRead += rc diff --git a/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/interceptors/IgnoreCompositeFlexibleChecksumResponseInterceptor.kt b/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/interceptors/IgnoreCompositeFlexibleChecksumResponseInterceptor.kt index 75c70913894..dad6d3654e8 100644 --- a/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/interceptors/IgnoreCompositeFlexibleChecksumResponseInterceptor.kt +++ b/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/interceptors/IgnoreCompositeFlexibleChecksumResponseInterceptor.kt @@ -1,3 +1,8 @@ +/* + * 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.client.ProtocolResponseInterceptorContext diff --git a/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/interceptors/businessmetrics/AwsBusinessMetricsUtils.kt b/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/interceptors/businessmetrics/AwsBusinessMetricsUtils.kt index 56f88433456..239686ee3df 100644 --- a/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/interceptors/businessmetrics/AwsBusinessMetricsUtils.kt +++ b/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/interceptors/businessmetrics/AwsBusinessMetricsUtils.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.runtime.http.interceptors.businessmetrics import aws.sdk.kotlin.runtime.http.BUSINESS_METRICS_MAX_LENGTH @@ -26,7 +31,9 @@ internal fun formatMetrics(metrics: MutableSet, logger: Logger): true } } - if (allowedMetrics.isEmpty()) return "" + if (allowedMetrics.isEmpty()) { + return "" + } val metricsString = allowedMetrics.joinToString(",", "m/") { it.identifier } val metricsByteArray = metricsString.encodeToByteArray() diff --git a/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/retries/AwsRetryPolicy.kt b/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/retries/AwsRetryPolicy.kt index 807cb9018aa..c8ab3182dfe 100644 --- a/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/retries/AwsRetryPolicy.kt +++ b/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/retries/AwsRetryPolicy.kt @@ -9,9 +9,41 @@ import aws.smithy.kotlin.runtime.ServiceErrorMetadata import aws.smithy.kotlin.runtime.ServiceException import aws.smithy.kotlin.runtime.http.response.HttpResponse import aws.smithy.kotlin.runtime.retries.policy.RetryDirective -import aws.smithy.kotlin.runtime.retries.policy.RetryErrorType.* +import aws.smithy.kotlin.runtime.retries.policy.RetryErrorType.Throttling +import aws.smithy.kotlin.runtime.retries.policy.RetryErrorType.Transient import aws.smithy.kotlin.runtime.retries.policy.StandardRetryPolicy +/** + * The standard policy for AWS service clients that defines which error conditions are retryable and how. This policy + * will evaluate the following exceptions as retryable: + * + * * Any [ServiceException] with an `sdkErrorMetadata.errorCode` of: + * * `BandwidthLimitExceeded` + * * `EC2ThrottledException` + * * `IDPCommunicationError` + * * `LimitExceededException` + * * `PriorRequestNotComplete` + * * `ProvisionedThroughputExceededException` + * * `RequestLimitExceeded` + * * `RequestThrottled` + * * `RequestThrottledException` + * * `RequestTimeout` + * * `RequestTimeoutException` + * * `SlowDown` + * * `ThrottledException` + * * `Throttling` + * * `ThrottlingException` + * * `TooManyRequestsException` + * * `TransactionInProgressException` + * * Any [ServiceException] with an `sdkErrorMetadata.statusCode` of: + * * 500 (Internal Service Error) + * * 502 (Bad Gateway) + * * 503 (Service Unavailable) + * * 504 (Gateway Timeout) + * + * If none of those conditions match, this policy delegates to [StandardRetryPolicy]. See that class's documentation for + * more information about how it evaluates exceptions. + */ public open class AwsRetryPolicy : StandardRetryPolicy() { public companion object { /** diff --git a/aws-runtime/build.gradle.kts b/aws-runtime/build.gradle.kts index 9d5f8a5cfe6..e2a0dfc59fa 100644 --- a/aws-runtime/build.gradle.kts +++ b/aws-runtime/build.gradle.kts @@ -2,7 +2,7 @@ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0 */ -import aws.sdk.kotlin.gradle.dsl.configurePublishing +import aws.sdk.kotlin.gradle.dsl.configureNexusPublishing import aws.sdk.kotlin.gradle.kmp.kotlin import aws.sdk.kotlin.gradle.kmp.needsKmpConfigured import org.jetbrains.kotlin.gradle.dsl.JvmTarget @@ -32,7 +32,8 @@ subprojects { plugin(libraries.plugins.aws.kotlin.repo.tools.kmp.get().pluginId) } - configurePublishing("aws-sdk-kotlin") + // TODO Use configurePublishing when migrating to Sonatype Publisher API / JReleaser + configureNexusPublishing("aws-sdk-kotlin") kotlin { explicitApi() @@ -90,3 +91,11 @@ dependencies { } } } +val packagesToIgnore = listOf( + "aws.sdk.kotlin.runtime.auth.credentials.internal.sts", + "aws.sdk.kotlin.runtime.auth.credentials.internal.sso", + "aws.sdk.kotlin.runtime.auth.credentials.internal.ssooidc", +) +apiValidation { + ignoredPackages += packagesToIgnore +} diff --git a/bom/build.gradle.kts b/bom/build.gradle.kts index 9fa6bde1cce..31b714c675f 100644 --- a/bom/build.gradle.kts +++ b/bom/build.gradle.kts @@ -2,7 +2,7 @@ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0 */ -import aws.sdk.kotlin.gradle.dsl.configurePublishing +import aws.sdk.kotlin.gradle.dsl.configureNexusPublishing import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension import org.jetbrains.kotlin.gradle.plugin.KotlinMultiplatformPluginWrapper import org.jetbrains.kotlin.gradle.plugin.KotlinTarget @@ -98,7 +98,8 @@ fun DependencyConstraintHandler.api(constraintNotation: Any) = createBomConstraintsAndVersionCatalog() -configurePublishing("aws-sdk-kotlin") +// TODO Use configurePublishing when migrating to Sonatype Publisher API / JReleaser +configureNexusPublishing("aws-sdk-kotlin") publishing { publications { diff --git a/build.gradle.kts b/build.gradle.kts index 2279f860c55..9221688b414 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -3,6 +3,7 @@ * SPDX-License-Identifier: Apache-2.0 */ import aws.sdk.kotlin.gradle.dsl.configureLinting +import aws.sdk.kotlin.gradle.dsl.configureMinorVersionStrategyRules import aws.sdk.kotlin.gradle.dsl.configureNexus import aws.sdk.kotlin.gradle.kmp.configureIosSimulatorTasks import aws.sdk.kotlin.gradle.util.typedProp @@ -15,6 +16,18 @@ buildscript { // Add our custom gradle build logic to buildscript classpath classpath(libs.aws.kotlin.repo.tools.build.support) } + + configurations.classpath { + resolutionStrategy { + /* + Version bumping the SDK to 1.5.x in repo tools broke our buildscript classpath: + java.lang.NoSuchMethodError: 'void kotlinx.coroutines.CancellableContinuation.resume(java.lang.Object, kotlin.jvm.functions.Function3) + + FIXME: Figure out what broke our buildscipt classpath, this is a temporary fix + */ + force("com.squareup.okhttp3:okhttp-coroutines:5.0.0-alpha.14") + } + } } plugins { @@ -98,3 +111,4 @@ val lintPaths = listOf( ) configureLinting(lintPaths) +configureMinorVersionStrategyRules(lintPaths) diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts index ea81e7825a9..60e7ba27f4f 100644 --- a/buildSrc/build.gradle.kts +++ b/buildSrc/build.gradle.kts @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + plugins { alias(libs.plugins.kotlin.jvm) `kotlin-dsl` diff --git a/buildSrc/settings.gradle.kts b/buildSrc/settings.gradle.kts index 62991c1ef50..fa909303793 100644 --- a/buildSrc/settings.gradle.kts +++ b/buildSrc/settings.gradle.kts @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + rootProject.name = "buildSrc" dependencyResolutionManagement { diff --git a/buildSrc/src/main/kotlin/aws/sdk/kotlin/tests/codegen/CodegenTest.kt b/buildSrc/src/main/kotlin/aws/sdk/kotlin/tests/codegen/CodegenTest.kt index 764e0abc44b..9facb987866 100644 --- a/buildSrc/src/main/kotlin/aws/sdk/kotlin/tests/codegen/CodegenTest.kt +++ b/buildSrc/src/main/kotlin/aws/sdk/kotlin/tests/codegen/CodegenTest.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.tests.codegen /** diff --git a/buildSrc/src/main/kotlin/dokka-convention.gradle.kts b/buildSrc/src/main/kotlin/dokka-convention.gradle.kts index 585ce416c07..b7bca271f10 100644 --- a/buildSrc/src/main/kotlin/dokka-convention.gradle.kts +++ b/buildSrc/src/main/kotlin/dokka-convention.gradle.kts @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + import org.jsoup.Jsoup import kotlin.io.path.ExperimentalPathApi import kotlin.io.path.PathWalkOption @@ -65,8 +70,7 @@ dokka { dokkaSourceSets.configureEach { externalDocumentationLinks { create("smithy-kotlin") { - val smithyKotlinRuntimeVersion = versionCatalogs.named("libs").findVersion("smithy-kotlin-runtime-version").get() - url("https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion") + url("https://docs.aws.amazon.com/smithy-kotlin/api/latest") } } } diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/ModuleDocumentationIntegration.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/ModuleDocumentationIntegration.kt index 433cfb0d492..a559d714c0b 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/ModuleDocumentationIntegration.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/ModuleDocumentationIntegration.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.codegen import software.amazon.smithy.aws.traits.ServiceTrait diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/SdkIdTransform.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/SdkIdTransform.kt deleted file mode 100644 index d3da93976f7..00000000000 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/SdkIdTransform.kt +++ /dev/null @@ -1,61 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * SPDX-License-Identifier: Apache-2.0 - */ -package aws.sdk.kotlin.codegen - -private val whitespaceRegex = Regex("\\s") - -/** - * Implements a single standardized sdkId transform. - */ -interface SdkIdTransformer { - fun transform(id: String): String -} - -/** - * Implements all standardized sdkId transforms. - */ -object SdkIdTransform { - /** - * Replace all whitespace from the sdkId with underscores and lowercase all letters. - */ - object LowerSnakeCase : SdkIdTransformer { - override fun transform(id: String): String = id.replaceWhitespace("_").lowercase() - } - - /** - * None. Directly use the sdkId. - */ - object Identity : SdkIdTransformer { - override fun transform(id: String): String = id - } - - /** - * Remove all whitespace from the sdkId. - */ - object NoWhitespace : SdkIdTransformer { - override fun transform(id: String): String = id.replaceWhitespace("") - } - - /** - * Replace all whitespace from the sdkId with dashes and lowercase all letters. - */ - object LowerKebabCase : SdkIdTransformer { - override fun transform(id: String): String = id.replaceWhitespace("-").lowercase() - } - - /** - * Replace all whitespace from the sdkId with underscores and capitalize all letters. - */ - object UpperSnakeCase : SdkIdTransformer { - override fun transform(id: String): String = id.replaceWhitespace("_").uppercase() - } -} - -/** - * Applies a concrete sdkId transform to a string. - */ -fun String.withTransform(transformer: SdkIdTransformer): String = transformer.transform(this) - -private fun String.replaceWhitespace(replacement: String) = replace(whitespaceRegex, replacement) diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/ServiceClientCompanionObjectWriter.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/ServiceClientCompanionObjectWriter.kt index 4f015735231..6f566ba75de 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/ServiceClientCompanionObjectWriter.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/ServiceClientCompanionObjectWriter.kt @@ -64,15 +64,15 @@ internal data class EndpointUrlConfigNames( internal fun String.toEndpointUrlConfigNames(): EndpointUrlConfigNames = EndpointUrlConfigNames( withTransform(JvmSystemPropertySuffix), - withTransform(SdkIdTransform.UpperSnakeCase), - withTransform(SdkIdTransform.LowerSnakeCase), + withTransform(SdkIdTransformers.UpperSnakeCase), + withTransform(SdkIdTransformers.LowerSnakeCase), ) // JVM system property names follow the pattern "aws.endpointUrl${BaseClientName}" // where BaseClientName is the PascalCased sdk ID with any forbidden suffixes dropped - this is the same as what we use // for our client names // e.g. sdkId "Elasticsearch Service" -> client name "ElasticsearchClient", prop "aws.endpointUrlElasticsearch" -private object JvmSystemPropertySuffix : SdkIdTransformer { +private object JvmSystemPropertySuffix : StringTransformer { override fun transform(id: String): String = id.toPascalCase().removeSuffix("Service") } diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/StringTransform.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/StringTransform.kt new file mode 100644 index 00000000000..9ac814ce799 --- /dev/null +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/StringTransform.kt @@ -0,0 +1,58 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ +package aws.sdk.kotlin.codegen + +import software.amazon.smithy.kotlin.codegen.utils.toPascalCase + +private val whitespaceRegex = Regex("\\s") + +private val spaceOrDashRegex = Regex("\\s|-") + +/** + * Base interface for string transformers. + */ +fun interface StringTransformer { + fun transform(input: String): String +} + +/** + * Implements all standardized sdkId transforms. + */ +object SdkIdTransformers { + // Replace all whitespace from the sdkId with underscores and lowercase all letters. + val LowerSnakeCase = StringTransformer { it.replaceWhitespace("_").lowercase() } + + // None. Directly use the sdkId. + val Identity = StringTransformer { it } + + // Remove all whitespace from the sdkId. + val NoWhitespace = StringTransformer { it.replaceWhitespace("") } + + // Replace all whitespace from the sdkId with dashes and lowercase all letters. + val LowerKebabCase = StringTransformer { it.replaceWhitespace("-").lowercase() } + + // Replace all whitespace from the sdkId with underscores and capitalize all letters. + val UpperSnakeCase = StringTransformer { it.replaceWhitespace("_").uppercase() } +} + +/** + * Implements all standardized SigV4 service signing name transforms. + */ +object SigV4NameTransformers { + // Replace all dashes from the SigV4 service signing name with underscores and capitalize all letters. + val UpperSnakeCase = StringTransformer { it.replaceSpaceOrDash("_").uppercase() } + + // Remove dashes and convert SigV4 service signing name to PascalCase + val PascalCase = StringTransformer { it.toPascalCase() } +} + +/** + * Applies the given transformer to the string. + */ +fun String.withTransform(transformer: T): String = transformer.transform(this) + +private fun String.replaceWhitespace(replacement: String) = replace(whitespaceRegex, replacement) + +private fun String.replaceSpaceOrDash(replacement: String) = replace(spaceOrDashRegex, replacement) diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/businessmetrics/CredentialsBusinessMetricsIntegration.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/businessmetrics/CredentialsBusinessMetricsIntegration.kt index 162c12dbb09..ea240f5f5cf 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/businessmetrics/CredentialsBusinessMetricsIntegration.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/businessmetrics/CredentialsBusinessMetricsIntegration.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.codegen.businessmetrics import aws.sdk.kotlin.codegen.AwsRuntimeTypes diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/businessmetrics/EndpointBusinessMetricsIntegration.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/businessmetrics/EndpointBusinessMetricsIntegration.kt index 8641a8ac634..ef59d7bf05a 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/businessmetrics/EndpointBusinessMetricsIntegration.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/businessmetrics/EndpointBusinessMetricsIntegration.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.codegen.businessmetrics import aws.sdk.kotlin.codegen.AwsRuntimeTypes diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/EnvironmentBearerTokenCustomization.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/EnvironmentBearerTokenCustomization.kt index cd91e26ce9d..c3ff56fccf0 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/EnvironmentBearerTokenCustomization.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/EnvironmentBearerTokenCustomization.kt @@ -4,8 +4,8 @@ */ package aws.sdk.kotlin.codegen.customization -import aws.sdk.kotlin.codegen.SdkIdTransform import aws.sdk.kotlin.codegen.ServiceClientCompanionObjectWriter +import aws.sdk.kotlin.codegen.SigV4NameTransformers import aws.sdk.kotlin.codegen.withTransform import software.amazon.smithy.kotlin.codegen.KotlinSettings import software.amazon.smithy.kotlin.codegen.core.* @@ -22,15 +22,15 @@ import software.amazon.smithy.model.shapes.ServiceShape import software.amazon.smithy.model.traits.HttpBearerAuthTrait /** - * Customization that enables sourcing Bearer tokens from an environment variable + * Customization that enables sourcing Bearer tokens from JVM system properties and system environment variables * - * When a service-specific environment variable for bearer tokens is present (e.g., AWS_BEARER_TOKEN_BEDROCK), - * this customization configures the auth scheme resolver to prefer the smithy.api#httpBearerAuth scheme - * over other authentication methods. Additionally, it configures a token provider that extracts the bearer token - * from the target environment variable. + * When a service-specific JVM system property (e.g., aws.bearerTokenBedrock) or system environment variable + * for bearer tokens is present (e.g., AWS_BEARER_TOKEN_BEDROCK), this customization configures the + * auth scheme resolver to prefer the smithy.api#httpBearerAuth scheme over other authentication methods. + * Additionally, it configures a token provider that extracts the bearer token from these sources. */ class EnvironmentBearerTokenCustomization : KotlinIntegration { - // Currently only services with sigv4 service name 'bedrock' need this customization + // Currently only services with sigV4 service name 'bedrock' need this customization private val supportedSigningServiceNames = setOf("bedrock") override fun enabledForService(model: Model, settings: KotlinSettings): Boolean { @@ -68,9 +68,11 @@ class EnvironmentBearerTokenCustomization : KotlinIntegration { ) { val serviceSymbol = ctx.symbolProvider.toSymbol(serviceShape) val signingServiceName = AwsSignatureVersion4.signingServiceName(serviceShape) - // Transform signing name to environment variable name - val envVarSuffix = signingServiceName.withTransform(SdkIdTransform.UpperSnakeCase) - val envVarName = "AWS_BEARER_TOKEN_$envVarSuffix" + // Transform signing service name to environment variable key suffix + val envSuffix = signingServiceName.withTransform(SigV4NameTransformers.UpperSnakeCase) + val sysPropSuffix = signingServiceName.withTransform(SigV4NameTransformers.PascalCase) + val envKey = "AWS_BEARER_TOKEN_$envSuffix" + val sysPropKey = "aws.bearerToken$sysPropSuffix" val authSchemeId = RuntimeTypes.Auth.Identity.AuthSchemeId writer.withBlock( @@ -79,9 +81,8 @@ class EnvironmentBearerTokenCustomization : KotlinIntegration { serviceSymbol, RuntimeTypes.Core.Utils.PlatformProvider, ) { - // The customization do nothing if environment variable is not set - write("if (provider.getenv(#S) == null) { return }", envVarName) - + // The customization does nothing if environment variable and JVM system property are not set + write("if (provider.getProperty(#S) == null && provider.getenv(#S) == null) return", sysPropKey, envKey) // Configure auth scheme preference if customer hasn't specify one write("builder.config.authSchemePreference = builder.config.authSchemePreference ?: listOf(#T.HttpBearer)", authSchemeId) @@ -93,9 +94,10 @@ class EnvironmentBearerTokenCustomization : KotlinIntegration { write("builder.config.authSchemePreference = listOf(#1T.HttpBearer) + filteredSchemes", authSchemeId) write( - "builder.config.bearerTokenProvider = builder.config.bearerTokenProvider ?: #T(#S, provider)", + "builder.config.bearerTokenProvider = builder.config.bearerTokenProvider ?: #T(#S, #S, provider)", RuntimeTypes.Auth.HttpAuth.EnvironmentBearerTokenProvider, - envVarName, + sysPropKey, + envKey, ) } } diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/model/traits/testing/SmokeTestTraits.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/model/traits/testing/SmokeTestTraits.kt index 6805c3bad1f..4d67c7549b3 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/model/traits/testing/SmokeTestTraits.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/model/traits/testing/SmokeTestTraits.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.codegen.model.traits.testing import software.amazon.smithy.model.node.ObjectNode diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/AwsSmokeTestsRunnerGeneratorIntegration.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/AwsSmokeTestsRunnerGeneratorIntegration.kt index 1e694ae4bbc..da154161601 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/AwsSmokeTestsRunnerGeneratorIntegration.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/AwsSmokeTestsRunnerGeneratorIntegration.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.codegen.smoketests import aws.sdk.kotlin.codegen.AwsRuntimeTypes diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/SmokeTestsDenyListIntegration.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/SmokeTestsDenyListIntegration.kt index 06222e6c603..500cb2ea183 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/SmokeTestsDenyListIntegration.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/SmokeTestsDenyListIntegration.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.codegen.smoketests import software.amazon.smithy.kotlin.codegen.KotlinSettings diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/testing/SmokeTestFailHttpEngineIntegration.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/testing/SmokeTestFailHttpEngineIntegration.kt index ad6bd0ee95e..fb718146311 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/testing/SmokeTestFailHttpEngineIntegration.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/testing/SmokeTestFailHttpEngineIntegration.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.codegen.smoketests.testing import aws.sdk.kotlin.codegen.model.traits.testing.TestFailedResponseTrait diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/testing/SmokeTestSuccessHttpEngineIntegration.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/testing/SmokeTestSuccessHttpEngineIntegration.kt index 03077a4cd5a..a31744be236 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/testing/SmokeTestSuccessHttpEngineIntegration.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/testing/SmokeTestSuccessHttpEngineIntegration.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.codegen.smoketests.testing import aws.sdk.kotlin.codegen.model.traits.testing.TestFailedResponseTrait 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 2bd5184a39a..6e71c478a47 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 @@ -62,6 +62,9 @@ "ap-southeast-5" : { "description" : "Asia Pacific (Malaysia)" }, + "ap-southeast-6" : { + "description" : "Asia Pacific (New Zealand)" + }, "ap-southeast-7" : { "description" : "Asia Pacific (Thailand)" }, @@ -199,6 +202,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "access-analyzer.ap-southeast-7.api.aws", @@ -426,6 +430,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -538,6 +543,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -1099,6 +1105,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "credentialScope" : { "region" : "ap-southeast-7" @@ -1945,6 +1952,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -2068,6 +2076,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -2105,6 +2114,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -2213,6 +2223,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -3013,6 +3024,7 @@ "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, + "ap-east-2" : { }, "ap-northeast-1" : { "variants" : [ { "tags" : [ "dualstack" ] @@ -3023,11 +3035,13 @@ "tags" : [ "dualstack" ] } ] }, + "ap-northeast-3" : { }, "ap-south-1" : { "variants" : [ { "tags" : [ "dualstack" ] } ] }, + "ap-south-2" : { }, "ap-southeast-1" : { "variants" : [ { "tags" : [ "dualstack" ] @@ -3038,9 +3052,12 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-3" : { }, + "ap-southeast-4" : { }, "ap-southeast-5" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, + "ca-west-1" : { }, "eu-central-1" : { "variants" : [ { "tags" : [ "dualstack" ] @@ -3053,6 +3070,7 @@ } ] }, "eu-south-1" : { }, + "eu-south-2" : { }, "eu-west-1" : { "variants" : [ { "tags" : [ "dualstack" ] @@ -3068,7 +3086,10 @@ "tags" : [ "dualstack" ] } ] }, + "il-central-1" : { }, "me-central-1" : { }, + "me-south-1" : { }, + "mx-central-1" : { }, "sa-east-1" : { "variants" : [ { "tags" : [ "dualstack" ] @@ -3098,6 +3119,7 @@ "us-east-2-fips" : { "deprecated" : true }, + "us-west-1" : { }, "us-west-2" : { "variants" : [ { "tags" : [ "dualstack" ] @@ -3127,6 +3149,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -3496,6 +3519,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -3634,6 +3658,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -3702,6 +3727,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -3774,6 +3800,7 @@ }, "bedrock" : { "endpoints" : { + "ap-east-2" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-northeast-3" : { }, @@ -3781,7 +3808,10 @@ "ap-south-2" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ap-southeast-4" : { }, + "ap-southeast-5" : { }, + "ap-southeast-7" : { }, "bedrock-ap-northeast-1" : { "credentialScope" : { "region" : "ap-northeast-1" @@ -4079,6 +4109,8 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "il-central-1" : { }, + "me-central-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -4614,6 +4646,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "cloudcontrolapi.ap-southeast-7.api.aws", @@ -4842,6 +4875,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -5125,6 +5159,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -6541,6 +6576,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -7284,6 +7320,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "datasync.ap-southeast-7.api.aws", @@ -7494,6 +7531,7 @@ } ] }, "endpoints" : { + "ap-east-1" : { }, "ap-east-2" : { }, "ap-northeast-1" : { "hostname" : "datazone.ap-northeast-1.api.aws" @@ -7525,6 +7563,7 @@ "ap-southeast-5" : { "hostname" : "datazone.ap-southeast-5.api.aws" }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "hostname" : "datazone.ap-southeast-7.api.aws" }, @@ -7541,6 +7580,7 @@ "eu-central-1" : { "hostname" : "datazone.eu-central-1.api.aws" }, + "eu-central-2" : { }, "eu-north-1" : { "hostname" : "datazone.eu-north-1.api.aws" }, @@ -7719,6 +7759,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -7899,6 +7940,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "dlm.ap-southeast-7.api.aws", @@ -8054,6 +8096,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -8435,6 +8478,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -8551,6 +8595,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -8698,6 +8743,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -8862,6 +8908,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -8964,6 +9011,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -9081,6 +9129,7 @@ "ap-southeast-5" : { "hostname" : "eks-auth.ap-southeast-5.api.aws" }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "hostname" : "eks-auth.ap-southeast-7.api.aws" }, @@ -9158,6 +9207,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -9291,6 +9341,8 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-5" : { }, + "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { "hostname" : "elasticbeanstalk.ca-central-1.api.aws", @@ -9315,6 +9367,7 @@ "tags" : [ "dualstack" ] } ] }, + "eu-south-2" : { }, "eu-west-1" : { "variants" : [ { "hostname" : "elasticbeanstalk.eu-west-1.api.aws", @@ -9505,6 +9558,7 @@ "tags" : [ "fips" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "elasticfilesystem-fips.ap-southeast-7.amazonaws.com", @@ -9869,6 +9923,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -9958,6 +10013,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -10261,6 +10317,7 @@ "ap-southeast-1" : { }, "ap-southeast-2" : { }, "ap-southeast-3" : { }, + "ap-southeast-4" : { }, "ca-central-1" : { "variants" : [ { "hostname" : "emr-serverless-fips.ca-central-1.amazonaws.com", @@ -10269,6 +10326,7 @@ }, "ca-west-1" : { }, "eu-central-1" : { }, + "eu-central-2" : { }, "eu-north-1" : { }, "eu-south-1" : { }, "eu-south-2" : { }, @@ -10310,6 +10368,7 @@ "deprecated" : true, "hostname" : "emr-serverless-fips.us-west-2.amazonaws.com" }, + "il-central-1" : { }, "me-central-1" : { }, "me-south-1" : { }, "sa-east-1" : { }, @@ -10429,6 +10488,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "aos.ap-southeast-7.api.aws", @@ -10673,6 +10733,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "events.ap-southeast-7.api.aws", @@ -10971,6 +11032,7 @@ } ] }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "firehose.ap-southeast-7.api.aws", @@ -11162,6 +11224,7 @@ "tags" : [ "fips" ] } ] }, + "ap-east-2" : { }, "ap-northeast-1" : { "variants" : [ { "hostname" : "fms-fips.ap-northeast-1.amazonaws.com", @@ -11819,6 +11882,7 @@ "ap-southeast-5" : { "hostname" : "gameliftstreams.ap-southeast-5.api.aws" }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "hostname" : "gameliftstreams.ap-southeast-7.api.aws" }, @@ -13046,6 +13110,7 @@ "ap-southeast-5" : { "hostname" : "internetmonitor.ap-southeast-5.api.aws" }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "hostname" : "internetmonitor.ap-southeast-7.api.aws" }, @@ -14000,18 +14065,24 @@ }, "kafkaconnect" : { "endpoints" : { + "ap-east-2" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-south-1" : { }, "ap-south-2" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-5" : { }, + "ap-southeast-7" : { }, "ca-central-1" : { }, + "ca-west-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-2" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "mx-central-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -14128,6 +14199,7 @@ "ap-southeast-5" : { "hostname" : "kendra-ranking.ap-southeast-5.api.aws" }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "hostname" : "kendra-ranking.ap-southeast-7.api.aws" }, @@ -14215,6 +14287,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -14583,6 +14656,7 @@ "deprecated" : true, "hostname" : "kms-fips.ap-southeast-5.amazonaws.com" }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "kms-fips.ap-southeast-7.amazonaws.com", @@ -15169,6 +15243,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "lambda.ap-southeast-7.api.aws", @@ -15675,6 +15750,7 @@ } ] }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -17190,6 +17266,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -17639,6 +17716,7 @@ "ap-southeast-5" : { "hostname" : "notifications.ap-southeast-5.api.aws" }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "hostname" : "notifications.ap-southeast-7.api.aws" }, @@ -17728,6 +17806,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -17824,6 +17903,7 @@ }, "hostname" : "oidc.ap-southeast-5.amazonaws.com" }, + "ap-southeast-7" : { }, "ca-central-1" : { "credentialScope" : { "region" : "ca-central-1" @@ -17902,6 +17982,7 @@ }, "hostname" : "oidc.me-south-1.amazonaws.com" }, + "mx-central-1" : { }, "sa-east-1" : { "credentialScope" : { "region" : "sa-east-1" @@ -17936,6 +18017,7 @@ }, "omics" : { "endpoints" : { + "ap-northeast-2" : { }, "ap-southeast-1" : { "credentialScope" : { "region" : "ap-southeast-1" @@ -18002,22 +18084,6 @@ } } }, - "opsworks" : { - "endpoints" : { - "ap-southeast-1" : { }, - "eu-central-1" : { }, - "eu-west-1" : { }, - "us-east-1" : { }, - "us-west-2" : { } - } - }, - "opsworks-cm" : { - "endpoints" : { - "ap-southeast-2" : { }, - "eu-west-1" : { }, - "us-east-1" : { } - } - }, "organizations" : { "endpoints" : { "aws-global" : { @@ -18123,6 +18189,7 @@ "il-central-1" : { }, "me-central-1" : { }, "me-south-1" : { }, + "mx-central-1" : { }, "sa-east-1" : { }, "us-east-1" : { "variants" : [ { @@ -18290,6 +18357,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "protocols" : [ "https" ], "variants" : [ { @@ -18900,6 +18968,7 @@ }, "hostname" : "portal.sso.ap-southeast-5.amazonaws.com" }, + "ap-southeast-7" : { }, "ca-central-1" : { "credentialScope" : { "region" : "ca-central-1" @@ -18978,6 +19047,7 @@ }, "hostname" : "portal.sso.me-south-1.amazonaws.com" }, + "mx-central-1" : { }, "sa-east-1" : { "credentialScope" : { "region" : "sa-east-1" @@ -19122,6 +19192,7 @@ "ap-southeast-5" : { "hostname" : "qbusiness.ap-southeast-5.api.aws" }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "hostname" : "qbusiness.ap-southeast-7.api.aws" }, @@ -19277,6 +19348,8 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "il-central-1" : { }, + "me-central-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -19346,6 +19419,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "tags" : [ "dualstack" ] @@ -19601,6 +19675,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -19806,6 +19881,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -20084,6 +20160,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -20180,7 +20257,9 @@ }, "redshift-serverless" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, + "ap-east-2" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-south-1" : { }, @@ -20198,6 +20277,7 @@ "eu-central-1" : { }, "eu-central-2" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-south-2" : { }, "eu-west-1" : { }, "eu-west-2" : { }, @@ -20639,6 +20719,7 @@ "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, + "ap-east-2" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-northeast-3" : { }, @@ -20776,6 +20857,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -20872,6 +20954,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -21257,6 +21340,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "route53resolver.ap-southeast-7.api.aws", @@ -21563,6 +21647,7 @@ "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, + "ap-east-2" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-northeast-3" : { }, @@ -21737,6 +21822,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "s3.dualstack.ap-southeast-7.amazonaws.com", @@ -22569,6 +22655,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -22701,6 +22788,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "tags" : [ "dualstack" ] @@ -22920,6 +23008,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "securityhub.ap-southeast-7.api.aws", @@ -23527,6 +23616,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "servicediscovery.ap-southeast-7.api.aws", @@ -23745,6 +23835,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -24073,23 +24164,6 @@ "us-west-2" : { } } }, - "sms" : { - "endpoints" : { - "fips-us-west-2" : { - "credentialScope" : { - "region" : "us-west-2" - }, - "deprecated" : true, - "hostname" : "sms-fips.us-west-2.amazonaws.com" - }, - "us-west-2" : { - "variants" : [ { - "hostname" : "sms-fips.us-west-2.amazonaws.com", - "tags" : [ "fips" ] - } ] - } - } - }, "sms-voice" : { "endpoints" : { "af-south-1" : { @@ -24860,6 +24934,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "sns.ap-southeast-7.api.aws", @@ -25111,6 +25186,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "sqs.ap-southeast-7.api.aws", @@ -25309,6 +25385,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -25967,6 +26044,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, "eu-central-1" : { }, @@ -25980,6 +26058,7 @@ "il-central-1" : { }, "me-central-1" : { }, "me-south-1" : { }, + "mx-central-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -26002,6 +26081,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -26226,6 +26306,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -26270,6 +26351,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "aws-global" : { "credentialScope" : { @@ -26380,6 +26462,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { @@ -26549,6 +26632,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-6" : { }, "ap-southeast-7" : { "variants" : [ { "hostname" : "synthetics.ap-southeast-7.api.aws", @@ -26764,6 +26848,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -27310,6 +27395,7 @@ "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, + "ap-east-2" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-northeast-3" : { }, @@ -27571,6 +27657,9 @@ }, "trustedadvisor" : { "endpoints" : { + "ap-northeast-2" : { }, + "ap-southeast-2" : { }, + "eu-west-1" : { }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" @@ -27588,13 +27677,17 @@ "region" : "us-west-2" }, "hostname" : "trustedadvisor-fips.us-west-2.api.aws" - } + }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } } }, "verifiedpermissions" : { "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, + "ap-east-2" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-northeast-3" : { }, @@ -27604,6 +27697,9 @@ "ap-southeast-2" : { }, "ap-southeast-3" : { }, "ap-southeast-4" : { }, + "ap-southeast-5" : { }, + "ap-southeast-6" : { }, + "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { "hostname" : "verifiedpermissions-fips.ca-central-1.amazonaws.com", @@ -27669,6 +27765,7 @@ "il-central-1" : { }, "me-central-1" : { }, "me-south-1" : { }, + "mx-central-1" : { }, "sa-east-1" : { }, "us-east-1" : { "variants" : [ { @@ -28368,6 +28465,7 @@ "tags" : [ "fips" ] } ] }, + "ap-east-2" : { }, "ap-northeast-1" : { "credentialScope" : { "region" : "ap-northeast-1" @@ -29099,6 +29197,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-6" : { }, "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, @@ -30697,11 +30796,6 @@ } } }, - "sms" : { - "endpoints" : { - "cn-north-1" : { } - } - }, "snowball" : { "endpoints" : { "cn-north-1" : { @@ -30911,6 +31005,12 @@ "cn-northwest-1" : { } } }, + "verifiedpermissions" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "waf-regional" : { "endpoints" : { "cn-north-1" : { @@ -31575,6 +31675,12 @@ } } }, + "aps" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "arc-zonal-shift" : { "endpoints" : { "us-gov-east-1" : { }, @@ -35208,6 +35314,12 @@ } } }, + "rum" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "runtime-v2-lex" : { "endpoints" : { "us-gov-west-1" : { } @@ -35779,23 +35891,6 @@ } } }, - "sms" : { - "endpoints" : { - "fips-us-gov-west-1" : { - "credentialScope" : { - "region" : "us-gov-west-1" - }, - "deprecated" : true, - "hostname" : "sms-fips.us-gov-west-1.amazonaws.com" - }, - "us-gov-west-1" : { - "variants" : [ { - "hostname" : "sms-fips.us-gov-west-1.amazonaws.com", - "tags" : [ "fips" ] - } ] - } - } - }, "sms-voice" : { "endpoints" : { "fips-us-gov-east-1" : { @@ -37187,7 +37282,8 @@ "hostname" : "fsx-fips.us-iso-east-1.c2s.ic.gov", "tags" : [ "fips" ] } ] - } + }, + "us-iso-west-1" : { } } }, "glacier" : { @@ -37263,6 +37359,11 @@ "us-iso-east-1" : { } } }, + "kinesisvideo" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, "kms" : { "endpoints" : { "ProdFips" : { @@ -37356,6 +37457,11 @@ "us-iso-west-1" : { } } }, + "network-firewall" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, "oam" : { "endpoints" : { "us-iso-east-1" : { }, @@ -38411,6 +38517,11 @@ "us-isob-east-1" : { } } }, + "network-firewall" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, "oam" : { "endpoints" : { "us-isob-east-1" : { } @@ -38922,6 +39033,11 @@ "eu-isoe-west-1" : { } } }, + "cloudtrail-data" : { + "endpoints" : { + "eu-isoe-west-1" : { } + } + }, "codedeploy" : { "endpoints" : { "eu-isoe-west-1" : { } @@ -39318,6 +39434,11 @@ "eu-isoe-west-1" : { } } }, + "trustedadvisor" : { + "endpoints" : { + "eu-isoe-west-1" : { } + } + }, "xray" : { "endpoints" : { "eu-isoe-west-1" : { } @@ -39548,6 +39669,7 @@ }, "compute-optimizer" : { "endpoints" : { + "us-isof-east-1" : { }, "us-isof-south-1" : { "credentialScope" : { "region" : "us-isof-south-1" @@ -40156,6 +40278,11 @@ "us-isof-south-1" : { } } }, + "trustedadvisor" : { + "endpoints" : { + "us-isof-south-1" : { } + } + }, "xray" : { "endpoints" : { "us-isof-east-1" : { }, diff --git a/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/partitions.json b/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/partitions.json index 456b07fca67..b346b0be9b9 100644 --- a/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/partitions.json +++ b/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/partitions.json @@ -50,11 +50,14 @@ "ap-southeast-5" : { "description" : "Asia Pacific (Malaysia)" }, + "ap-southeast-6" : { + "description" : "Asia Pacific (New Zealand)" + }, "ap-southeast-7" : { "description" : "Asia Pacific (Thailand)" }, "aws-global" : { - "description" : "AWS Standard global region" + "description" : "aws global region" }, "ca-central-1" : { "description" : "Canada (Central)" @@ -127,7 +130,7 @@ "regionRegex" : "^cn\\-\\w+\\-\\d+$", "regions" : { "aws-cn-global" : { - "description" : "AWS China global region" + "description" : "aws-cn global region" }, "cn-north-1" : { "description" : "China (Beijing)" @@ -137,41 +140,35 @@ } } }, { - "id" : "aws-us-gov", + "id" : "aws-eusc", "outputs" : { - "dnsSuffix" : "amazonaws.com", - "dualStackDnsSuffix" : "api.aws", - "implicitGlobalRegion" : "us-gov-west-1", - "name" : "aws-us-gov", + "dnsSuffix" : "amazonaws.eu", + "dualStackDnsSuffix" : "api.amazonwebservices.eu", + "implicitGlobalRegion" : "eusc-de-east-1", + "name" : "aws-eusc", "supportsDualStack" : true, "supportsFIPS" : true }, - "regionRegex" : "^us\\-gov\\-\\w+\\-\\d+$", + "regionRegex" : "^eusc\\-(de)\\-\\w+\\-\\d+$", "regions" : { - "aws-us-gov-global" : { - "description" : "AWS GovCloud (US) global region" - }, - "us-gov-east-1" : { - "description" : "AWS GovCloud (US-East)" - }, - "us-gov-west-1" : { - "description" : "AWS GovCloud (US-West)" + "eusc-de-east-1" : { + "description" : "EU (Germany)" } } }, { "id" : "aws-iso", "outputs" : { "dnsSuffix" : "c2s.ic.gov", - "dualStackDnsSuffix" : "c2s.ic.gov", + "dualStackDnsSuffix" : "api.aws.ic.gov", "implicitGlobalRegion" : "us-iso-east-1", "name" : "aws-iso", - "supportsDualStack" : false, + "supportsDualStack" : true, "supportsFIPS" : true }, "regionRegex" : "^us\\-iso\\-\\w+\\-\\d+$", "regions" : { "aws-iso-global" : { - "description" : "AWS ISO (US) global region" + "description" : "aws-iso global region" }, "us-iso-east-1" : { "description" : "US ISO East" @@ -184,16 +181,16 @@ "id" : "aws-iso-b", "outputs" : { "dnsSuffix" : "sc2s.sgov.gov", - "dualStackDnsSuffix" : "sc2s.sgov.gov", + "dualStackDnsSuffix" : "api.aws.scloud", "implicitGlobalRegion" : "us-isob-east-1", "name" : "aws-iso-b", - "supportsDualStack" : false, + "supportsDualStack" : true, "supportsFIPS" : true }, "regionRegex" : "^us\\-isob\\-\\w+\\-\\d+$", "regions" : { "aws-iso-b-global" : { - "description" : "AWS ISOB (US) global region" + "description" : "aws-iso-b global region" }, "us-isob-east-1" : { "description" : "US ISOB East (Ohio)" @@ -203,16 +200,16 @@ "id" : "aws-iso-e", "outputs" : { "dnsSuffix" : "cloud.adc-e.uk", - "dualStackDnsSuffix" : "cloud.adc-e.uk", + "dualStackDnsSuffix" : "api.cloud-aws.adc-e.uk", "implicitGlobalRegion" : "eu-isoe-west-1", "name" : "aws-iso-e", - "supportsDualStack" : false, + "supportsDualStack" : true, "supportsFIPS" : true }, "regionRegex" : "^eu\\-isoe\\-\\w+\\-\\d+$", "regions" : { "aws-iso-e-global" : { - "description" : "AWS ISOE (Europe) global region" + "description" : "aws-iso-e global region" }, "eu-isoe-west-1" : { "description" : "EU ISOE West" @@ -222,16 +219,16 @@ "id" : "aws-iso-f", "outputs" : { "dnsSuffix" : "csp.hci.ic.gov", - "dualStackDnsSuffix" : "csp.hci.ic.gov", + "dualStackDnsSuffix" : "api.aws.hci.ic.gov", "implicitGlobalRegion" : "us-isof-south-1", "name" : "aws-iso-f", - "supportsDualStack" : false, + "supportsDualStack" : true, "supportsFIPS" : true }, "regionRegex" : "^us\\-isof\\-\\w+\\-\\d+$", "regions" : { "aws-iso-f-global" : { - "description" : "AWS ISOF global region" + "description" : "aws-iso-f global region" }, "us-isof-east-1" : { "description" : "US ISOF EAST" @@ -241,19 +238,25 @@ } } }, { - "id" : "aws-eusc", + "id" : "aws-us-gov", "outputs" : { - "dnsSuffix" : "amazonaws.eu", - "dualStackDnsSuffix" : "amazonaws.eu", - "implicitGlobalRegion" : "eusc-de-east-1", - "name" : "aws-eusc", - "supportsDualStack" : false, + "dnsSuffix" : "amazonaws.com", + "dualStackDnsSuffix" : "api.aws", + "implicitGlobalRegion" : "us-gov-west-1", + "name" : "aws-us-gov", + "supportsDualStack" : true, "supportsFIPS" : true }, - "regionRegex" : "^eusc\\-(de)\\-\\w+\\-\\d+$", + "regionRegex" : "^us\\-gov\\-\\w+\\-\\d+$", "regions" : { - "eusc-de-east-1" : { - "description" : "EU (Germany)" + "aws-us-gov-global" : { + "description" : "aws-us-gov global region" + }, + "us-gov-east-1" : { + "description" : "AWS GovCloud (US-East)" + }, + "us-gov-west-1" : { + "description" : "AWS GovCloud (US-West)" } } } ], diff --git a/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/EndpointUrlConfigNamesTest.kt b/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/EndpointUrlConfigNamesTest.kt index 52b88caa61d..ef55aaf0add 100644 --- a/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/EndpointUrlConfigNamesTest.kt +++ b/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/EndpointUrlConfigNamesTest.kt @@ -5,7 +5,8 @@ package aws.sdk.kotlin.codegen import kotlinx.serialization.json.* -import kotlin.test.* +import kotlin.test.Test +import kotlin.test.assertEquals class EndpointUrlConfigNamesTest { // these don't appear to exist anymore - we don't have models (and therefore no generated clients) for them @@ -1103,16 +1104,6 @@ private const val TEST_SUITE_JSON = """ "services_section_name": "opensearch", "service_envvar_name": "AWS_ENDPOINT_URL_OPENSEARCH" }, - { - "service_id": "OpsWorks", - "services_section_name": "opsworks", - "service_envvar_name": "AWS_ENDPOINT_URL_OPSWORKS" - }, - { - "service_id": "OpsWorksCM", - "services_section_name": "opsworkscm", - "service_envvar_name": "AWS_ENDPOINT_URL_OPSWORKSCM" - }, { "service_id": "Organizations", "services_section_name": "organizations", @@ -1408,11 +1399,6 @@ private const val TEST_SUITE_JSON = """ "services_section_name": "signer", "service_envvar_name": "AWS_ENDPOINT_URL_SIGNER" }, - { - "service_id": "SMS", - "services_section_name": "sms", - "service_envvar_name": "AWS_ENDPOINT_URL_SMS" - }, { "service_id": "Pinpoint SMS Voice", "services_section_name": "pinpoint_sms_voice", @@ -1672,7 +1658,6 @@ private const val JAVA_CLIENT_NAMES_JSON = """ "Customer Profiles": "CustomerProfilesClient", "DocDB": "DocDbClient", "DAX": "DaxClient", - "OpsWorksCM": "OpsWorksCmClient", "ACM PCA": "AcmPcaClient", "GuardDuty": "GuardDutyClient", "CleanRooms": "CleanRoomsClient", @@ -1725,7 +1710,6 @@ private const val JAVA_CLIENT_NAMES_JSON = """ "ConnectCampaigns": "ConnectCampaignsClient", "Textract": "TextractClient", "Support": "SupportClient", - "OpsWorks": "OpsWorksClient", "identitystore": "IdentitystoreClient", "Kinesis Analytics": "KinesisAnalyticsClient", "Snowball": "SnowballClient", @@ -1860,7 +1844,6 @@ private const val JAVA_CLIENT_NAMES_JSON = """ "MemoryDB": "MemoryDbClient", "Payment Cryptography": "PaymentCryptographyClient", "Cognito Identity": "CognitoIdentityClient", - "SMS": "SmsClient", "OSIS": "OsisClient", "Proton": "ProtonClient", "ECR PUBLIC": "EcrPublicClient", diff --git a/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/ModuleDocumentationIntegrationTest.kt b/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/ModuleDocumentationIntegrationTest.kt index cd288b5782d..bbd3ce3d751 100644 --- a/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/ModuleDocumentationIntegrationTest.kt +++ b/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/ModuleDocumentationIntegrationTest.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.codegen import software.amazon.smithy.build.MockManifest diff --git a/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/endpoints/BindAwsEndpointBuiltinsTest.kt b/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/endpoints/BindAwsEndpointBuiltinsTest.kt index 2fa1877fe52..e1d08153704 100644 --- a/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/endpoints/BindAwsEndpointBuiltinsTest.kt +++ b/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/endpoints/BindAwsEndpointBuiltinsTest.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.codegen.endpoints import software.amazon.smithy.kotlin.codegen.core.KotlinWriter diff --git a/codegen/protocol-tests/build.gradle.kts b/codegen/protocol-tests/build.gradle.kts index 7064d116b31..06b31a2ef6c 100644 --- a/codegen/protocol-tests/build.gradle.kts +++ b/codegen/protocol-tests/build.gradle.kts @@ -73,63 +73,38 @@ dependencies { codegen(libs.smithy.aws.protocol.tests) } -abstract class ProtocolTestTask @Inject constructor(private val project: Project) : DefaultTask() { - /** - * The projection - */ - @get:Input - abstract val projectionName: Property - - /** - * The projection root directory - */ - @get:Input - abstract val projectionRootDirectory: Property - - @TaskAction - fun runTests() { - val projectionRootDir = project.file(projectionRootDirectory.get()) - println("[$projectionName] buildDir: $projectionRootDir") - if (!projectionRootDir.exists()) { - throw GradleException("$projectionRootDir does not exist") - } - val wrapper = if (System.getProperty("os.name").lowercase().contains("windows")) "gradlew.bat" else "gradlew" - val gradlew = project.rootProject.file(wrapper).absolutePath - - // NOTE - this still requires us to publish to maven local. - project.exec { - workingDir = projectionRootDir - executable = gradlew - args = listOf("test") - } - } -} - smithyBuild.projections.forEach { val protocolName = it.name - tasks.register("testProtocol-$protocolName") { - dependsOn(tasks.generateSmithyProjections) - group = "Verification" - projectionName.set(it.name) - projectionRootDirectory.set(smithyBuild.smithyKotlinProjectionPath(it.name).map { it.toString() }) - } + val dirProvider = smithyBuild + .smithyKotlinProjectionPath(protocolName) + .map { file(it.toString()) } - // FIXME This is a hack to work around how protocol tests aren't in the actual service model and thus codegen - // separately from service customizations. val copyStaticFiles = tasks.register("copyStaticFiles-$protocolName") { group = "codegen" from(rootProject.projectDir.resolve("services/$protocolName/common/src")) - into(smithyBuild.smithyKotlinProjectionSrcDir(it.name)) + into(smithyBuild.smithyKotlinProjectionSrcDir(protocolName)) } - tasks.generateSmithyProjections.configure { - finalizedBy(copyStaticFiles) + tasks.register("testProtocol-$protocolName") { + group = "Verification" + dependsOn(tasks.generateSmithyProjections, copyStaticFiles) + + doFirst { + val dir = dirProvider.get() + require(dir.exists()) { "$dir does not exist" } + + val wrapper = if (System.getProperty("os.name").lowercase().contains("windows")) "gradlew.bat" else "gradlew" + val gradlew = rootProject.layout.projectDirectory.file(wrapper).asFile.absolutePath + + workingDir = dir + executable = gradlew + args = listOf("test") + } } } tasks.register("testAllProtocols") { group = "Verification" - val allTests = tasks.withType() - dependsOn(allTests) + dependsOn(tasks.matching { it.name.startsWith("testProtocol-") }) } diff --git a/codegen/sdk/aws-models/accessanalyzer.json b/codegen/sdk/aws-models/accessanalyzer.json index 8649a52fbe6..a3138dabe53 100644 --- a/codegen/sdk/aws-models/accessanalyzer.json +++ b/codegen/sdk/aws-models/accessanalyzer.json @@ -1000,17 +1000,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1024,17 +1013,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1048,17 +1026,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1072,17 +1039,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/account.json b/codegen/sdk/aws-models/account.json index f9c3b29d076..1f856bdb53d 100644 --- a/codegen/sdk/aws-models/account.json +++ b/codegen/sdk/aws-models/account.json @@ -807,17 +807,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -839,17 +828,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -871,17 +849,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -903,17 +870,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -935,17 +891,6 @@ "UseDualStack": false } }, - { - "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": { @@ -967,17 +912,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1000,18 +934,28 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://account-fips.us-isof-south-1.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -1022,43 +966,53 @@ } ] }, - "url": "https://account-fips.us-isof-south-1.csp.hci.ic.gov" + "url": "https://account.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eusc-de-east-1" + } + ] + }, + "url": "https://account-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingRegion": "us-isof-south-1" + "signingRegion": "eusc-de-east-1" } ] }, - "url": "https://account.us-isof-south-1.csp.hci.ic.gov" + "url": "https://account.eusc-de-east-1.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } diff --git a/codegen/sdk/aws-models/acm-pca.json b/codegen/sdk/aws-models/acm-pca.json index da7199946c7..7b65e572250 100644 --- a/codegen/sdk/aws-models/acm-pca.json +++ b/codegen/sdk/aws-models/acm-pca.json @@ -937,17 +937,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -961,17 +950,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -985,17 +963,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1009,17 +976,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/acm.json b/codegen/sdk/aws-models/acm.json index 01d40010437..db464212495 100644 --- a/codegen/sdk/aws-models/acm.json +++ b/codegen/sdk/aws-models/acm.json @@ -1239,17 +1239,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1263,17 +1252,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1287,17 +1265,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1311,17 +1278,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/aiops.json b/codegen/sdk/aws-models/aiops.json index 58ee00123dc..3330a604df8 100644 --- a/codegen/sdk/aws-models/aiops.json +++ b/codegen/sdk/aws-models/aiops.json @@ -568,17 +568,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -592,17 +581,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -616,17 +594,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -640,17 +607,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/amp.json b/codegen/sdk/aws-models/amp.json index 538119ad39a..28e977067cb 100644 --- a/codegen/sdk/aws-models/amp.json +++ b/codegen/sdk/aws-models/amp.json @@ -794,17 +794,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -818,17 +807,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -842,17 +820,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -866,17 +833,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -992,6 +948,20 @@ "smithy.api#pattern": "^arn:aws[-a-z]*:eks:[-a-z0-9]+:[0-9]{12}:cluster/.+$" } }, + "com.amazonaws.amp#ComponentConfig": { + "type": "structure", + "members": { + "options": { + "target": "com.amazonaws.amp#StringMap", + "traits": { + "smithy.api#documentation": "

Configuration options for the scraper component.

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

Configuration settings for a scraper component.

" + } + }, "com.amazonaws.amp#ConflictException": { "type": "structure", "members": { @@ -1847,6 +1817,75 @@ "smithy.api#input": {} } }, + "com.amazonaws.amp#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.amp#DeleteResourcePolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.amp#AccessDeniedException" + }, + { + "target": "com.amazonaws.amp#ConflictException" + }, + { + "target": "com.amazonaws.amp#InternalServerException" + }, + { + "target": "com.amazonaws.amp#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.amp#ThrottlingException" + }, + { + "target": "com.amazonaws.amp#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the resource-based policy attached to an Amazon Managed Service for Prometheus workspace.

", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/workspaces/{workspaceId}/policy" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.amp#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.amp#WorkspaceId", + "traits": { + "smithy.api#documentation": "

The ID of the workspace from which to delete the resource-based policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.amp#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the request is safe to retry (idempotent).

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + }, + "revisionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The revision ID of the policy to delete. Use this parameter to ensure that you are deleting the correct version of the policy.

", + "smithy.api#httpQuery": "revisionId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.amp#DeleteRuleGroupsNamespace": { "type": "operation", "input": { @@ -1970,6 +2009,65 @@ "smithy.api#idempotent": {} } }, + "com.amazonaws.amp#DeleteScraperLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.amp#DeleteScraperLoggingConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.amp#AccessDeniedException" + }, + { + "target": "com.amazonaws.amp#ConflictException" + }, + { + "target": "com.amazonaws.amp#InternalServerException" + }, + { + "target": "com.amazonaws.amp#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.amp#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the logging configuration for a Amazon Managed Service for Prometheus scraper.

", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/scrapers/{scraperId}/logging-configuration" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.amp#DeleteScraperLoggingConfigurationRequest": { + "type": "structure", + "members": { + "scraperId": { + "target": "com.amazonaws.amp#ScraperId", + "traits": { + "smithy.api#documentation": "

The ID of the scraper whose logging configuration will be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.amp#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the request is processed exactly once.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.amp#DeleteScraperRequest": { "type": "structure", "members": { @@ -2272,6 +2370,86 @@ "smithy.api#output": {} } }, + "com.amazonaws.amp#DescribeResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.amp#DescribeResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.amp#DescribeResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amp#AccessDeniedException" + }, + { + "target": "com.amazonaws.amp#InternalServerException" + }, + { + "target": "com.amazonaws.amp#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.amp#ThrottlingException" + }, + { + "target": "com.amazonaws.amp#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the resource-based policy attached to an Amazon Managed Service for Prometheus workspace.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/workspaces/{workspaceId}/policy" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.amp#DescribeResourcePolicyRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.amp#WorkspaceId", + "traits": { + "smithy.api#documentation": "

The ID of the workspace to describe the resource-based policy for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.amp#DescribeResourcePolicyResponse": { + "type": "structure", + "members": { + "policyDocument": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The JSON policy document for the resource-based policy attached to the workspace.

", + "smithy.api#required": {} + } + }, + "policyStatus": { + "target": "com.amazonaws.amp#WorkspacePolicyStatusCode", + "traits": { + "smithy.api#documentation": "

The current status of the resource-based policy.

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

The revision ID of the current resource-based policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.amp#DescribeRuleGroupsNamespace": { "type": "operation", "input": { @@ -2472,6 +2650,97 @@ } } }, + "com.amazonaws.amp#DescribeScraperLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.amp#DescribeScraperLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.amp#DescribeScraperLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amp#AccessDeniedException" + }, + { + "target": "com.amazonaws.amp#InternalServerException" + }, + { + "target": "com.amazonaws.amp#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.amp#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the logging configuration for a Amazon Managed Service for Prometheus scraper.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/scrapers/{scraperId}/logging-configuration" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.amp#DescribeScraperLoggingConfigurationRequest": { + "type": "structure", + "members": { + "scraperId": { + "target": "com.amazonaws.amp#ScraperId", + "traits": { + "smithy.api#documentation": "

The ID of the scraper whose logging configuration will be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.amp#DescribeScraperLoggingConfigurationResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.amp#ScraperLoggingConfigurationStatus", + "traits": { + "smithy.api#documentation": "

The status of the scraper logging configuration.

", + "smithy.api#required": {} + } + }, + "scraperId": { + "target": "com.amazonaws.amp#ScraperId", + "traits": { + "smithy.api#documentation": "

The ID of the scraper.

", + "smithy.api#required": {} + } + }, + "loggingDestination": { + "target": "com.amazonaws.amp#ScraperLoggingDestination", + "traits": { + "smithy.api#documentation": "

The destination where scraper logs are sent.

", + "smithy.api#required": {} + } + }, + "scraperComponents": { + "target": "com.amazonaws.amp#ScraperComponents", + "traits": { + "smithy.api#documentation": "

The list of scraper components configured for logging.

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

The date and time when the logging configuration was last modified.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.amp#DescribeScraperRequest": { "type": "structure", "members": { @@ -3439,7 +3708,7 @@ "aws.api#arnReference": { "type": "AWS::Logs::LogGroup" }, - "smithy.api#pattern": "^arn:aws[-a-z]*:logs:[-a-z0-9]+:[0-9]{12}:log-group:[A-Za-z0-9\\.\\-\\_\\#/]{1,512}\\:\\*$" + "smithy.api#pattern": "^arn:aws[a-z0-9-]*:logs:[a-z0-9-]+:[0-9]{12}:log-group:[A-Za-z0-9\\.\\-\\_\\#/]{1,512}\\:\\*$" } }, "com.amazonaws.amp#LoggingConfiguration": { @@ -3654,7 +3923,90 @@ "target": "com.amazonaws.amp#ResourceNotFoundException" }, { - "target": "com.amazonaws.amp#ServiceQuotaExceededException" + "target": "com.amazonaws.amp#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.amp#ThrottlingException" + }, + { + "target": "com.amazonaws.amp#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use CreateAlertManagerDefinition.

", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/workspaces/{workspaceId}/alertmanager/definition" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.amp#PutAlertManagerDefinitionRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.amp#WorkspaceId", + "traits": { + "smithy.api#documentation": "

The ID of the workspace to update the alert manager definition in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.amp#AlertManagerDefinitionData", + "traits": { + "smithy.api#documentation": "

The alert manager definition to use. A base64-encoded version of the YAML alert manager definition file.

For details about the alert manager definition, see AlertManagedDefinitionData.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.amp#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

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

Represents the input of a PutAlertManagerDefinition operation.

" + } + }, + "com.amazonaws.amp#PutAlertManagerDefinitionResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.amp#AlertManagerDefinitionStatus", + "traits": { + "smithy.api#documentation": "

A structure that returns the current status of the alert manager definition.

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

Represents the output of a PutAlertManagerDefinition operation.

" + } + }, + "com.amazonaws.amp#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.amp#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.amp#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amp#AccessDeniedException" + }, + { + "target": "com.amazonaws.amp#ConflictException" + }, + { + "target": "com.amazonaws.amp#InternalServerException" + }, + { + "target": "com.amazonaws.amp#ResourceNotFoundException" }, { "target": "com.amazonaws.amp#ThrottlingException" @@ -3664,58 +4016,71 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use CreateAlertManagerDefinition.

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

Creates or updates a resource-based policy for an Amazon Managed Service for Prometheus workspace. Use resource-based policies to grant permissions to other AWS accounts or services to access your workspace.

Only Prometheus-compatible APIs can be used for workspace sharing. You can add non-Prometheus-compatible APIs to the policy, but they will be ignored. For more information, see Prometheus-compatible APIs in the Amazon Managed Service for Prometheus User Guide.

If your workspace uses customer-managed KMS keys for encryption, you must grant the principals in your resource-based policy access to those KMS keys. You can do this by creating KMS grants. For more information, see CreateGrant in the AWS Key Management Service API Reference and Encryption at rest in the Amazon Managed Service for Prometheus User Guide.

For more information about working with IAM, see Using Amazon Managed Service for Prometheus with IAM in the Amazon Managed Service for Prometheus User Guide.

", "smithy.api#http": { "code": 202, "method": "PUT", - "uri": "/workspaces/{workspaceId}/alertmanager/definition" + "uri": "/workspaces/{workspaceId}/policy" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.amp#PutAlertManagerDefinitionRequest": { + "com.amazonaws.amp#PutResourcePolicyRequest": { "type": "structure", "members": { "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "

The ID of the workspace to update the alert manager definition in.

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

The ID of the workspace to attach the resource-based policy to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "data": { - "target": "com.amazonaws.amp#AlertManagerDefinitionData", + "policyDocument": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The alert manager definition to use. A base64-encoded version of the YAML alert manager definition file.

For details about the alert manager definition, see AlertManagedDefinitionData.

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

The JSON policy document to use as the resource-based policy. This policy defines the permissions that other AWS accounts or services have to access your workspace.

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

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

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

A unique, case-sensitive identifier that you provide to ensure the request is safe to retry (idempotent).

", "smithy.api#idempotencyToken": {} } + }, + "revisionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The revision ID of the policy to update. Use this parameter to ensure that you are updating the correct version of the policy. If you don't specify a revision ID, the policy is updated regardless of its current revision.

For the first PUT request on a workspace that doesn't have an existing resource policy, you can specify NO_POLICY as the revision ID.

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

Represents the input of a PutAlertManagerDefinition operation.

" + "smithy.api#input": {} } }, - "com.amazonaws.amp#PutAlertManagerDefinitionResponse": { + "com.amazonaws.amp#PutResourcePolicyResponse": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.amp#AlertManagerDefinitionStatus", + "policyStatus": { + "target": "com.amazonaws.amp#WorkspacePolicyStatusCode", "traits": { - "smithy.api#documentation": "

A structure that returns the current status of the alert manager definition.

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

The current status of the resource-based policy.

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

The revision ID of the newly created or updated resource-based policy.

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

Represents the output of a PutAlertManagerDefinition operation.

" + "smithy.api#output": {} } }, "com.amazonaws.amp#PutRuleGroupsNamespace": { @@ -4120,7 +4485,7 @@ "smithy.api#documentation": "

The name of the namespace that the rule group belong to.

", "smithy.api#length": { "min": 1, - "max": 64 + "max": 128 }, "smithy.api#pattern": "[0-9A-Za-z][-.0-9A-Z_a-z]*" } @@ -4278,6 +4643,11 @@ "list": { "target": "com.amazonaws.amp#ListScrapers" }, + "resources": [ + { + "target": "com.amazonaws.amp#ScraperLoggingConfiguration" + } + ], "traits": { "aws.api#arn": { "template": "scraper/{scraperId}" @@ -4307,6 +4677,61 @@ "smithy.api#documentation": "

An ARN identifying a scrape configuration.

" } }, + "com.amazonaws.amp#ScraperComponent": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.amp#ScraperComponentType", + "traits": { + "smithy.api#documentation": "

The type of the scraper component.

", + "smithy.api#required": {} + } + }, + "config": { + "target": "com.amazonaws.amp#ComponentConfig", + "traits": { + "smithy.api#documentation": "

The configuration settings for the scraper component.

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

A component of a Amazon Managed Service for Prometheus scraper that can be configured for logging.

" + } + }, + "com.amazonaws.amp#ScraperComponentType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SERVICE_DISCOVERY", + "value": "SERVICE_DISCOVERY", + "documentation": "Scraper service discoverer component" + }, + { + "name": "COLLECTOR", + "value": "COLLECTOR", + "documentation": "Scraper collector component" + }, + { + "name": "EXPORTER", + "value": "EXPORTER", + "documentation": "Scraper exporter component" + } + ] + } + }, + "com.amazonaws.amp#ScraperComponents": { + "type": "list", + "member": { + "target": "com.amazonaws.amp#ScraperComponent" + }, + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.amp#ScraperDescription": { "type": "structure", "members": { @@ -4440,6 +4865,103 @@ "smithy.api#pattern": "^[0-9A-Za-z][-.0-9A-Z_a-z]*$" } }, + "com.amazonaws.amp#ScraperLoggingConfiguration": { + "type": "resource", + "identifiers": { + "scraperId": { + "target": "com.amazonaws.amp#ScraperId" + } + }, + "put": { + "target": "com.amazonaws.amp#UpdateScraperLoggingConfiguration" + }, + "read": { + "target": "com.amazonaws.amp#DescribeScraperLoggingConfiguration" + }, + "update": { + "target": "com.amazonaws.amp#UpdateScraperLoggingConfiguration" + }, + "delete": { + "target": "com.amazonaws.amp#DeleteScraperLoggingConfiguration" + }, + "traits": { + "aws.api#arn": { + "template": "scraper/{scraperId}" + } + } + }, + "com.amazonaws.amp#ScraperLoggingConfigurationStatus": { + "type": "structure", + "members": { + "statusCode": { + "target": "com.amazonaws.amp#ScraperLoggingConfigurationStatusCode", + "traits": { + "smithy.api#documentation": "

The status code of the scraper logging configuration.

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

The reason for the current status of the scraper logging configuration.

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

The status of a scraper logging configuration.

" + } + }, + "com.amazonaws.amp#ScraperLoggingConfigurationStatusCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CREATING", + "value": "CREATING", + "documentation": "Scraper logging configuration is being created." + }, + { + "name": "ACTIVE", + "value": "ACTIVE", + "documentation": "Scraper logging configuration is active." + }, + { + "name": "UPDATING", + "value": "UPDATING", + "documentation": "Scraper logging configuration is being updated." + }, + { + "name": "DELETING", + "value": "DELETING", + "documentation": "Scraper logging configuration is being deleted." + }, + { + "name": "CREATION_FAILED", + "value": "CREATION_FAILED", + "documentation": "Scraper logging configuration creation failed." + }, + { + "name": "UPDATE_FAILED", + "value": "UPDATE_FAILED", + "documentation": "Scraper logging configuration update failed." + } + ] + } + }, + "com.amazonaws.amp#ScraperLoggingDestination": { + "type": "union", + "members": { + "cloudWatchLogs": { + "target": "com.amazonaws.amp#CloudWatchLogDestination", + "traits": { + "smithy.api#documentation": "

The CloudWatch Logs configuration for the scraper logging destination.

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

The destination where scraper logs are sent.

" + } + }, "com.amazonaws.amp#ScraperStatus": { "type": "structure", "members": { @@ -4693,6 +5215,15 @@ } } }, + "com.amazonaws.amp#StringMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, "com.amazonaws.amp#SubnetId": { "type": "string", "traits": { @@ -5146,6 +5677,85 @@ "smithy.api#idempotent": {} } }, + "com.amazonaws.amp#UpdateScraperLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.amp#UpdateScraperLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.amp#UpdateScraperLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amp#AccessDeniedException" + }, + { + "target": "com.amazonaws.amp#ConflictException" + }, + { + "target": "com.amazonaws.amp#InternalServerException" + }, + { + "target": "com.amazonaws.amp#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.amp#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the logging configuration for a Amazon Managed Service for Prometheus scraper.

", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/scrapers/{scraperId}/logging-configuration" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.amp#UpdateScraperLoggingConfigurationRequest": { + "type": "structure", + "members": { + "scraperId": { + "target": "com.amazonaws.amp#ScraperId", + "traits": { + "smithy.api#documentation": "

The ID of the scraper whose logging configuration will be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "loggingDestination": { + "target": "com.amazonaws.amp#ScraperLoggingDestination", + "traits": { + "smithy.api#documentation": "

The destination where scraper logs will be sent.

", + "smithy.api#required": {} + } + }, + "scraperComponents": { + "target": "com.amazonaws.amp#ScraperComponents", + "traits": { + "smithy.api#documentation": "

The list of scraper components to configure for logging.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.amp#UpdateScraperLoggingConfigurationResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.amp#ScraperLoggingConfigurationStatus", + "traits": { + "smithy.api#documentation": "

The status of the updated scraper logging configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.amp#UpdateScraperRequest": { "type": "structure", "members": { @@ -5523,6 +6133,9 @@ }, { "target": "com.amazonaws.amp#WorkspaceConfiguration" + }, + { + "target": "com.amazonaws.amp#WorkspaceResourcePolicy" } ], "traits": { @@ -5722,6 +6335,55 @@ "smithy.api#pattern": "[0-9A-Za-z][-.0-9A-Z_a-z]*" } }, + "com.amazonaws.amp#WorkspacePolicyStatusCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CREATING", + "value": "CREATING", + "documentation": "Resource-based Policy is being created. Update/Deletion is disallowed until Resource-based Policy is ACTIVE and Workspace is ACTIVE." + }, + { + "name": "ACTIVE", + "value": "ACTIVE", + "documentation": "Resource-based Policy has been created/updated. Update/Deletion is disallowed until Resource-based Policy is ACTIVE and Workspace is ACTIVE." + }, + { + "name": "UPDATING", + "value": "UPDATING", + "documentation": "Resource-based Policy is being updated. Update/Deletion is disallowed until Resource-based Policy is ACTIVE and Workspace is ACTIVE." + }, + { + "name": "DELETING", + "value": "DELETING", + "documentation": "Resource-based Policy is being deleting. Update/Deletion is disallowed until Resource-based Policy is ACTIVE and Workspace is ACTIVE." + } + ] + } + }, + "com.amazonaws.amp#WorkspaceResourcePolicy": { + "type": "resource", + "identifiers": { + "workspaceId": { + "target": "com.amazonaws.amp#WorkspaceId" + } + }, + "put": { + "target": "com.amazonaws.amp#PutResourcePolicy" + }, + "read": { + "target": "com.amazonaws.amp#DescribeResourcePolicy" + }, + "delete": { + "target": "com.amazonaws.amp#DeleteResourcePolicy" + }, + "traits": { + "aws.api#arn": { + "template": "workspace/{workspaceId}" + } + } + }, "com.amazonaws.amp#WorkspaceStatus": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/amplify.json b/codegen/sdk/aws-models/amplify.json index 61729b6597c..fdca598a9f1 100644 --- a/codegen/sdk/aws-models/amplify.json +++ b/codegen/sdk/aws-models/amplify.json @@ -888,17 +888,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -912,17 +901,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -936,17 +914,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -960,17 +927,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/amplifybackend.json b/codegen/sdk/aws-models/amplifybackend.json index 91612b1b419..c74260853dc 100644 --- a/codegen/sdk/aws-models/amplifybackend.json +++ b/codegen/sdk/aws-models/amplifybackend.json @@ -850,17 +850,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -874,17 +863,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -898,17 +876,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -922,17 +889,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/amplifyuibuilder.json b/codegen/sdk/aws-models/amplifyuibuilder.json index cf17284237f..ec867b72707 100644 --- a/codegen/sdk/aws-models/amplifyuibuilder.json +++ b/codegen/sdk/aws-models/amplifyuibuilder.json @@ -823,17 +823,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -847,17 +836,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -871,17 +849,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -895,17 +862,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/api-gateway.json b/codegen/sdk/aws-models/api-gateway.json index dd4dd7a3b3d..cc4108c3e09 100644 --- a/codegen/sdk/aws-models/api-gateway.json +++ b/codegen/sdk/aws-models/api-gateway.json @@ -1542,17 +1542,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1566,28 +1555,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1601,17 +1568,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/apigatewaymanagementapi.json b/codegen/sdk/aws-models/apigatewaymanagementapi.json index 3646cbff674..e873426ce40 100644 --- a/codegen/sdk/aws-models/apigatewaymanagementapi.json +++ b/codegen/sdk/aws-models/apigatewaymanagementapi.json @@ -55,6 +55,9 @@ "name": "execute-api" }, "aws.protocols#restJson1": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], "smithy.api#documentation": "

The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.

", "smithy.api#title": "AmazonApiGatewayManagementApi", "smithy.rules#endpointRuleSet": { @@ -529,17 +532,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -553,17 +545,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -577,17 +558,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -601,17 +571,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/apigatewayv2.json b/codegen/sdk/aws-models/apigatewayv2.json index 0549e10588f..1da04fbf82c 100644 --- a/codegen/sdk/aws-models/apigatewayv2.json +++ b/codegen/sdk/aws-models/apigatewayv2.json @@ -1223,17 +1223,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1247,28 +1236,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1282,17 +1249,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/app-mesh.json b/codegen/sdk/aws-models/app-mesh.json index e52e251101a..fd676fb8518 100644 --- a/codegen/sdk/aws-models/app-mesh.json +++ b/codegen/sdk/aws-models/app-mesh.json @@ -1049,17 +1049,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1073,17 +1062,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1097,17 +1075,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1121,17 +1088,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/appconfig.json b/codegen/sdk/aws-models/appconfig.json index 8df48fc6b55..eb03a6e3408 100644 --- a/codegen/sdk/aws-models/appconfig.json +++ b/codegen/sdk/aws-models/appconfig.json @@ -1210,17 +1210,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1234,17 +1223,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1258,17 +1236,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1282,17 +1249,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/appconfigdata.json b/codegen/sdk/aws-models/appconfigdata.json index 2cef363441d..d943bb498ac 100644 --- a/codegen/sdk/aws-models/appconfigdata.json +++ b/codegen/sdk/aws-models/appconfigdata.json @@ -825,17 +825,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -849,17 +838,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -873,17 +851,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -897,17 +864,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/appfabric.json b/codegen/sdk/aws-models/appfabric.json index e989ea6b05e..a4add97d4e6 100644 --- a/codegen/sdk/aws-models/appfabric.json +++ b/codegen/sdk/aws-models/appfabric.json @@ -1837,17 +1837,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1861,17 +1850,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1885,17 +1863,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1909,17 +1876,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/appflow.json b/codegen/sdk/aws-models/appflow.json index b905e855324..746b33835cd 100644 --- a/codegen/sdk/aws-models/appflow.json +++ b/codegen/sdk/aws-models/appflow.json @@ -8818,17 +8818,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -8842,17 +8831,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -8866,17 +8844,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -8890,17 +8857,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/appintegrations.json b/codegen/sdk/aws-models/appintegrations.json index 023b92dcacc..723e8b38430 100644 --- a/codegen/sdk/aws-models/appintegrations.json +++ b/codegen/sdk/aws-models/appintegrations.json @@ -719,17 +719,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -743,17 +732,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -767,17 +745,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -791,17 +758,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/application-auto-scaling.json b/codegen/sdk/aws-models/application-auto-scaling.json index 52fe443880f..bb1154cd4bb 100644 --- a/codegen/sdk/aws-models/application-auto-scaling.json +++ b/codegen/sdk/aws-models/application-auto-scaling.json @@ -987,17 +987,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1011,17 +1000,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1035,17 +1013,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1059,17 +1026,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/application-discovery-service.json b/codegen/sdk/aws-models/application-discovery-service.json index 4de2578aca6..1d1a2e6793b 100644 --- a/codegen/sdk/aws-models/application-discovery-service.json +++ b/codegen/sdk/aws-models/application-discovery-service.json @@ -686,17 +686,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -710,17 +699,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -734,17 +712,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -758,17 +725,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/application-insights.json b/codegen/sdk/aws-models/application-insights.json index ff150f6a66e..a1dab77f69e 100644 --- a/codegen/sdk/aws-models/application-insights.json +++ b/codegen/sdk/aws-models/application-insights.json @@ -2474,17 +2474,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2498,17 +2487,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2522,17 +2500,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2546,17 +2513,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/application-signals.json b/codegen/sdk/aws-models/application-signals.json index e46cc1dbf40..50466220594 100644 --- a/codegen/sdk/aws-models/application-signals.json +++ b/codegen/sdk/aws-models/application-signals.json @@ -46,9 +46,18 @@ { "target": "com.amazonaws.applicationsignals#BatchUpdateExclusionWindows" }, + { + "target": "com.amazonaws.applicationsignals#DeleteGroupingConfiguration" + }, { "target": "com.amazonaws.applicationsignals#GetService" }, + { + "target": "com.amazonaws.applicationsignals#ListAuditFindings" + }, + { + "target": "com.amazonaws.applicationsignals#ListGroupingAttributeDefinitions" + }, { "target": "com.amazonaws.applicationsignals#ListServiceDependencies" }, @@ -64,9 +73,15 @@ { "target": "com.amazonaws.applicationsignals#ListServices" }, + { + "target": "com.amazonaws.applicationsignals#ListServiceStates" + }, { "target": "com.amazonaws.applicationsignals#ListTagsForResource" }, + { + "target": "com.amazonaws.applicationsignals#PutGroupingConfiguration" + }, { "target": "com.amazonaws.applicationsignals#StartDiscovery" }, @@ -94,7 +109,7 @@ "aws.endpoints#dualStackOnlyEndpoints": {}, "aws.endpoints#standardRegionalEndpoints": {}, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications. \n It enables real-time service health dashboards and helps you track long-term performance trends against your business goals. \n The application-centric view provides you with unified visibility across your applications, services, and \n dependencies, so you can proactively monitor and efficiently triage any issues that may arise, \n ensuring optimal customer experience.

\n

Application Signals provides the following benefits:

\n
    \n
  • \n

    Automatically collect metrics and traces from your applications, and display key metrics such as call volume, availability, latency, faults, and errors.

    \n
  • \n
  • \n

    Create and monitor service level objectives (SLOs).

    \n
  • \n
  • \n

    See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity.

    \n
  • \n
\n

Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, and Amazon Web Services Service Catalog AppRegistry, to display your client pages, Synthetics canaries, \n and application names within dashboards and maps.

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

Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications. It enables real-time service health dashboards and helps you track long-term performance trends against your business goals. The application-centric view provides you with unified visibility across your applications, services, and dependencies, so you can proactively monitor and efficiently triage any issues that may arise, ensuring optimal customer experience.

Application Signals provides the following benefits:

  • Automatically collect metrics and traces from your applications, and display key metrics such as call volume, availability, latency, faults, and errors.

  • Create and monitor service level objectives (SLOs).

  • See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity.

Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, and Amazon Web Services Service Catalog AppRegistry, to display your client pages, Synthetics canaries, and application names within dashboards and maps.

", "smithy.api#title": "Amazon CloudWatch Application Signals", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -329,102 +344,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://application-signals-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://application-signals.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://application-signals-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://application-signals.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://application-signals-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://application-signals.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://application-signals-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://application-signals.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { @@ -442,6 +361,62 @@ "com.amazonaws.applicationsignals#AttainmentGoal": { "type": "double" }, + "com.amazonaws.applicationsignals#AttributeFilter": { + "type": "structure", + "members": { + "AttributeFilterName": { + "target": "com.amazonaws.applicationsignals#AttributeFilterName", + "traits": { + "smithy.api#documentation": "

The name of the attribute to filter by, such as Platform, Environment, or BusinessUnit.

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

An array of values to match for the specified attribute. Services that have any of these values for the attribute will be included in the results.

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

A structure that defines a filter for narrowing down results based on specific attribute values. This can be used to filter services by platform, environment, or other service characteristics.

" + } + }, + "com.amazonaws.applicationsignals#AttributeFilterName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9 :/-]+$" + } + }, + "com.amazonaws.applicationsignals#AttributeFilterValue": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9 :/-]+$" + } + }, + "com.amazonaws.applicationsignals#AttributeFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#AttributeFilterValue" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.applicationsignals#AttributeFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#AttributeFilter" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, "com.amazonaws.applicationsignals#AttributeMap": { "type": "map", "key": { @@ -472,6 +447,168 @@ } } }, + "com.amazonaws.applicationsignals#AuditFinding": { + "type": "structure", + "members": { + "KeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

The key attributes that identify the service or entity this audit finding relates to. This is a string-to-string map that includes fields like Type, Name, and Environment.

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

An array of auditor results that contain the specific findings, descriptions, and severity levels identified by different auditing algorithms.

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

The name of the operation associated with this audit finding, if the finding is specific to a particular service operation.

" + } + }, + "MetricGraph": { + "target": "com.amazonaws.applicationsignals#MetricGraph", + "traits": { + "smithy.api#documentation": "

A structure containing metric data queries and time range information that provides context for the audit finding through relevant performance metrics.

" + } + }, + "DependencyGraph": { + "target": "com.amazonaws.applicationsignals#DependencyGraph", + "traits": { + "smithy.api#documentation": "

A structure containing nodes and edges that represent the dependency relationships relevant to this audit finding, helping to understand the context and potential impact.

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

The type of audit finding.

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

A structure that contains information about an audit finding, which represents an automated analysis result about service behavior, performance issues, or potential problems identified through heuristic algorithms.

" + } + }, + "com.amazonaws.applicationsignals#AuditFindings": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#AuditFinding" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.applicationsignals#AuditTarget": { + "type": "structure", + "members": { + "Type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of entity being audited, such as Service, SLO, or ServiceOperation.

", + "smithy.api#required": {} + } + }, + "Data": { + "target": "com.amazonaws.applicationsignals#AuditTargetEntity", + "traits": { + "smithy.api#documentation": "

The specific data identifying the audit target entity.

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

A structure that specifies the target entity for audit analysis, such as a service, SLO, or service_operation.

" + } + }, + "com.amazonaws.applicationsignals#AuditTargetEntity": { + "type": "union", + "members": { + "Service": { + "target": "com.amazonaws.applicationsignals#ServiceEntity", + "traits": { + "smithy.api#documentation": "

Service entity information when the audit target is a service.

" + } + }, + "Slo": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveEntity", + "traits": { + "smithy.api#documentation": "

SLO entity information when the audit target is a service level objective.

" + } + }, + "ServiceOperation": { + "target": "com.amazonaws.applicationsignals#ServiceOperationEntity", + "traits": { + "smithy.api#documentation": "

Service operation entity information when the audit target is a specific service operation.

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

A union structure that contains the specific entity information for different types of audit targets.

" + } + }, + "com.amazonaws.applicationsignals#AuditTargets": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#AuditTarget" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.applicationsignals#AuditorResult": { + "type": "structure", + "members": { + "Auditor": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the auditor algorithm that generated this result.

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

A detailed description of the audit finding, explaining what was observed and potential implications.

", + "smithy.api#length": { + "max": 10240 + } + } + }, + "Severity": { + "target": "com.amazonaws.applicationsignals#Severity", + "traits": { + "smithy.api#documentation": "

The severity level of this audit finding, indicating the importance and potential impact of the issue.

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

A structure that contains the result of an automated audit analysis, including the auditor name, description of findings, and severity level.

" + } + }, + "com.amazonaws.applicationsignals#AuditorResults": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#AuditorResult" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.applicationsignals#Auditors": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, "com.amazonaws.applicationsignals#AwsAccountId": { "type": "string", "traits": { @@ -495,7 +632,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use this operation to retrieve one or more service level objective (SLO) budget reports.

\n

An error budget is the amount of time or requests in an unhealthy state that your service can \n accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be\n unmet. For example, an SLO with a threshold of 99.95% and a monthly interval\n translates to an error budget of 21.9 minutes of \n downtime in a 30-day month.

\n

Budget reports include a health indicator, the attainment value, and \n remaining budget.

\n

For more information about SLO error budgets, see \n \n SLO concepts.

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

Use this operation to retrieve one or more service level objective (SLO) budget reports.

An error budget is the amount of time or requests in an unhealthy state that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. For example, an SLO with a threshold of 99.95% and a monthly interval translates to an error budget of 21.9 minutes of downtime in a 30-day month.

Budget reports include a health indicator, the attainment value, and remaining budget.

For more information about SLO error budgets, see SLO concepts.

", "smithy.api#http": { "method": "POST", "uri": "/budget-report", @@ -545,7 +682,7 @@ "Errors": { "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetReportErrors", "traits": { - "smithy.api#documentation": "

An array of structures, where each structure includes an error indicating that one \n of the requests in the array was not valid.

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

An array of structures, where each structure includes an error indicating that one of the requests in the array was not valid.

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

This object defines the length of the look-back window used to calculate one burn rate metric\n for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO. A burn rate of\n exactly 1 indicates that the SLO goal will be met exactly.

\n

For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:

\n

\n burn rate = error rate over the look-back window / (100% - attainment goal percentage)\n

\n

For more information about burn rates, see Calculate burn rates.

" + "smithy.api#documentation": "

This object defines the length of the look-back window used to calculate one burn rate metric for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO. A burn rate of exactly 1 indicates that the SLO goal will be met exactly.

For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:

burn rate = error rate over the look-back window / (100% - attainment goal percentage)

For more information about burn rates, see Calculate burn rates.

" } }, "com.amazonaws.applicationsignals#BurnRateConfigurations": { @@ -718,7 +855,7 @@ "StartTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time when you want the first interval to start. Be sure to choose a time that configures the \n intervals the way that you want. For example, if you want weekly intervals\n starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.

\n

When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

As soon as one calendar interval ends, another automatically begins.

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

The date and time when you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.

When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

As soon as one calendar interval ends, another automatically begins.

", "smithy.api#required": {} } }, @@ -732,7 +869,7 @@ "Duration": { "target": "com.amazonaws.applicationsignals#CalendarIntervalDuration", "traits": { - "smithy.api#documentation": "

Specifies the duration of each calendar interval. For example, if Duration is 1 and\n DurationUnit is MONTH, each interval is one month, aligned with the calendar.

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

Specifies the duration of each calendar interval. For example, if Duration is 1 and DurationUnit is MONTH, each interval is one month, aligned with the calendar.

", "smithy.api#required": {} } } @@ -749,22 +886,112 @@ } } }, - "com.amazonaws.applicationsignals#ConflictException": { + "com.amazonaws.applicationsignals#ChangeEvent": { "type": "structure", "members": { - "Message": { + "Timestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.

", + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.applicationsignals#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID where this change event occurred.

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

The Amazon Web Services region where this change event occurred.

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

This operation attempted to create a resource that already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, + }, + "Entity": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

The entity (service or resource) that was affected by this change event, including its key attributes.

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

The type of change event that occurred, such as DEPLOYMENT.

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

A unique identifier for this change event.

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

The name of the user who initiated this change event, if available.

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

The name or description of this change event.

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

A structure that contains information about a change event that occurred for a service, such as a deployment or configuration change.

" + } + }, + "com.amazonaws.applicationsignals#ChangeEventType": { + "type": "enum", + "members": { + "DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYMENT" + } + } + } + }, + "com.amazonaws.applicationsignals#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

This operation attempted to create a resource that already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.applicationsignals#ConnectionType": { + "type": "enum", + "members": { + "INDIRECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INDIRECT" + } + }, + "DIRECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT" + } + } + } + }, "com.amazonaws.applicationsignals#CreateServiceLevelObjective": { "type": "operation", "input": { @@ -791,7 +1018,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a service level objective (SLO), which can help you ensure that your critical business operations are \n meeting customer expectations. Use SLOs to set and track specific target levels for the\n reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to \n calculate whether the application is performing at the level that you want.

\n

Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch\n measures this target frequently you can find whether it has been breached.

\n

The target performance quality that is defined for an SLO is the attainment goal.

\n

You can set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability. \n You can also set SLOs against any CloudWatch metric or math expression that produces a time series.

\n \n

You can't create an SLO for a service operation that was discovered by Application Signals until after that operation has reported standard\n metrics to Application Signals.

\n
\n

When you create an SLO, you specify whether it is a period-based SLO\n or a request-based SLO. Each type of SLO has a different way of evaluating \n your application's performance against its attainment goal.

\n
    \n
  • \n

    A period-based SLO uses defined periods of time within \n a specified total time interval. For each period of time, Application Signals determines whether the \n application met its goal. The attainment rate is calculated as the number of good periods/number of total periods.

    \n

    For example, for a period-based SLO, meeting an attainment goal of 99.9% means that within your interval, your application must meet its\n performance goal during at least 99.9% of the \n time periods.

    \n
  • \n
  • \n

    A request-based SLO doesn't use pre-defined periods of time. Instead, \n the SLO measures number of good requests/number of total requests during the interval. At any time, you can find the ratio of \n good requests to total requests for the interval up to the time stamp that you specify, and measure that ratio against the goal set in your SLO.

    \n
  • \n
\n

After you have created an SLO, you can retrieve error budget reports for it. \n An error budget is the amount of time or amount of requests that your application can be non-compliant\n with the SLO's goal, and still have your application meet the goal.

\n
    \n
  • \n

    For a period-based SLO, the error budget starts at a number defined by the highest number of periods that can fail to meet the threshold, \n while still meeting the overall goal. The remaining error budget decreases with every failed period\n that is recorded. The error budget within one interval can never increase.

    \n

    For example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month \n translates to an error budget of 21.9 minutes of downtime per month.

    \n
  • \n
  • \n

    For a request-based SLO, the remaining error budget is dynamic and can increase or decrease, depending on \n the ratio of good requests to total requests.

    \n
  • \n
\n

For more information about SLOs, see \n Service level objectives (SLOs).\n

\n

When you perform a CreateServiceLevelObjective operation, Application Signals creates the AWSServiceRoleForCloudWatchApplicationSignals service-linked role, \n if it doesn't already exist in your account. This service-\n linked role has the following permissions:

\n
    \n
  • \n

    \n xray:GetServiceGraph\n

    \n
  • \n
  • \n

    \n logs:StartQuery\n

    \n
  • \n
  • \n

    \n logs:GetQueryResults\n

    \n
  • \n
  • \n

    \n cloudwatch:GetMetricData\n

    \n
  • \n
  • \n

    \n cloudwatch:ListMetrics\n

    \n
  • \n
  • \n

    \n tag:GetResources\n

    \n
  • \n
  • \n

    \n autoscaling:DescribeAutoScalingGroups\n

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

Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations. Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the application is performing at the level that you want.

Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch measures this target frequently you can find whether it has been breached.

The target performance quality that is defined for an SLO is the attainment goal.

You can set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability. You can also set SLOs against any CloudWatch metric or math expression that produces a time series.

You can't create an SLO for a service operation that was discovered by Application Signals until after that operation has reported standard metrics to Application Signals.

When you create an SLO, you specify whether it is a period-based SLO or a request-based SLO. Each type of SLO has a different way of evaluating your application's performance against its attainment goal.

  • A period-based SLO uses defined periods of time within a specified total time interval. For each period of time, Application Signals determines whether the application met its goal. The attainment rate is calculated as the number of good periods/number of total periods.

    For example, for a period-based SLO, meeting an attainment goal of 99.9% means that within your interval, your application must meet its performance goal during at least 99.9% of the time periods.

  • A request-based SLO doesn't use pre-defined periods of time. Instead, the SLO measures number of good requests/number of total requests during the interval. At any time, you can find the ratio of good requests to total requests for the interval up to the time stamp that you specify, and measure that ratio against the goal set in your SLO.

After you have created an SLO, you can retrieve error budget reports for it. An error budget is the amount of time or amount of requests that your application can be non-compliant with the SLO's goal, and still have your application meet the goal.

  • For a period-based SLO, the error budget starts at a number defined by the highest number of periods that can fail to meet the threshold, while still meeting the overall goal. The remaining error budget decreases with every failed period that is recorded. The error budget within one interval can never increase.

    For example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month translates to an error budget of 21.9 minutes of downtime per month.

  • For a request-based SLO, the remaining error budget is dynamic and can increase or decrease, depending on the ratio of good requests to total requests.

For more information about SLOs, see Service level objectives (SLOs).

When you perform a CreateServiceLevelObjective operation, Application Signals creates the AWSServiceRoleForCloudWatchApplicationSignals service-linked role, if it doesn't already exist in your account. This service- linked role has the following permissions:

  • xray:GetServiceGraph

  • logs:StartQuery

  • logs:GetQueryResults

  • cloudwatch:GetMetricData

  • cloudwatch:ListMetrics

  • tag:GetResources

  • autoscaling:DescribeAutoScalingGroups

", "smithy.api#http": { "method": "POST", "uri": "/slo", @@ -818,13 +1045,13 @@ "SliConfig": { "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorConfig", "traits": { - "smithy.api#documentation": "

If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.

\n

You can't specify both RequestBasedSliConfig and SliConfig in the same operation.

" + "smithy.api#documentation": "

If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.

You can't specify both RequestBasedSliConfig and SliConfig in the same operation.

" } }, "RequestBasedSliConfig": { "target": "com.amazonaws.applicationsignals#RequestBasedServiceLevelIndicatorConfig", "traits": { - "smithy.api#documentation": "

If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.

\n

You can't specify both RequestBasedSliConfig and SliConfig in the same operation.

" + "smithy.api#documentation": "

If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.

You can't specify both RequestBasedSliConfig and SliConfig in the same operation.

" } }, "Goal": { @@ -836,13 +1063,13 @@ "Tags": { "target": "com.amazonaws.applicationsignals#TagList", "traits": { - "smithy.api#documentation": "

A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO.\n To be able to associate tags with the SLO when you create the SLO, you must\n have the cloudwatch:TagResource permission.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.

" + "smithy.api#documentation": "

A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO. To be able to associate tags with the SLO when you create the SLO, you must have the cloudwatch:TagResource permission.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

" } }, "BurnRateConfigurations": { "target": "com.amazonaws.applicationsignals#BurnRateConfigurations", "traits": { - "smithy.api#documentation": "

Use this array to create burn rates for this SLO. Each \n burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.

" + "smithy.api#documentation": "

Use this array to create burn rates for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.

" } } }, @@ -865,6 +1092,42 @@ "smithy.api#output": {} } }, + "com.amazonaws.applicationsignals#DeleteGroupingConfiguration": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.applicationsignals#DeleteGroupingConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#AccessDeniedException" + }, + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the grouping configuration for this account. This removes all custom grouping attribute definitions that were previously configured.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/grouping-configuration", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.applicationsignals#DeleteGroupingConfigurationOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.applicationsignals#DeleteServiceLevelObjective": { "type": "operation", "input": { @@ -923,7 +1186,7 @@ "DependencyKeyAttributes": { "target": "com.amazonaws.applicationsignals#Attributes", "traits": { - "smithy.api#documentation": "

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

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

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

", "smithy.api#required": {} } }, @@ -936,7 +1199,27 @@ } }, "traits": { - "smithy.api#documentation": "

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

\n

When creating a service dependency SLO, you must specify the KeyAttributes of the service, and the DependencyConfig for the dependency. You can specify the OperationName of the service, from which it calls the dependency. Alternatively, \n you can exclude OperationName and the SLO will monitor all of the service's operations that call the dependency.

" + "smithy.api#documentation": "

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

When creating a service dependency SLO, you must specify the KeyAttributes of the service, and the DependencyConfig for the dependency. You can specify the OperationName of the service, from which it calls the dependency. Alternatively, you can exclude OperationName and the SLO will monitor all of the service's operations that call the dependency.

" + } + }, + "com.amazonaws.applicationsignals#DependencyGraph": { + "type": "structure", + "members": { + "Nodes": { + "target": "com.amazonaws.applicationsignals#Nodes", + "traits": { + "smithy.api#documentation": "

An array of nodes representing the services, resources, or other entities in the dependency graph.

" + } + }, + "Edges": { + "target": "com.amazonaws.applicationsignals#Edges", + "traits": { + "smithy.api#documentation": "

An array of edges representing the connections and relationships between the nodes in the dependency graph.

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

A structure that represents the dependency relationships relevant to an audit finding, containing nodes and edges that show how services and resources are connected.

" } }, "com.amazonaws.applicationsignals#Dimension": { @@ -945,20 +1228,20 @@ "Name": { "target": "com.amazonaws.applicationsignals#DimensionName", "traits": { - "smithy.api#documentation": "

The name of the dimension. Dimension names must contain only ASCII characters, must include \n at least one non-whitespace character, and cannot start with a colon (:).\n ASCII\n control characters are not supported as part of dimension names.

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

The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.

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

The value of the dimension. Dimension values must contain only ASCII characters and must include \n at least one non-whitespace character. ASCII\n control characters are not supported as part of dimension values.

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

The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

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

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique \n identifier for a metric, whenever you add a unique name/value pair to one of \n your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish\n InstanceId as a dimension name, and the actual instance ID as the value for that dimension.

\n

You \n can assign up to 30 dimensions to a metric.

" + "smithy.api#documentation": "

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.

You can assign up to 30 dimensions to a metric.

" } }, "com.amazonaws.applicationsignals#DimensionName": { @@ -1019,6 +1302,44 @@ } } }, + "com.amazonaws.applicationsignals#Edge": { + "type": "structure", + "members": { + "SourceNodeId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of the source node in this edge connection.

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

The identifier of the destination node in this edge connection.

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

The duration or latency associated with this connection, if applicable.

" + } + }, + "ConnectionType": { + "target": "com.amazonaws.applicationsignals#ConnectionType", + "traits": { + "smithy.api#documentation": "

The type of connection between the nodes, indicating the nature of the relationship.

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

A structure that represents a connection between two nodes in a dependency graph, showing the relationship and characteristics of the connection.

" + } + }, + "com.amazonaws.applicationsignals#Edges": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#Edge" + } + }, "com.amazonaws.applicationsignals#EvaluationType": { "type": "enum", "members": { @@ -1147,7 +1468,7 @@ "StartTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

Your requested start time will be rounded to the nearest hour.

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

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

Your requested start time will be rounded to the nearest hour.

", "smithy.api#httpQuery": "StartTime", "smithy.api#required": {} } @@ -1155,34 +1476,415 @@ "EndTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

Your requested start time will be rounded to the nearest hour.

", - "smithy.api#httpQuery": "EndTime", + "smithy.api#documentation": "

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

Your requested start time will be rounded to the nearest hour.

", + "smithy.api#httpQuery": "EndTime", + "smithy.api#required": {} + } + }, + "KeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#GetServiceLevelObjective": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#GetServiceLevelObjectiveInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#GetServiceLevelObjectiveOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about one SLO created in the account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/slo/{Id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.applicationsignals#GetServiceLevelObjectiveInput": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveId", + "traits": { + "smithy.api#documentation": "

The ARN or name of the SLO that you want to retrieve information about. You can find the ARNs of SLOs by using the ListServiceLevelObjectives operation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#GetServiceLevelObjectiveOutput": { + "type": "structure", + "members": { + "Slo": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjective", + "traits": { + "smithy.api#documentation": "

A structure containing the information about the SLO.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#GetServiceOutput": { + "type": "structure", + "members": { + "Service": { + "target": "com.amazonaws.applicationsignals#Service", + "traits": { + "smithy.api#documentation": "

A structure containing information about the service.

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

The start time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057.

This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

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

The end time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057.

This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

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

An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:

  • \"Type\": \"AWS::Resource\"

  • \"ResourceType\": \"AWS::Logs::LogGroup\"

  • \"Identifier\": \"name-of-log-group\"

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#Goal": { + "type": "structure", + "members": { + "Interval": { + "target": "com.amazonaws.applicationsignals#Interval", + "traits": { + "smithy.api#documentation": "

The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

If you omit this parameter, a rolling interval of 7 days is used.

" + } + }, + "AttainmentGoal": { + "target": "com.amazonaws.applicationsignals#AttainmentGoal", + "traits": { + "smithy.api#documentation": "

The threshold that determines if the goal is being met.

If this is a period-based SLO, the attainment goal is the percentage of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.

If this is a request-based SLO, the attainment goal is the percentage of requests that must be successful to meet the attainment goal.

If you omit this parameter, 99 is used to represent 99% as the attainment goal.

" + } + }, + "WarningThreshold": { + "target": "com.amazonaws.applicationsignals#WarningThreshold", + "traits": { + "smithy.api#documentation": "

The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.

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

This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.

" + } + }, + "com.amazonaws.applicationsignals#GroupIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.applicationsignals#GroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.applicationsignals#GroupSource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.applicationsignals#GroupValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.applicationsignals#GroupingAttributeDefinition": { + "type": "structure", + "members": { + "GroupingName": { + "target": "com.amazonaws.applicationsignals#GroupingString", + "traits": { + "smithy.api#documentation": "

The friendly name for this grouping attribute, such as BusinessUnit or Environment. This name is used to identify the grouping in the console and APIs.

", + "smithy.api#required": {} + } + }, + "GroupingSourceKeys": { + "target": "com.amazonaws.applicationsignals#GroupingSourceKeyStringList", + "traits": { + "smithy.api#documentation": "

An array of source keys used to derive the grouping attribute value from telemetry data, Amazon Web Services tags, or other sources. For example, [\"business_unit\", \"team\"] would look for values in those fields.

" + } + }, + "DefaultGroupingValue": { + "target": "com.amazonaws.applicationsignals#GroupingString", + "traits": { + "smithy.api#documentation": "

The default value to use for this grouping attribute when no value can be derived from the source keys. This ensures all services have a grouping value even if the source data is missing.

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

A structure that defines how services should be grouped based on specific attributes. This includes the friendly name for the grouping, the source keys to derive values from, and an optional default value.

" + } + }, + "com.amazonaws.applicationsignals#GroupingAttributeDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#GroupingAttributeDefinition" + } + }, + "com.amazonaws.applicationsignals#GroupingConfiguration": { + "type": "structure", + "members": { + "GroupingAttributeDefinitions": { + "target": "com.amazonaws.applicationsignals#GroupingAttributeDefinitions", + "traits": { + "smithy.api#documentation": "

An array of grouping attribute definitions that specify how services should be grouped based on various attributes and source keys.

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

The timestamp when this grouping configuration was last updated. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.

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

A structure that contains the complete grouping configuration for an account, including all defined grouping attributes and metadata about when it was last updated.

" + } + }, + "com.amazonaws.applicationsignals#GroupingSourceKeyStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#GroupingString" + } + }, + "com.amazonaws.applicationsignals#GroupingString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s+\\-=\\._:/@]*$" + } + }, + "com.amazonaws.applicationsignals#Interval": { + "type": "union", + "members": { + "RollingInterval": { + "target": "com.amazonaws.applicationsignals#RollingInterval", + "traits": { + "smithy.api#documentation": "

If the interval is a rolling interval, this structure contains the interval specifications.

" + } + }, + "CalendarInterval": { + "target": "com.amazonaws.applicationsignals#CalendarInterval", + "traits": { + "smithy.api#documentation": "

If the interval is a calendar interval, this structure contains the interval specifications.

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

The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

" + } + }, + "com.amazonaws.applicationsignals#KeyAttributeName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]{1,50}$" + } + }, + "com.amazonaws.applicationsignals#KeyAttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[ -~]*[!-~]+[ -~]*$" + } + }, + "com.amazonaws.applicationsignals#LatestChangeEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#ChangeEvent" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.applicationsignals#ListAuditFindingMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.applicationsignals#ListAuditFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#ListAuditFindingsInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#ListAuditFindingsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of audit findings that provide automated analysis of service behavior and root cause analysis. These findings help identify the most significant observations about your services, including performance issues, anomalies, and potential problems. The findings are generated using heuristic algorithms based on established troubleshooting patterns.

", + "smithy.api#http": { + "method": "POST", + "uri": "/auditFindings", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.applicationsignals#ListAuditFindingsInput": { + "type": "structure", + "members": { + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time period to retrieve audit findings for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057

", + "smithy.api#httpQuery": "StartTime", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time period to retrieve audit findings for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057

", + "smithy.api#httpQuery": "EndTime", + "smithy.api#required": {} + } + }, + "Auditors": { + "target": "com.amazonaws.applicationsignals#Auditors", + "traits": { + "smithy.api#documentation": "

A list of auditor names to filter the findings by. Only findings generated by the specified auditors will be returned.

The following auditors are available for configuration:

  • slo - SloAuditor: Identifies SLO violations and detects breached thresholds during the Assessment phase.

  • operation_metric - OperationMetricAuditor: Detects anomalies in service operation metrics from Application Signals RED metrics during the Assessment phase

  • service_quota - ServiceQuotaAuditor: Monitors resource utilization against service quotas during the Assessment phase

  • trace - TraceAuditor: Performs deep-dive analysis of distributed traces, correlating traces with breached SLOs or abnormal RED metrics during the Analysis phase

  • dependency_metric - CriticalPathAuditor: Analyzes service dependency impacts and maps dependency relationships from Application Signals RED metrics during the Analysis phase

  • top_contributor - TopContributorAuditor: Identifies infrastructure-level contributors to issues by analyzing EMF logs of Application Signals RED metrics during the Analysis phase

  • log - LogAuditor: Extracts insights from application logs, categorizing error types and ranking severity by frequency during the Analysis phase

InitAuditor and Summarizer auditors are not configurable as they are automatically triggered during the audit process.

" + } + }, + "AuditTargets": { + "target": "com.amazonaws.applicationsignals#AuditTargets", + "traits": { + "smithy.api#documentation": "

A list of audit targets to filter the findings by. You can specify services, SLOs, or service operations to limit the audit findings to specific entities.

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

Include this value, if it was returned by the previous operation, to get the next set of audit findings.

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

The maximum number of audit findings to return in one operation. If you omit this parameter, the default of 10 is used.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#ListAuditFindingsOutput": { + "type": "structure", + "members": { + "AuditFindings": { + "target": "com.amazonaws.applicationsignals#AuditFindings", + "traits": { + "smithy.api#documentation": "

An array of structures, where each structure contains information about one audit finding, including the auditor results, severity, and associated metric and dependency graphs.

", "smithy.api#required": {} } }, - "KeyAttributes": { - "target": "com.amazonaws.applicationsignals#Attributes", + "NextToken": { + "target": "com.amazonaws.applicationsignals#NextToken", "traits": { - "smithy.api#documentation": "

Use this field to specify which service you want to retrieve information for. You must specify at least the Type, \n Name, and Environment attributes.

\n

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

    \n
  • \n
", - "smithy.api#required": {} + "smithy.api#documentation": "

Include this value in your next use of this API to get the next set of audit findings.

" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#output": {} } }, - "com.amazonaws.applicationsignals#GetServiceLevelObjective": { + "com.amazonaws.applicationsignals#ListGroupingAttributeDefinitions": { "type": "operation", "input": { - "target": "com.amazonaws.applicationsignals#GetServiceLevelObjectiveInput" + "target": "com.amazonaws.applicationsignals#ListGroupingAttributeDefinitionsInput" }, "output": { - "target": "com.amazonaws.applicationsignals#GetServiceLevelObjectiveOutput" + "target": "com.amazonaws.applicationsignals#ListGroupingAttributeDefinitionsOutput" }, "errors": [ { - "target": "com.amazonaws.applicationsignals#ResourceNotFoundException" + "target": "com.amazonaws.applicationsignals#AccessDeniedException" }, { "target": "com.amazonaws.applicationsignals#ThrottlingException" @@ -1192,24 +1894,23 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about one SLO created in the account.

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

Returns the current grouping configuration for this account, including all custom grouping attribute definitions that have been configured. These definitions determine how services are logically grouped based on telemetry attributes, Amazon Web Services tags, or predefined mappings.

", "smithy.api#http": { - "method": "GET", - "uri": "/slo/{Id}", + "method": "POST", + "uri": "/grouping-attribute-definitions", "code": 200 }, "smithy.api#readonly": {} } }, - "com.amazonaws.applicationsignals#GetServiceLevelObjectiveInput": { + "com.amazonaws.applicationsignals#ListGroupingAttributeDefinitionsInput": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveId", + "NextToken": { + "target": "com.amazonaws.applicationsignals#NextToken", "traits": { - "smithy.api#documentation": "

The ARN or name of the SLO that you want to retrieve information about. You can find the ARNs \n of SLOs by using the ListServiceLevelObjectives\n operation.

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

Include this value, if it was returned by the previous operation, to get the next set of grouping attribute definitions.

", + "smithy.api#httpQuery": "NextToken" } } }, @@ -1217,49 +1918,26 @@ "smithy.api#input": {} } }, - "com.amazonaws.applicationsignals#GetServiceLevelObjectiveOutput": { - "type": "structure", - "members": { - "Slo": { - "target": "com.amazonaws.applicationsignals#ServiceLevelObjective", - "traits": { - "smithy.api#documentation": "

A structure containing the information about the SLO.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationsignals#GetServiceOutput": { + "com.amazonaws.applicationsignals#ListGroupingAttributeDefinitionsOutput": { "type": "structure", "members": { - "Service": { - "target": "com.amazonaws.applicationsignals#Service", - "traits": { - "smithy.api#documentation": "

A structure containing information about the service.

", - "smithy.api#required": {} - } - }, - "StartTime": { - "target": "smithy.api#Timestamp", + "GroupingAttributeDefinitions": { + "target": "com.amazonaws.applicationsignals#GroupingAttributeDefinitions", "traits": { - "smithy.api#documentation": "

The start time of the data included in the response. In a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057.

\n

This displays the time that Application Signals used for the request. It might not match your request exactly, because \n it was rounded to the nearest hour.

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

An array of structures, where each structure contains information about one grouping attribute definition, including the grouping name, source keys, and default values.

", "smithy.api#required": {} } }, - "EndTime": { + "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The end time of the data included in the response. In a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057.

\n

This displays the time that Application Signals used for the request. It might not match your request exactly, because \n it was rounded to the nearest hour.

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

The timestamp when the grouping configuration was last updated. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.

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

An array of string-to-string maps that each contain information about one log group associated with this service. Each \n string-to-string map includes the following fields:

\n
    \n
  • \n

    \n \"Type\": \"AWS::Resource\"\n

    \n
  • \n
  • \n

    \n \"ResourceType\": \"AWS::Logs::LogGroup\"\n

    \n
  • \n
  • \n

    \n \"Identifier\": \"name-of-log-group\"\n

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

Include this value in your next use of this API to get the next set of grouping attribute definitions.

" } } }, @@ -1267,68 +1945,6 @@ "smithy.api#output": {} } }, - "com.amazonaws.applicationsignals#Goal": { - "type": "structure", - "members": { - "Interval": { - "target": "com.amazonaws.applicationsignals#Interval", - "traits": { - "smithy.api#documentation": "

The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

\n

If you omit this parameter, a rolling interval of 7 days is used.

" - } - }, - "AttainmentGoal": { - "target": "com.amazonaws.applicationsignals#AttainmentGoal", - "traits": { - "smithy.api#documentation": "

The threshold that determines if the goal is being met.

\n

If this is a period-based SLO, the attainment goal is the \n percentage of good periods that meet the threshold requirements to the total periods within the interval. \n For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the \n periods to be in healthy state.

\n

If this is a request-based SLO, the attainment goal is the percentage of requests that must be \n successful to meet the attainment goal.

\n

If you omit this parameter, 99 is used\n to represent 99% as the attainment goal.

" - } - }, - "WarningThreshold": { - "target": "com.amazonaws.applicationsignals#WarningThreshold", - "traits": { - "smithy.api#documentation": "

The percentage of remaining budget over total budget that you want to get warnings for. \n If you omit this parameter, the default of 50.0 is used.

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

This structure contains the attributes that determine the goal of an SLO. This includes\n the time period for evaluation and the attainment threshold.

" - } - }, - "com.amazonaws.applicationsignals#Interval": { - "type": "union", - "members": { - "RollingInterval": { - "target": "com.amazonaws.applicationsignals#RollingInterval", - "traits": { - "smithy.api#documentation": "

If the interval is a rolling interval, this structure contains the interval specifications.

" - } - }, - "CalendarInterval": { - "target": "com.amazonaws.applicationsignals#CalendarInterval", - "traits": { - "smithy.api#documentation": "

If the interval is a calendar interval, this structure contains the interval specifications.

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

The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

" - } - }, - "com.amazonaws.applicationsignals#KeyAttributeName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z]{1,50}$" - } - }, - "com.amazonaws.applicationsignals#KeyAttributeValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[ -~]*[!-~]+[ -~]*$" - } - }, "com.amazonaws.applicationsignals#ListServiceDependencies": { "type": "operation", "input": { @@ -1346,7 +1962,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of service dependencies of the service that you specify. A dependency is an infrastructure \n component that an operation of this service connects with. Dependencies can include Amazon Web Services \n services, Amazon Web Services resources, and third-party services.\n

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

Returns a list of service dependencies of the service that you specify. A dependency is an infrastructure component that an operation of this service connects with. Dependencies can include Amazon Web Services services, Amazon Web Services resources, and third-party services.

", "smithy.api#http": { "method": "POST", "uri": "/service-dependencies", @@ -1367,7 +1983,7 @@ "StartTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

Your requested start time will be rounded to the nearest hour.

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

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

Your requested start time will be rounded to the nearest hour.

", "smithy.api#httpQuery": "StartTime", "smithy.api#required": {} } @@ -1375,7 +1991,7 @@ "EndTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

Your requested end time will be rounded to the nearest hour.

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

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

Your requested end time will be rounded to the nearest hour.

", "smithy.api#httpQuery": "EndTime", "smithy.api#required": {} } @@ -1383,7 +1999,7 @@ "KeyAttributes": { "target": "com.amazonaws.applicationsignals#Attributes", "traits": { - "smithy.api#documentation": "

Use this field to specify which service you want to retrieve information for. You must specify at least the Type, \n Name, and Environment attributes.

\n

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

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

Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

", "smithy.api#required": {} } }, @@ -1391,7 +2007,7 @@ "target": "com.amazonaws.applicationsignals#ListServiceDependenciesMaxResults", "traits": { "smithy.api#default": 20, - "smithy.api#documentation": "

The maximum number of results to return in one operation. If you omit this\n parameter, the default of 50 is used.

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

The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

", "smithy.api#httpQuery": "MaxResults" } }, @@ -1422,14 +2038,14 @@ "StartTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

This displays the time that Application Signals used for the request. It might not match your request exactly, because \n it was rounded to the nearest hour.

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

The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

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

The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

This displays the time that Application Signals used for the request. It might not match your request exactly, because \n it was rounded to the nearest hour.

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

The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

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

Include this value in your next use of this API to get next set \n of service dependencies.

" + "smithy.api#documentation": "

Include this value in your next use of this API to get next set of service dependencies.

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

Returns the list of dependents that invoked the specified service during the provided time range. Dependents include \n other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.

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

Returns the list of dependents that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.

", "smithy.api#http": { "method": "POST", "uri": "/service-dependents", @@ -1489,7 +2105,7 @@ "StartTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

Your requested start time will be rounded to the nearest hour.

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

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

Your requested start time will be rounded to the nearest hour.

", "smithy.api#httpQuery": "StartTime", "smithy.api#required": {} } @@ -1497,7 +2113,7 @@ "EndTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

Your requested start time will be rounded to the nearest hour.

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

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

Your requested start time will be rounded to the nearest hour.

", "smithy.api#httpQuery": "EndTime", "smithy.api#required": {} } @@ -1505,7 +2121,7 @@ "KeyAttributes": { "target": "com.amazonaws.applicationsignals#Attributes", "traits": { - "smithy.api#documentation": "

Use this field to specify which service you want to retrieve information for. You must specify at least the Type, \n Name, and Environment attributes.

\n

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

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

Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

", "smithy.api#required": {} } }, @@ -1513,7 +2129,7 @@ "target": "com.amazonaws.applicationsignals#ListServiceDependentsMaxResults", "traits": { "smithy.api#default": 20, - "smithy.api#documentation": "

The maximum number of results to return in one operation. If you omit this\n parameter, the default of 50 is used.

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

The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

", "smithy.api#httpQuery": "MaxResults" } }, @@ -1544,14 +2160,14 @@ "StartTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

This displays the time that Application Signals used for the request. It might not match your request exactly, because \n it was rounded to the nearest hour.

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

The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

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

The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

This displays the time that Application Signals used for the request. It might not match your request exactly, because \n it was rounded to the nearest hour.

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

The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

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

Include this value in your next use of this API to get next set \n of service dependents.

" + "smithy.api#documentation": "

Include this value in your next use of this API to get next set of service dependents.

" } } }, @@ -1623,14 +2239,14 @@ "target": "com.amazonaws.applicationsignals#ListServiceLevelObjectiveExclusionWindowsMaxResults", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.\n \n

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

The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

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

Include this value, if it was returned by the previous operation, to get the next set of service level objectives.\n \n

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

Include this value, if it was returned by the previous operation, to get the next set of service level objectives.

", "smithy.api#httpQuery": "NextToken" } } @@ -1666,7 +2282,7 @@ "NextToken": { "target": "com.amazonaws.applicationsignals#NextToken", "traits": { - "smithy.api#documentation": "

Include this value, if it was returned by the previous operation, to get the next set of service level objectives.\n \n

" + "smithy.api#documentation": "

Include this value, if it was returned by the previous operation, to get the next set of service level objectives.

" } } }, @@ -1712,7 +2328,7 @@ "KeyAttributes": { "target": "com.amazonaws.applicationsignals#Attributes", "traits": { - "smithy.api#documentation": "

You can use this optional field to specify which services you want to retrieve SLO information for.

\n

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

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

You can use this optional field to specify which services you want to retrieve SLO information for.

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

" } }, "OperationName": { @@ -1732,7 +2348,7 @@ "target": "com.amazonaws.applicationsignals#ListServiceLevelObjectivesMaxResults", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return in one operation. If you omit this\n parameter, the default of 50 is used.

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

The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

", "smithy.api#httpQuery": "MaxResults" } }, @@ -1743,17 +2359,11 @@ "smithy.api#httpQuery": "NextToken" } }, - "MetricSourceTypes": { - "target": "com.amazonaws.applicationsignals#MetricSourceTypes", - "traits": { - "smithy.api#documentation": "

Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:

\n
    \n
  • \n

    Service operation

    \n
  • \n
  • \n

    Service dependency

    \n
  • \n
  • \n

    CloudWatch metric

    \n
  • \n
" - } - }, "IncludeLinkedAccounts": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If you are using this operation in a monitoring account, specify true to include SLO from source accounts in the returned data.\n \n

\n

When you are monitoring an account, you can use Amazon Web Services account ID in KeyAttribute filter for service source account and SloOwnerawsaccountID for SLO source account with IncludeLinkedAccounts to filter the returned data to only a single source account.\n \n

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

If you are using this operation in a monitoring account, specify true to include SLO from source accounts in the returned data.

When you are monitoring an account, you can use Amazon Web Services account ID in KeyAttribute filter for service source account and SloOwnerawsaccountID for SLO source account with IncludeLinkedAccounts to filter the returned data to only a single source account.

", "smithy.api#httpQuery": "IncludeLinkedAccounts" } }, @@ -1763,6 +2373,12 @@ "smithy.api#documentation": "

SLO's Amazon Web Services account ID.

", "smithy.api#httpQuery": "SloOwnerAwsAccountId" } + }, + "MetricSourceTypes": { + "target": "com.amazonaws.applicationsignals#MetricSourceTypes", + "traits": { + "smithy.api#documentation": "

Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:

  • Service operation

  • Service dependency

  • CloudWatch metric

" + } } }, "traits": { @@ -1790,7 +2406,7 @@ "NextToken": { "target": "com.amazonaws.applicationsignals#NextToken", "traits": { - "smithy.api#documentation": "

Include this value in your next use of this API to get next set \n of service level objectives.

" + "smithy.api#documentation": "

Include this value in your next use of this API to get next set of service level objectives.

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

Returns a list of the operations of this service that have been discovered by Application Signals.\n Only the operations that were invoked during the specified time range are returned.

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

Returns a list of the operations of this service that have been discovered by Application Signals. Only the operations that were invoked during the specified time range are returned.

", "smithy.api#http": { "method": "POST", "uri": "/service-operations", @@ -1845,7 +2461,7 @@ "StartTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

Your requested start time will be rounded to the nearest hour.

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

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

Your requested start time will be rounded to the nearest hour.

", "smithy.api#httpQuery": "StartTime", "smithy.api#required": {} } @@ -1853,7 +2469,7 @@ "EndTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

Your requested end time will be rounded to the nearest hour.

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

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

Your requested end time will be rounded to the nearest hour.

", "smithy.api#httpQuery": "EndTime", "smithy.api#required": {} } @@ -1861,7 +2477,7 @@ "KeyAttributes": { "target": "com.amazonaws.applicationsignals#Attributes", "traits": { - "smithy.api#documentation": "

Use this field to specify which service you want to retrieve information for. You must specify at least the Type, \n Name, and Environment attributes.

\n

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

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

Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

", "smithy.api#required": {} } }, @@ -1869,7 +2485,7 @@ "target": "com.amazonaws.applicationsignals#ListServiceOperationMaxResults", "traits": { "smithy.api#default": 20, - "smithy.api#documentation": "

The maximum number of results to return in one operation. If you omit this\n parameter, the default of 50 is used.

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

The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

", "smithy.api#httpQuery": "MaxResults" } }, @@ -1891,14 +2507,14 @@ "StartTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

This displays the time that Application Signals used for the request. It might not match your request exactly, because \n it was rounded to the nearest hour.

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

The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

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

The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

This displays the time that Application Signals used for the request. It might not match your request exactly, because \n it was rounded to the nearest hour.

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

The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

", "smithy.api#required": {} } }, @@ -1912,7 +2528,135 @@ "NextToken": { "target": "com.amazonaws.applicationsignals#NextToken", "traits": { - "smithy.api#documentation": "

Include this value in your next use of this API to get next set \n of service operations.

" + "smithy.api#documentation": "

Include this value in your next use of this API to get next set of service operations.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#ListServiceStates": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#ListServiceStatesInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#ListServiceStatesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the last deployment and other change states of services. This API provides visibility into recent changes that may have affected service performance, helping with troubleshooting and change correlation.

", + "smithy.api#http": { + "method": "POST", + "uri": "/service/states", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "pageSize": "MaxResults", + "outputToken": "NextToken", + "items": "ServiceStates" + } + } + }, + "com.amazonaws.applicationsignals#ListServiceStatesInput": { + "type": "structure", + "members": { + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057.

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

The end of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.applicationsignals#ListServiceStatesMaxResults", + "traits": { + "smithy.api#default": 20, + "smithy.api#documentation": "

The maximum number of service states to return in one operation. If you omit this parameter, the default of 20 is used.

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

Include this value, if it was returned by the previous operation, to get the next set of service states.

" + } + }, + "IncludeLinkedAccounts": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If you are using this operation in a monitoring account, specify true to include service states from source accounts in the returned data.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.applicationsignals#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID to filter service states by. Use this to limit results to services from a specific account.

" + } + }, + "AttributeFilters": { + "target": "com.amazonaws.applicationsignals#AttributeFilters", + "traits": { + "smithy.api#documentation": "

A list of attribute filters to narrow down the services. You can filter by platform, environment, or other service attributes.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#ListServiceStatesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "max": 250 + } + } + }, + "com.amazonaws.applicationsignals#ListServiceStatesOutput": { + "type": "structure", + "members": { + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057.

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

The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057.

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

An array of structures, where each structure contains information about the state of one service, including its latest change events such as deployments.

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

Include this value in your next use of this API to get the next set of service states.

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

Returns a list of services that have been discovered by Application Signals. \n A service represents a minimum logical and transactional unit that completes a business function. Services\n are discovered through Application Signals instrumentation.

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

Returns a list of services that have been discovered by Application Signals. A service represents a minimum logical and transactional unit that completes a business function. Services are discovered through Application Signals instrumentation.

", "smithy.api#http": { "method": "GET", "uri": "/services", @@ -1958,7 +2702,7 @@ "StartTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

Your requested start time will be rounded to the nearest hour.

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

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

Your requested start time will be rounded to the nearest hour.

", "smithy.api#httpQuery": "StartTime", "smithy.api#required": {} } @@ -1966,7 +2710,7 @@ "EndTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

Your requested start time will be rounded to the nearest hour.

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

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

Your requested start time will be rounded to the nearest hour.

", "smithy.api#httpQuery": "EndTime", "smithy.api#required": {} } @@ -1975,7 +2719,7 @@ "target": "com.amazonaws.applicationsignals#ListServicesMaxResults", "traits": { "smithy.api#default": 50, - "smithy.api#documentation": "

\n The maximum number \n of results \n to return \n in one operation. \n If you omit this parameter, \n the default of 50 is used.\n

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

The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

", "smithy.api#httpQuery": "MaxResults" } }, @@ -1990,7 +2734,7 @@ "target": "smithy.api#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If you are using this operation in a monitoring account, specify true to include services from source accounts in the returned data.\n \n

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

If you are using this operation in a monitoring account, specify true to include services from source accounts in the returned data.

", "smithy.api#httpQuery": "IncludeLinkedAccounts" } }, @@ -2021,28 +2765,28 @@ "StartTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

This displays the time that Application Signals used for the request. It might not match your request exactly, because \n it was rounded to the nearest hour.

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

The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

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

The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

This displays the time that Application Signals used for the request. It might not match your request exactly, because \n it was rounded to the nearest hour.

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

The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

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

An array of structures, where each structure contains some information about a service. To\n get complete information about a service, use \n GetService.

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

An array of structures, where each structure contains some information about a service. To get complete information about a service, use GetService.

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

Include this value in your next use of this API to get next set \n of services.

" + "smithy.api#documentation": "

Include this value in your next use of this API to get next set of services.

" } } }, @@ -2082,7 +2826,7 @@ "ResourceArn": { "target": "com.amazonaws.applicationsignals#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch resource that you want to view tags for.

\n

The ARN format of an Application Signals SLO is \n arn:aws:cloudwatch:Region:account-id:slo:slo-name\n \n

\n

For more information about ARN format, see Resource\n Types Defined by Amazon CloudWatch in the Amazon Web Services General\n Reference.

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

The Amazon Resource Name (ARN) of the CloudWatch resource that you want to view tags for.

The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name

For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

", "smithy.api#httpQuery": "ResourceArn", "smithy.api#required": {} } @@ -2118,7 +2862,7 @@ "Namespace": { "target": "com.amazonaws.applicationsignals#Namespace", "traits": { - "smithy.api#documentation": "

The namespace of the metric. For more information, see \n Namespaces.

" + "smithy.api#documentation": "

The namespace of the metric. For more information, see Namespaces.

" } }, "MetricName": { @@ -2130,7 +2874,7 @@ "Dimensions": { "target": "com.amazonaws.applicationsignals#Dimensions", "traits": { - "smithy.api#documentation": "

An array of one or more dimensions to use to define the metric that you want to use. \n For more information, see \n Dimensions.

" + "smithy.api#documentation": "

An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.

" } } }, @@ -2150,60 +2894,86 @@ "Id": { "target": "com.amazonaws.applicationsignals#MetricId", "traits": { - "smithy.api#documentation": "

A short name used to tie this object to the results in the response. This Id must be unique \n within a MetricDataQueries array. If you are performing math expressions on this set of data, \n this name represents that data and can serve as a variable in the metric math expression. The valid characters \n are letters, numbers, and underscore. The first character must be a lowercase letter.

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

A short name used to tie this object to the results in the response. This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

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

A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

\n

Within one MetricDataQuery object, you must specify either \n Expression or MetricStat but not both.

" + "smithy.api#documentation": "

A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

" } }, "Expression": { "target": "com.amazonaws.applicationsignals#MetricExpression", "traits": { - "smithy.api#documentation": "

This field can contain a metric math expression to be performed on the other metrics that\n you are retrieving within this MetricDataQueries structure.

\n

A math expression\n can use the Id of the other metrics or queries to refer to those metrics, and can also use \n the Id of other \n expressions to use the result of those expressions. For more information about metric math expressions, see \n Metric Math Syntax and Functions in the\n Amazon CloudWatch User Guide.

\n

Within each MetricDataQuery object, you must specify either \n Expression or MetricStat but not both.

" + "smithy.api#documentation": "

This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure.

A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

" } }, "Label": { "target": "com.amazonaws.applicationsignals#MetricLabel", "traits": { - "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful \n if this is an expression, so that you know\n what the value represents. If the metric or expression is shown in a \n CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch \n generates a default.

\n

You can put dynamic expressions into a label, so that it is more descriptive. \n For more information, see Using Dynamic Labels.

" + "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.

" } }, "ReturnData": { "target": "com.amazonaws.applicationsignals#ReturnData", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Use this only if you are using a metric math expression for the SLO. \n Specify true for ReturnData for only the one expression result to use as the alarm. For all \n other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.

" + "smithy.api#documentation": "

Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.

" } }, "Period": { "target": "com.amazonaws.applicationsignals#Period", "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points for this metric. For metrics with regular resolution, a period can\n be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

\n

If the StartTime parameter specifies a time stamp that is greater than\n 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

\n
    \n
  • \n

    Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

    \n
  • \n
  • \n

    Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

    \n
  • \n
  • \n

    Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

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

The granularity, in seconds, of the returned data points for this metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

  • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

  • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

  • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

" + } + }, + "AccountId": { + "target": "com.amazonaws.applicationsignals#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account where this metric is located. If you are performing this operation in a monitoring account, use this to specify which source account to retrieve this metric from.

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

Use this structure to define a metric or metric math expression that you want to use as for a service level objective.

Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.

For more information about metric math expressions, see CloudWatchUse metric math.

Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

" + } + }, + "com.amazonaws.applicationsignals#MetricExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.applicationsignals#MetricGraph": { + "type": "structure", + "members": { + "MetricDataQueries": { + "target": "com.amazonaws.applicationsignals#MetricDataQueries", + "traits": { + "smithy.api#documentation": "

An array of metric data queries that define the metrics to be retrieved and analyzed as part of the audit finding context.

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

The start time for the metric data included in this graph. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.

" } }, - "AccountId": { - "target": "com.amazonaws.applicationsignals#AccountId", + "EndTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The ID of the account where this metric is located. If you are performing this operation in a monitoring account, \n use this to specify which source account to retrieve this metric from.

" + "smithy.api#documentation": "

The end time for the metric data included in this graph. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.

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

Use this structure to define a metric or metric math expression that you want to use as for a service level objective.

\n

Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression \n to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. \n The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that \n contain the Expression parameter to perform a math expression. Of those Expression structures, \n exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.

\n

For more information about metric math expressions, see \n CloudWatchUse metric math.

\n

Within each MetricDataQuery object, you must specify either \n Expression or MetricStat but not both.

" - } - }, - "com.amazonaws.applicationsignals#MetricExpression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } + "smithy.api#documentation": "

A structure that contains metric data queries and time range information that provides context for audit findings through relevant performance metrics.

" } }, "com.amazonaws.applicationsignals#MetricId": { @@ -2233,7 +3003,7 @@ "Namespace": { "target": "com.amazonaws.applicationsignals#Namespace", "traits": { - "smithy.api#documentation": "

The namespace of the metric. For more information, see \n CloudWatchNamespaces.

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

The namespace of the metric. For more information, see CloudWatchNamespaces.

", "smithy.api#required": {} } }, @@ -2247,7 +3017,7 @@ "Dimensions": { "target": "com.amazonaws.applicationsignals#Dimensions", "traits": { - "smithy.api#documentation": "

An array of one or more dimensions that further define the metric. \n For more information, see \n CloudWatchDimensions.

" + "smithy.api#documentation": "

An array of one or more dimensions that further define the metric. For more information, see CloudWatchDimensions.

" } }, "MetricName": { @@ -2265,7 +3035,7 @@ } }, "traits": { - "smithy.api#documentation": "

This structure contains information about one CloudWatch metric associated with this entity discovered\n by Application Signals.

" + "smithy.api#documentation": "

This structure contains information about one CloudWatch metric associated with this entity discovered by Application Signals.

" } }, "com.amazonaws.applicationsignals#MetricReferences": { @@ -2322,21 +3092,21 @@ "Period": { "target": "com.amazonaws.applicationsignals#Period", "traits": { - "smithy.api#documentation": "

The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can\n be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

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

The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

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

The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, \n see CloudWatch statistics definitions.

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

The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

", "smithy.api#required": {} } }, "Unit": { "target": "com.amazonaws.applicationsignals#StandardUnit", "traits": { - "smithy.api#documentation": "

If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified\n when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

" + "smithy.api#documentation": "

If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

" } } }, @@ -2356,18 +3126,18 @@ "GoodCountMetric": { "target": "com.amazonaws.applicationsignals#MetricDataQueries", "traits": { - "smithy.api#documentation": "

If you want to count \"good requests\" to determine the percentage of successful requests for this\n request-based SLO, specify the metric to use as \"good requests\" in this structure.

" + "smithy.api#documentation": "

If you want to count \"good requests\" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as \"good requests\" in this structure.

" } }, "BadCountMetric": { "target": "com.amazonaws.applicationsignals#MetricDataQueries", "traits": { - "smithy.api#documentation": "

If you want to count \"bad requests\" to determine the percentage of successful requests for this\n request-based SLO, specify the metric to use as \"bad requests\" in this structure.

" + "smithy.api#documentation": "

If you want to count \"bad requests\" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as \"bad requests\" in this structure.

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

This structure defines the metric that is used as the \"good request\" or \"bad request\"\n value for a request-based SLO. \n This value observed for the metric defined in \n TotalRequestCountMetric is divided by the number found for \n MonitoredRequestCountMetric to determine the percentage of successful requests that \n this SLO tracks.

" + "smithy.api#documentation": "

This structure defines the metric that is used as the \"good request\" or \"bad request\" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric is divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.

" } }, "com.amazonaws.applicationsignals#Namespace": { @@ -2383,6 +3153,70 @@ "com.amazonaws.applicationsignals#NextToken": { "type": "string" }, + "com.amazonaws.applicationsignals#Node": { + "type": "structure", + "members": { + "KeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

The key attributes that identify this node, including Type, Name, and Environment information.

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

The name of the entity represented by this node.

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

A unique identifier for this node within the dependency graph.

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

The operation associated with this node, if applicable.

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

The type of entity represented by this node, such as Service or Resource.

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

The duration or processing time associated with this node, if applicable.

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

The status of the entity represented by this node.

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

A structure that represents a node in a dependency graph, containing information about a service, resource, or other entity and its characteristics.

" + } + }, + "com.amazonaws.applicationsignals#Nodes": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#Node" + }, + "traits": { + "smithy.api#length": { + "max": 4 + } + } + }, "com.amazonaws.applicationsignals#OperationName": { "type": "string", "traits": { @@ -2400,6 +3234,65 @@ } } }, + "com.amazonaws.applicationsignals#PutGroupingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#PutGroupingConfigurationInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#PutGroupingConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#AccessDeniedException" + }, + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates the grouping configuration for this account. This operation allows you to define custom grouping attributes that determine how services are logically grouped based on telemetry attributes, Amazon Web Services tags, or predefined mappings. These grouping attributes can then be used to organize and filter services in the Application Signals console and APIs.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/grouping-configuration", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.applicationsignals#PutGroupingConfigurationInput": { + "type": "structure", + "members": { + "GroupingAttributeDefinitions": { + "target": "com.amazonaws.applicationsignals#GroupingAttributeDefinitions", + "traits": { + "smithy.api#documentation": "

An array of grouping attribute definitions that specify how services should be grouped. Each definition includes a friendly name, source keys to derive the grouping value from, and an optional default value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#PutGroupingConfigurationOutput": { + "type": "structure", + "members": { + "GroupingConfiguration": { + "target": "com.amazonaws.applicationsignals#GroupingConfiguration", + "traits": { + "smithy.api#documentation": "

A structure containing the updated grouping configuration, including all grouping attribute definitions and the timestamp when it was last updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.applicationsignals#RecurrenceRule": { "type": "structure", "members": { @@ -2428,13 +3321,13 @@ "MetricThreshold": { "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetricThreshold", "traits": { - "smithy.api#documentation": "

This value is the threshold that \n the observed metric values of the SLI metric are compared to.

" + "smithy.api#documentation": "

This value is the threshold that the observed metric values of the SLI metric are compared to.

" } }, "ComparisonOperator": { "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorComparisonOperator", "traits": { - "smithy.api#documentation": "

The arithmetic operation used when comparing the specified metric to the\n threshold.

" + "smithy.api#documentation": "

The arithmetic operation used when comparing the specified metric to the threshold.

" } } }, @@ -2461,7 +3354,7 @@ "ComparisonOperator": { "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorComparisonOperator", "traits": { - "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified metric to the\n threshold. This parameter is required if this SLO is tracking the Latency metric.

" + "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified metric to the threshold. This parameter is required if this SLO is tracking the Latency metric.

" } } }, @@ -2475,7 +3368,7 @@ "KeyAttributes": { "target": "com.amazonaws.applicationsignals#Attributes", "traits": { - "smithy.api#documentation": "

This is a string-to-string map that contains information about the type of object that this SLO is related to. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object that this SLO is related to.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

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

This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.

  • Type designates the type of object that this SLO is related to.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

" } }, "OperationName": { @@ -2487,20 +3380,20 @@ "MetricType": { "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetricType", "traits": { - "smithy.api#documentation": "

If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals \n collects, this field displays which of those metrics is used.

" + "smithy.api#documentation": "

If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.

" } }, "TotalRequestCountMetric": { "target": "com.amazonaws.applicationsignals#MetricDataQueries", "traits": { - "smithy.api#documentation": "

This structure defines the metric that is used as the \"total requests\" number for a request-based SLO. \n The number observed for this metric is divided by the number of \"good requests\" or \"bad requests\" that is \n observed for the metric defined in \n MonitoredRequestCountMetric.

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

This structure defines the metric that is used as the \"total requests\" number for a request-based SLO. The number observed for this metric is divided by the number of \"good requests\" or \"bad requests\" that is observed for the metric defined in MonitoredRequestCountMetric.

", "smithy.api#required": {} } }, "MonitoredRequestCountMetric": { "target": "com.amazonaws.applicationsignals#MonitoredRequestCountMetricDataQueries", "traits": { - "smithy.api#documentation": "

This structure defines the metric that is used as the \"good request\" or \"bad request\"\n value for a request-based SLO. \n This value observed for the metric defined in \n TotalRequestCountMetric is divided by the number found for \n MonitoredRequestCountMetric to determine the percentage of successful requests that \n this SLO tracks.

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

This structure defines the metric that is used as the \"good request\" or \"bad request\" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric is divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.

", "smithy.api#required": {} } }, @@ -2521,7 +3414,7 @@ "KeyAttributes": { "target": "com.amazonaws.applicationsignals#Attributes", "traits": { - "smithy.api#documentation": "

If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service \n the SLO metric is related to. To do so, you must specify at least the Type, \n Name, and Environment attributes.

\n

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

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

If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type, Name, and Environment attributes.

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

" } }, "OperationName": { @@ -2533,19 +3426,19 @@ "MetricType": { "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetricType", "traits": { - "smithy.api#documentation": "

If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals \n collects, use this field to specify which of those metrics is used.

" + "smithy.api#documentation": "

If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.

" } }, "TotalRequestCountMetric": { "target": "com.amazonaws.applicationsignals#MetricDataQueries", "traits": { - "smithy.api#documentation": "

Use this structure to define the metric that you want to use as the \"total requests\" number for a request-based SLO. \n This result will be divided by the \"good request\" or \"bad request\" value defined in \n MonitoredRequestCountMetric.

" + "smithy.api#documentation": "

Use this structure to define the metric that you want to use as the \"total requests\" number for a request-based SLO. This result will be divided by the \"good request\" or \"bad request\" value defined in MonitoredRequestCountMetric.

" } }, "MonitoredRequestCountMetric": { "target": "com.amazonaws.applicationsignals#MonitoredRequestCountMetricDataQueries", "traits": { - "smithy.api#documentation": "

Use this structure to define the metric that you want to use as the \"good request\" or \"bad request\"\n value for a request-based SLO. \n This value observed for the metric defined in \n TotalRequestCountMetric will be divided by the number found for \n MonitoredRequestCountMetric to determine the percentage of successful requests that \n this SLO tracks.

" + "smithy.api#documentation": "

Use this structure to define the metric that you want to use as the \"good request\" or \"bad request\" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric will be divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.

" } }, "DependencyConfig": { @@ -2611,7 +3504,7 @@ "Duration": { "target": "com.amazonaws.applicationsignals#RollingIntervalDuration", "traits": { - "smithy.api#documentation": "

Specifies the duration of each rolling interval. For example, if Duration is 7 and\n DurationUnit is DAY, each rolling interval is seven days.

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

Specifies the duration of each rolling interval. For example, if Duration is 7 and DurationUnit is DAY, each rolling interval is seven days.

", "smithy.api#required": {} } } @@ -2643,14 +3536,20 @@ "KeyAttributes": { "target": "com.amazonaws.applicationsignals#Attributes", "traits": { - "smithy.api#documentation": "

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

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

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

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

This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.

\n

Platform attributes contain information the service's platform.

\n
    \n
  • \n

    \n PlatformType defines the hosted-in platform.

    \n
  • \n
  • \n

    \n EKS.Cluster is the name of the Amazon EKS cluster.

    \n
  • \n
  • \n

    \n K8s.Cluster is the name of the self-hosted Kubernetes cluster.

    \n
  • \n
  • \n

    \n K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.

    \n
  • \n
  • \n

    \n EC2.InstanceId is the ID of the Amazon EC2 instance.

    \n
  • \n
  • \n

    \n Host is the name of the host, for all platform types.

    \n
  • \n
\n

Application attributes contain information about the application.

\n
    \n
  • \n

    \n AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.

    \n
  • \n
  • \n

    \n AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.

    \n
  • \n
\n

Telemetry attributes contain telemetry information.

\n
    \n
  • \n

    \n Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.

    \n
  • \n
  • \n

    \n Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.

    \n
  • \n
  • \n

    \n Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

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

This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.

Platform attributes contain information the service's platform.

  • PlatformType defines the hosted-in platform.

  • EKS.Cluster is the name of the Amazon EKS cluster.

  • K8s.Cluster is the name of the self-hosted Kubernetes cluster.

  • K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.

  • K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.

  • K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.

  • K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.

  • EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.

  • EC2.InstanceId is the ID of the Amazon EC2 instance.

  • Host is the name of the host, for all platform types.

Application attributes contain information about the application.

  • AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.

  • AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.

Telemetry attributes contain telemetry information.

  • Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.

  • Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.

  • Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

" + } + }, + "ServiceGroups": { + "target": "com.amazonaws.applicationsignals#ServiceGroups", + "traits": { + "smithy.api#documentation": "

An array of service groups that this service belongs to, based on the configured grouping attributes.

" } }, "MetricReferences": { @@ -2663,12 +3562,12 @@ "LogGroupReferences": { "target": "com.amazonaws.applicationsignals#LogGroupReferences", "traits": { - "smithy.api#documentation": "

An array of string-to-string maps that each contain information about one log group associated with this service. Each \n string-to-string map includes the following fields:

\n
    \n
  • \n

    \n \"Type\": \"AWS::Resource\"\n

    \n
  • \n
  • \n

    \n \"ResourceType\": \"AWS::Logs::LogGroup\"\n

    \n
  • \n
  • \n

    \n \"Identifier\": \"name-of-log-group\"\n

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

An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:

  • \"Type\": \"AWS::Resource\"

  • \"ResourceType\": \"AWS::Logs::LogGroup\"

  • \"Identifier\": \"name-of-log-group\"

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

This structure contains information about one of your services that was discovered by Application Signals.\n

" + "smithy.api#documentation": "

This structure contains information about one of your services that was discovered by Application Signals.

" } }, "com.amazonaws.applicationsignals#ServiceDependencies": { @@ -2696,7 +3595,7 @@ "DependencyKeyAttributes": { "target": "com.amazonaws.applicationsignals#Attributes", "traits": { - "smithy.api#documentation": "

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

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

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

", "smithy.api#required": {} } }, @@ -2710,13 +3609,13 @@ "MetricReferences": { "target": "com.amazonaws.applicationsignals#MetricReferences", "traits": { - "smithy.api#documentation": "

An array of structures that each contain information about one metric associated with this service dependency\n that was discovered by\n Application Signals.

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

An array of structures that each contain information about one metric associated with this service dependency that was discovered by Application Signals.

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

This structure contains information about one dependency\n of this service.

" + "smithy.api#documentation": "

This structure contains information about one dependency of this service.

" } }, "com.amazonaws.applicationsignals#ServiceDependent": { @@ -2731,26 +3630,26 @@ "DependentKeyAttributes": { "target": "com.amazonaws.applicationsignals#Attributes", "traits": { - "smithy.api#documentation": "

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

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

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

", "smithy.api#required": {} } }, "DependentOperationName": { "target": "com.amazonaws.applicationsignals#OperationName", "traits": { - "smithy.api#documentation": "

If the dependent invoker was a service that invoked it from an operation, the name of that dependent operation\n is displayed here.

" + "smithy.api#documentation": "

If the dependent invoker was a service that invoked it from an operation, the name of that dependent operation is displayed here.

" } }, "MetricReferences": { "target": "com.amazonaws.applicationsignals#MetricReferences", "traits": { - "smithy.api#documentation": "

An array of structures that each contain information about one metric associated with this service dependent\n that was discovered by\n Application Signals.

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

An array of structures that each contain information about one metric associated with this service dependent that was discovered by Application Signals.

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

This structure contains information about a service dependent that was discovered by Application Signals. A \n dependent is an entity that invoked the specified service during the provided time range. Dependents include \n other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.

" + "smithy.api#documentation": "

This structure contains information about a service dependent that was discovered by Application Signals. A dependent is an entity that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.

" } }, "com.amazonaws.applicationsignals#ServiceDependents": { @@ -2765,9 +3664,83 @@ } } }, + "com.amazonaws.applicationsignals#ServiceEntity": { + "type": "structure", + "members": { + "Type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of the service entity.

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

The name of the service.

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

The environment where the service is deployed.

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

The Amazon Web Services account ID where the service is located. Provide this value only for cross-account access.

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

A structure that contains identifying information for a service entity.

" + } + }, "com.amazonaws.applicationsignals#ServiceErrorMessage": { "type": "string" }, + "com.amazonaws.applicationsignals#ServiceGroup": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.applicationsignals#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the grouping attribute, such as BusinessUnit or Environment.

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

The value of the grouping attribute for this service, such as Payments or Production.

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

The source of the grouping attribute, such as TAG, OTEL, or DEFAULT.

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

A unique identifier for this grouping attribute value, used for filtering and API operations.

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

A structure that represents a logical grouping of services based on shared attributes such as business unit, environment, or entry point.

" + } + }, + "com.amazonaws.applicationsignals#ServiceGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#ServiceGroup" + } + }, "com.amazonaws.applicationsignals#ServiceLevelIndicator": { "type": "structure", "members": { @@ -2788,7 +3761,7 @@ "ComparisonOperator": { "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorComparisonOperator", "traits": { - "smithy.api#documentation": "

The arithmetic operation used when comparing the specified metric to the\n threshold.

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

The arithmetic operation used when comparing the specified metric to the threshold.

", "smithy.api#required": {} } } @@ -2839,14 +3812,14 @@ "MetricThreshold": { "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetricThreshold", "traits": { - "smithy.api#documentation": "

This parameter is used only when a request-based SLO tracks the Latency metric. Specify the threshold value that the \n observed Latency metric values are to be compared to.

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

This parameter is used only when a request-based SLO tracks the Latency metric. Specify the threshold value that the observed Latency metric values are to be compared to.

", "smithy.api#required": {} } }, "ComparisonOperator": { "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorComparisonOperator", "traits": { - "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified metric to the\n threshold.

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

The arithmetic operation to use when comparing the specified metric to the threshold.

", "smithy.api#required": {} } } @@ -2861,7 +3834,7 @@ "KeyAttributes": { "target": "com.amazonaws.applicationsignals#Attributes", "traits": { - "smithy.api#documentation": "

This is a string-to-string map that contains information about the type of object that this SLO is related to. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object that this SLO is related to.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

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

This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.

  • Type designates the type of object that this SLO is related to.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

" } }, "OperationName": { @@ -2873,13 +3846,13 @@ "MetricType": { "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetricType", "traits": { - "smithy.api#documentation": "

If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals \n collects, this field displays which of those metrics is used.

" + "smithy.api#documentation": "

If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.

" } }, "MetricDataQueries": { "target": "com.amazonaws.applicationsignals#MetricDataQueries", "traits": { - "smithy.api#documentation": "

If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, \n this structure includes the information about that metric or expression.

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

If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression.

", "smithy.api#required": {} } }, @@ -2900,7 +3873,7 @@ "KeyAttributes": { "target": "com.amazonaws.applicationsignals#Attributes", "traits": { - "smithy.api#documentation": "

If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service \n the SLO metric is related to. To do so, you must specify at least the Type, \n Name, and Environment attributes.

\n

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

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

If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type, Name, and Environment attributes.

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

" } }, "OperationName": { @@ -2912,25 +3885,31 @@ "MetricType": { "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetricType", "traits": { - "smithy.api#documentation": "

If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals \n collects, use this field to specify which of those metrics is used.

" + "smithy.api#documentation": "

If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.

" + } + }, + "MetricName": { + "target": "com.amazonaws.applicationsignals#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch metric to use for the SLO, when using a custom metric rather than Application Signals standard metrics.

" } }, "Statistic": { "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorStatistic", "traits": { - "smithy.api#documentation": "

The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, \n see CloudWatch statistics definitions.

" + "smithy.api#documentation": "

The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

" } }, "PeriodSeconds": { "target": "com.amazonaws.applicationsignals#SLIPeriodSeconds", "traits": { - "smithy.api#documentation": "

The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the \n SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.

" + "smithy.api#documentation": "

The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.

" } }, "MetricDataQueries": { "target": "com.amazonaws.applicationsignals#MetricDataQueries", "traits": { - "smithy.api#documentation": "

If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, \n use this structure to specify that metric or expression.

" + "smithy.api#documentation": "

If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.

" } }, "DependencyConfig": { @@ -3000,14 +3979,14 @@ "CreatedTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that this SLO was created. When used in a raw HTTP Query API, it is formatted as \n yyyy-MM-dd'T'HH:mm:ss. For example, \n 2019-07-01T23:59:59.

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

The date and time that this SLO was created. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

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

The time that this SLO was most recently updated. When used in a raw HTTP Query API, it is formatted as \n yyyy-MM-dd'T'HH:mm:ss. For example, \n 2019-07-01T23:59:59.

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

The time that this SLO was most recently updated. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

", "smithy.api#required": {} } }, @@ -3038,18 +4017,18 @@ "BurnRateConfigurations": { "target": "com.amazonaws.applicationsignals#BurnRateConfigurations", "traits": { - "smithy.api#documentation": "

Each object in this array defines the length of the look-back window used to calculate one burn rate metric\n for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO.

" + "smithy.api#documentation": "

Each object in this array defines the length of the look-back window used to calculate one burn rate metric for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO.

" } }, "MetricSourceType": { "target": "com.amazonaws.applicationsignals#MetricSourceType", "traits": { - "smithy.api#documentation": "

Displays the SLI metric source type for this SLO. Supported types are:

\n
    \n
  • \n

    Service operation

    \n
  • \n
  • \n

    Service dependency

    \n
  • \n
  • \n

    CloudWatch metric

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

Displays the SLI metric source type for this SLO. Supported types are:

  • Service operation

  • Service dependency

  • CloudWatch metric

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

A structure containing information about one service level objective (SLO) that has been created in Application Signals.\n Creating SLOs can help you ensure your services are \n performing to the level that you expect. SLOs help you set and track a specific target level for the\n reliability and availability of your applications and services. Each SLO uses a service level indicator (SLI), which is \n a key performance metric, to \n calculate how much underperformance can be tolerated before the goal that you set for the SLO is not achieved.

" + "smithy.api#documentation": "

A structure containing information about one service level objective (SLO) that has been created in Application Signals. Creating SLOs can help you ensure your services are performing to the level that you expect. SLOs help you set and track a specific target level for the reliability and availability of your applications and services. Each SLO uses a service level indicator (SLI), which is a key performance metric, to calculate how much underperformance can be tolerated before the goal that you set for the SLO is not achieved.

" } }, "com.amazonaws.applicationsignals#ServiceLevelObjectiveArn": { @@ -3088,38 +4067,38 @@ "BudgetStatus": { "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetStatus", "traits": { - "smithy.api#documentation": "

The status of this SLO, as it relates to the error budget for the entire time interval.

\n
    \n
  • \n

    \n OK means that the SLO had remaining budget above the warning threshold,\n as of the time that you specified in TimeStamp.

    \n
  • \n
  • \n

    \n WARNING means that the SLO's remaining budget was below the warning threshold,\n as of the time that you specified in TimeStamp.

    \n
  • \n
  • \n

    \n BREACHED means that the SLO's budget was exhausted,\n as of the time that you specified in TimeStamp.

    \n
  • \n
  • \n

    \n INSUFFICIENT_DATA means that the specified start and end times were before the\n SLO was created, or that attainment data is missing.

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

The status of this SLO, as it relates to the error budget for the entire time interval.

  • OK means that the SLO had remaining budget above the warning threshold, as of the time that you specified in TimeStamp.

  • WARNING means that the SLO's remaining budget was below the warning threshold, as of the time that you specified in TimeStamp.

  • BREACHED means that the SLO's budget was exhausted, as of the time that you specified in TimeStamp.

  • INSUFFICIENT_DATA means that the specified start and end times were before the SLO was created, or that attainment data is missing.

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

A number between 0 and 100 that represents the success percentage of your application compared\n to the goal set by the SLO.

\n

If this is a period-based SLO, the number is the percentage of time periods that the service has \n attained the SLO's attainment goal, as of the time of the request.

\n

If this is a request-based SLO, the number is the number of successful requests divided\n by the number of total requests, multiplied by 100, during the time range that you specified in your request.

" + "smithy.api#documentation": "

A number between 0 and 100 that represents the success percentage of your application compared to the goal set by the SLO.

If this is a period-based SLO, the number is the percentage of time periods that the service has attained the SLO's attainment goal, as of the time of the request.

If this is a request-based SLO, the number is the number of successful requests divided by the number of total requests, multiplied by 100, during the time range that you specified in your request.

" } }, "TotalBudgetSeconds": { "target": "com.amazonaws.applicationsignals#TotalBudgetSeconds", "traits": { - "smithy.api#documentation": "

The total number of seconds in the error budget for the interval. This field is included only \n if the SLO is a period-based SLO.

" + "smithy.api#documentation": "

The total number of seconds in the error budget for the interval. This field is included only if the SLO is a period-based SLO.

" } }, "BudgetSecondsRemaining": { "target": "com.amazonaws.applicationsignals#BudgetSecondsRemaining", "traits": { - "smithy.api#documentation": "

The budget amount remaining before the SLO status becomes BREACHING, at the time specified in\n the \n Timestemp parameter of the request. If this value is negative, then the SLO is already in BREACHING\n status.

\n

This field is included only \n if the SLO is a period-based SLO.

" + "smithy.api#documentation": "

The budget amount remaining before the SLO status becomes BREACHING, at the time specified in the Timestemp parameter of the request. If this value is negative, then the SLO is already in BREACHING status.

This field is included only if the SLO is a period-based SLO.

" } }, "TotalBudgetRequests": { "target": "com.amazonaws.applicationsignals#TotalBudgetRequests", "traits": { - "smithy.api#documentation": "

This field is displayed only for request-based SLOs. It displays the total number of failed requests that can be tolerated during the time range between the start of the \n interval and the time stamp supplied in the budget report request. It is based on the total number of requests that occurred,\n and the percentage specified in the attainment goal. If the number of failed requests matches this number or is higher, then \n this SLO is currently breaching.

\n

This number can go up and down between reports with different time stamps, based on both how many total requests occur.

" + "smithy.api#documentation": "

This field is displayed only for request-based SLOs. It displays the total number of failed requests that can be tolerated during the time range between the start of the interval and the time stamp supplied in the budget report request. It is based on the total number of requests that occurred, and the percentage specified in the attainment goal. If the number of failed requests matches this number or is higher, then this SLO is currently breaching.

This number can go up and down between reports with different time stamps, based on both how many total requests occur.

" } }, "BudgetRequestsRemaining": { "target": "com.amazonaws.applicationsignals#BudgetRequestsRemaining", "traits": { - "smithy.api#documentation": "

This field is displayed only for request-based SLOs. It displays the number of failed requests that can be tolerated before any more successful requests occur,\n and still have the application meet its SLO goal.

\n

This number can go up and down between different reports, based on both how many successful requests and how many failed \n requests occur in that time.

" + "smithy.api#documentation": "

This field is displayed only for request-based SLOs. It displays the number of failed requests that can be tolerated before any more successful requests occur, and still have the application meet its SLO goal.

This number can go up and down between different reports, based on both how many successful requests and how many failed requests occur in that time.

" } }, "Sli": { @@ -3172,7 +4151,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure containing information about one error that occurred during a \n BatchGetServiceLevelObjectiveBudgetReport\n operation.

" + "smithy.api#documentation": "

A structure containing information about one error that occurred during a BatchGetServiceLevelObjectiveBudgetReport operation.

" } }, "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetReportErrorCode": { @@ -3241,6 +4220,26 @@ } } }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveEntity": { + "type": "structure", + "members": { + "SloName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the service level objective.

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

The ARN of the service level objective. The SLO must be provided with ARN for cross-account access.

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

A structure that contains identifying information for a service level objective entity.

" + } + }, "com.amazonaws.applicationsignals#ServiceLevelObjectiveId": { "type": "string", "traits": { @@ -3320,13 +4319,13 @@ "KeyAttributes": { "target": "com.amazonaws.applicationsignals#Attributes", "traits": { - "smithy.api#documentation": "

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this service level objective is for.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

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

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this service level objective is for.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

" } }, "OperationName": { "target": "com.amazonaws.applicationsignals#OperationName", "traits": { - "smithy.api#documentation": "

If this service level objective is specific to a single operation, this \n field displays the name of that operation.

" + "smithy.api#documentation": "

If this service level objective is specific to a single operation, this field displays the name of that operation.

" } }, "DependencyConfig": { @@ -3350,7 +4349,7 @@ "MetricSourceType": { "target": "com.amazonaws.applicationsignals#MetricSourceType", "traits": { - "smithy.api#documentation": "

Displays the SLI metric source type for this SLO. Supported types are:

\n
    \n
  • \n

    Service operation

    \n
  • \n
  • \n

    Service dependency

    \n
  • \n
  • \n

    CloudWatch metric

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

Displays the SLI metric source type for this SLO. Supported types are:

  • Service operation

  • Service dependency

  • CloudWatch metric

" } } }, @@ -3371,13 +4370,39 @@ "MetricReferences": { "target": "com.amazonaws.applicationsignals#MetricReferences", "traits": { - "smithy.api#documentation": "

An array of structures that each contain information about one metric associated with this service operation\n that was discovered by\n Application Signals.

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

An array of structures that each contain information about one metric associated with this service operation that was discovered by Application Signals.

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

This structure contains information about an operation discovered by Application Signals. An operation\n is a specific function performed by a service that was discovered by Application Signals, and is often an API \n that is called by an upstream dependent.\n

" + "smithy.api#documentation": "

This structure contains information about an operation discovered by Application Signals. An operation is a specific function performed by a service that was discovered by Application Signals, and is often an API that is called by an upstream dependent.

" + } + }, + "com.amazonaws.applicationsignals#ServiceOperationEntity": { + "type": "structure", + "members": { + "Service": { + "target": "com.amazonaws.applicationsignals#ServiceEntity", + "traits": { + "smithy.api#documentation": "

The service entity that contains this operation.

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

The name of the operation.

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

The type of metric associated with this service operation.

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

A structure that contains identifying information for a service operation entity.

" } }, "com.amazonaws.applicationsignals#ServiceOperations": { @@ -3408,6 +4433,45 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.applicationsignals#ServiceState": { + "type": "structure", + "members": { + "AttributeFilters": { + "target": "com.amazonaws.applicationsignals#AttributeFilters", + "traits": { + "smithy.api#documentation": "

The attribute filters that were applied when retrieving this service state information.

" + } + }, + "Service": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

The key attributes that identify this service, including Type, Name, and Environment information.

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

An array containing the most recent change events for this service, such as deployments, with information about when they occurred and who initiated them.

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

A structure that contains information about the current state of a service, including its latest change events such as deployments and other state-changing activities.

" + } + }, + "com.amazonaws.applicationsignals#ServiceStates": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#ServiceState" + }, + "traits": { + "smithy.api#length": { + "max": 250 + } + } + }, "com.amazonaws.applicationsignals#ServiceSummaries": { "type": "list", "member": { @@ -3420,14 +4484,14 @@ "KeyAttributes": { "target": "com.amazonaws.applicationsignals#Attributes", "traits": { - "smithy.api#documentation": "

This is a string-to-string map that help identify the objects discovered by Application Signals. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

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

This is a string-to-string map that help identify the objects discovered by Application Signals. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

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

This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.

\n

Platform attributes contain information the service's platform.

\n
    \n
  • \n

    \n PlatformType defines the hosted-in platform.

    \n
  • \n
  • \n

    \n EKS.Cluster is the name of the Amazon EKS cluster.

    \n
  • \n
  • \n

    \n K8s.Cluster is the name of the self-hosted Kubernetes cluster.

    \n
  • \n
  • \n

    \n K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.

    \n
  • \n
  • \n

    \n EC2.InstanceId is the ID of the Amazon EC2 instance.

    \n
  • \n
  • \n

    \n Host is the name of the host, for all platform types.

    \n
  • \n
\n

Application attributes contain information about the application.

\n
    \n
  • \n

    \n AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.

    \n
  • \n
  • \n

    \n AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.

    \n
  • \n
\n

Telemetry attributes contain telemetry information.

\n
    \n
  • \n

    \n Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.

    \n
  • \n
  • \n

    \n Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.

    \n
  • \n
  • \n

    \n Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

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

This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.

Platform attributes contain information the service's platform.

  • PlatformType defines the hosted-in platform.

  • EKS.Cluster is the name of the Amazon EKS cluster.

  • K8s.Cluster is the name of the self-hosted Kubernetes cluster.

  • K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.

  • K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.

  • K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.

  • K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.

  • EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.

  • EC2.InstanceId is the ID of the Amazon EC2 instance.

  • Host is the name of the host, for all platform types.

Application attributes contain information about the application.

  • AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.

  • AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.

Telemetry attributes contain telemetry information.

  • Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.

  • Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.

  • Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

" } }, "MetricReferences": { @@ -3436,10 +4500,51 @@ "smithy.api#documentation": "

An array of structures that each contain information about one metric associated with this service.

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

An array of service groups that this service belongs to, based on the configured grouping attributes.

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

This structure contains information about one of your services that\n was discovered by Application Signals

" + "smithy.api#documentation": "

This structure contains information about one of your services that was discovered by Application Signals

" + } + }, + "com.amazonaws.applicationsignals#Severity": { + "type": "enum", + "members": { + "CRITICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRITICAL" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } } }, "com.amazonaws.applicationsignals#StandardUnit": { @@ -3629,7 +4734,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables this Amazon Web Services account to be able to use CloudWatch Application Signals \n by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role. This service-\n linked role has the following permissions:

\n
    \n
  • \n

    \n xray:GetServiceGraph\n

    \n
  • \n
  • \n

    \n logs:StartQuery\n

    \n
  • \n
  • \n

    \n logs:GetQueryResults\n

    \n
  • \n
  • \n

    \n cloudwatch:GetMetricData\n

    \n
  • \n
  • \n

    \n cloudwatch:ListMetrics\n

    \n
  • \n
  • \n

    \n tag:GetResources\n

    \n
  • \n
  • \n

    \n autoscaling:DescribeAutoScalingGroups\n

    \n
  • \n
\n

After completing this step, you still need to instrument your Java and Python applications to send data \n to Application Signals. For more information, see \n \n Enabling Application Signals.

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

Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role. This service- linked role has the following permissions:

  • xray:GetServiceGraph

  • logs:StartQuery

  • logs:GetQueryResults

  • cloudwatch:GetMetricData

  • cloudwatch:ListMetrics

  • tag:GetResources

  • autoscaling:DescribeAutoScalingGroups

After completing this step, you still need to instrument your Java and Python applications to send data to Application Signals. For more information, see Enabling Application Signals.

", "smithy.api#http": { "method": "POST", "uri": "/start-discovery", @@ -3660,7 +4765,7 @@ "Key": { "target": "com.amazonaws.applicationsignals#TagKey", "traits": { - "smithy.api#documentation": "

A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your \n resources.

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

A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

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

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.

\n

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

\n

You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, \n this tag is appended to the list of tags associated\n with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n the previous value for that tag.

\n

You can associate as many as 50 tags with a CloudWatch resource.

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

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a CloudWatch resource.

", "smithy.api#http": { "method": "POST", "uri": "/tag-resource", @@ -3743,7 +4848,7 @@ "ResourceArn": { "target": "com.amazonaws.applicationsignals#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch resource that you want to set tags for.

\n

The ARN format of an Application Signals SLO is \n arn:aws:cloudwatch:Region:account-id:slo:slo-name\n \n

\n

For more information about ARN format, see Resource\n Types Defined by Amazon CloudWatch in the Amazon Web Services General\n Reference.

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

The Amazon Resource Name (ARN) of the CloudWatch resource that you want to set tags for.

The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name

For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -3828,7 +4933,7 @@ "ResourceArn": { "target": "com.amazonaws.applicationsignals#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch resource that you want to delete tags from.

\n

The ARN format of an Application Signals SLO is \n arn:aws:cloudwatch:Region:account-id:slo:slo-name\n \n

\n

For more information about ARN format, see Resource\n Types Defined by Amazon CloudWatch in the Amazon Web Services General\n Reference.

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

The Amazon Resource Name (ARN) of the CloudWatch resource that you want to delete tags from.

The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name

For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

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

Updates an existing service level objective (SLO). If you omit parameters, the previous values\n of those parameters are retained.

\n

You cannot change from a period-based SLO to a request-based SLO, \n or change from a request-based SLO to a period-based SLO.

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

Updates an existing service level objective (SLO). If you omit parameters, the previous values of those parameters are retained.

You cannot change from a period-based SLO to a request-based SLO, or change from a request-based SLO to a period-based SLO.

", "smithy.api#http": { "method": "PATCH", "uri": "/slo/{Id}", @@ -3905,19 +5010,19 @@ "RequestBasedSliConfig": { "target": "com.amazonaws.applicationsignals#RequestBasedServiceLevelIndicatorConfig", "traits": { - "smithy.api#documentation": "

If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.

\n

You can't specify both SliConfig and RequestBasedSliConfig in the same operation.

" + "smithy.api#documentation": "

If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.

You can't specify both SliConfig and RequestBasedSliConfig in the same operation.

" } }, "Goal": { "target": "com.amazonaws.applicationsignals#Goal", "traits": { - "smithy.api#documentation": "

A structure that contains the attributes that determine the goal of the SLO. This includes\n the time period for evaluation and the attainment threshold.

" + "smithy.api#documentation": "

A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.

" } }, "BurnRateConfigurations": { "target": "com.amazonaws.applicationsignals#BurnRateConfigurations", "traits": { - "smithy.api#documentation": "

Use this array to create burn rates for this SLO. Each \n burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.

" + "smithy.api#documentation": "

Use this array to create burn rates for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.

" } } }, diff --git a/codegen/sdk/aws-models/applicationcostprofiler.json b/codegen/sdk/aws-models/applicationcostprofiler.json index 2bf05ab4c59..431aa46689b 100644 --- a/codegen/sdk/aws-models/applicationcostprofiler.json +++ b/codegen/sdk/aws-models/applicationcostprofiler.json @@ -539,17 +539,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -563,17 +552,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -587,17 +565,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -611,17 +578,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/apprunner.json b/codegen/sdk/aws-models/apprunner.json index a632a053839..a930ad14227 100644 --- a/codegen/sdk/aws-models/apprunner.json +++ b/codegen/sdk/aws-models/apprunner.json @@ -738,17 +738,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -762,17 +751,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -786,17 +764,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -810,17 +777,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1855,7 +1811,7 @@ "Subnets": { "target": "com.amazonaws.apprunner#StringList", "traits": { - "smithy.api#documentation": "

A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single\n Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

\n \n

\n App Runner currently only provides support for IPv4.\n

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

A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single\n Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

\n \n

\n App Runner only supports subnets of IP address type IPv4 and dual stack (IPv4 and IPv6).

\n
", "smithy.api#required": {} } }, @@ -3989,7 +3945,7 @@ "IpAddressType": { "target": "com.amazonaws.apprunner#IpAddressType", "traits": { - "smithy.api#documentation": "

App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual stack (IPv4 and IPv6) \n for your incoming public network configuration. This is an optional parameter. \n If you do not specify an IpAddressType, it defaults to select IPv4.

\n \n

\n Currently, App Runner supports dual stack for only Public endpoint. Only IPv4 is supported for Private endpoint. \n If you update a service that's using dual-stack Public endpoint to a Private endpoint, your App Runner service will default to support only IPv4 for Private endpoint and fail to receive traffic originating from IPv6 endpoint. \n

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

App Runner provides you with the option to choose between IPv4 and dual stack (IPv4 and IPv6). \n This is an optional parameter. If you do not specify an IpAddressType, it defaults to select IPv4.

" } } }, diff --git a/codegen/sdk/aws-models/appstream.json b/codegen/sdk/aws-models/appstream.json index a974eee47de..00c50828da8 100644 --- a/codegen/sdk/aws-models/appstream.json +++ b/codegen/sdk/aws-models/appstream.json @@ -2042,7 +2042,7 @@ "target": "com.amazonaws.appstream#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance type to use when launching fleet instances. The following instance types are available:

\n
    \n
  • \n

    stream.standard.small

    \n
  • \n
  • \n

    stream.standard.medium

    \n
  • \n
  • \n

    stream.standard.large

    \n
  • \n
  • \n

    stream.standard.xlarge

    \n
  • \n
  • \n

    stream.standard.2xlarge

    \n
  • \n
  • \n

    stream.compute.large

    \n
  • \n
  • \n

    stream.compute.xlarge

    \n
  • \n
  • \n

    stream.compute.2xlarge

    \n
  • \n
  • \n

    stream.compute.4xlarge

    \n
  • \n
  • \n

    stream.compute.8xlarge

    \n
  • \n
  • \n

    stream.memory.large

    \n
  • \n
  • \n

    stream.memory.xlarge

    \n
  • \n
  • \n

    stream.memory.2xlarge

    \n
  • \n
  • \n

    stream.memory.4xlarge

    \n
  • \n
  • \n

    stream.memory.8xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.large

    \n
  • \n
  • \n

    stream.memory.z1d.xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.2xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.3xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.6xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.12xlarge

    \n
  • \n
  • \n

    stream.graphics-design.large

    \n
  • \n
  • \n

    stream.graphics-design.xlarge

    \n
  • \n
  • \n

    stream.graphics-design.2xlarge

    \n
  • \n
  • \n

    stream.graphics-design.4xlarge

    \n
  • \n
  • \n

    stream.graphics-desktop.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.24xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.4xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.8xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.16xlarge

    \n
  • \n
\n

The following instance types are available for Elastic fleets:

\n
    \n
  • \n

    stream.standard.small

    \n
  • \n
  • \n

    stream.standard.medium

    \n
  • \n
  • \n

    stream.standard.large

    \n
  • \n
  • \n

    stream.standard.xlarge

    \n
  • \n
  • \n

    stream.standard.2xlarge

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

The instance type to use when launching fleet instances. The following instance types are available:

\n
    \n
  • \n

    stream.standard.small

    \n
  • \n
  • \n

    stream.standard.medium

    \n
  • \n
  • \n

    stream.standard.large

    \n
  • \n
  • \n

    stream.standard.xlarge

    \n
  • \n
  • \n

    stream.standard.2xlarge

    \n
  • \n
  • \n

    stream.compute.large

    \n
  • \n
  • \n

    stream.compute.xlarge

    \n
  • \n
  • \n

    stream.compute.2xlarge

    \n
  • \n
  • \n

    stream.compute.4xlarge

    \n
  • \n
  • \n

    stream.compute.8xlarge

    \n
  • \n
  • \n

    stream.memory.large

    \n
  • \n
  • \n

    stream.memory.xlarge

    \n
  • \n
  • \n

    stream.memory.2xlarge

    \n
  • \n
  • \n

    stream.memory.4xlarge

    \n
  • \n
  • \n

    stream.memory.8xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.large

    \n
  • \n
  • \n

    stream.memory.z1d.xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.2xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.3xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.6xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.12xlarge

    \n
  • \n
  • \n

    stream.graphics-design.large

    \n
  • \n
  • \n

    stream.graphics-design.xlarge

    \n
  • \n
  • \n

    stream.graphics-design.2xlarge

    \n
  • \n
  • \n

    stream.graphics-design.4xlarge

    \n
  • \n
  • \n

    stream.graphics-desktop.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.24xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.4xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.8xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.24xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6.4xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.large

    \n
  • \n
  • \n

    stream.graphics.g6f.xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.4xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6f.4xlarge

    \n
  • \n
\n

The following instance types are available for Elastic fleets:

\n
    \n
  • \n

    stream.standard.small

    \n
  • \n
  • \n

    stream.standard.medium

    \n
  • \n
  • \n

    stream.standard.large

    \n
  • \n
  • \n

    stream.standard.xlarge

    \n
  • \n
  • \n

    stream.standard.2xlarge

    \n
  • \n
", "smithy.api#required": {} } }, @@ -2247,7 +2247,7 @@ "target": "com.amazonaws.appstream#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance type to use when launching the image builder. The following instance types are available:

\n
    \n
  • \n

    stream.standard.small

    \n
  • \n
  • \n

    stream.standard.medium

    \n
  • \n
  • \n

    stream.standard.large

    \n
  • \n
  • \n

    stream.compute.large

    \n
  • \n
  • \n

    stream.compute.xlarge

    \n
  • \n
  • \n

    stream.compute.2xlarge

    \n
  • \n
  • \n

    stream.compute.4xlarge

    \n
  • \n
  • \n

    stream.compute.8xlarge

    \n
  • \n
  • \n

    stream.memory.large

    \n
  • \n
  • \n

    stream.memory.xlarge

    \n
  • \n
  • \n

    stream.memory.2xlarge

    \n
  • \n
  • \n

    stream.memory.4xlarge

    \n
  • \n
  • \n

    stream.memory.8xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.large

    \n
  • \n
  • \n

    stream.memory.z1d.xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.2xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.3xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.6xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.12xlarge

    \n
  • \n
  • \n

    stream.graphics-design.large

    \n
  • \n
  • \n

    stream.graphics-design.xlarge

    \n
  • \n
  • \n

    stream.graphics-design.2xlarge

    \n
  • \n
  • \n

    stream.graphics-design.4xlarge

    \n
  • \n
  • \n

    stream.graphics-desktop.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.16xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.4xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.8xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.16xlarge

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

The instance type to use when launching the image builder. The following instance types are available:

\n
    \n
  • \n

    stream.standard.small

    \n
  • \n
  • \n

    stream.standard.medium

    \n
  • \n
  • \n

    stream.standard.large

    \n
  • \n
  • \n

    stream.compute.large

    \n
  • \n
  • \n

    stream.compute.xlarge

    \n
  • \n
  • \n

    stream.compute.2xlarge

    \n
  • \n
  • \n

    stream.compute.4xlarge

    \n
  • \n
  • \n

    stream.compute.8xlarge

    \n
  • \n
  • \n

    stream.memory.large

    \n
  • \n
  • \n

    stream.memory.xlarge

    \n
  • \n
  • \n

    stream.memory.2xlarge

    \n
  • \n
  • \n

    stream.memory.4xlarge

    \n
  • \n
  • \n

    stream.memory.8xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.large

    \n
  • \n
  • \n

    stream.memory.z1d.xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.2xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.3xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.6xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.12xlarge

    \n
  • \n
  • \n

    stream.graphics-design.large

    \n
  • \n
  • \n

    stream.graphics-design.xlarge

    \n
  • \n
  • \n

    stream.graphics-design.2xlarge

    \n
  • \n
  • \n

    stream.graphics-design.4xlarge

    \n
  • \n
  • \n

    stream.graphics-desktop.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.16xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.4xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.8xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.24xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.24xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6.4xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.large

    \n
  • \n
  • \n

    stream.graphics.g6f.xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.4xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6f.4xlarge

    \n
  • \n
", "smithy.api#required": {} } }, @@ -5603,7 +5603,7 @@ "target": "com.amazonaws.appstream#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance type to use when launching fleet instances. The following instance types are available:

\n
    \n
  • \n

    stream.standard.small

    \n
  • \n
  • \n

    stream.standard.medium

    \n
  • \n
  • \n

    stream.standard.large

    \n
  • \n
  • \n

    stream.compute.large

    \n
  • \n
  • \n

    stream.compute.xlarge

    \n
  • \n
  • \n

    stream.compute.2xlarge

    \n
  • \n
  • \n

    stream.compute.4xlarge

    \n
  • \n
  • \n

    stream.compute.8xlarge

    \n
  • \n
  • \n

    stream.memory.large

    \n
  • \n
  • \n

    stream.memory.xlarge

    \n
  • \n
  • \n

    stream.memory.2xlarge

    \n
  • \n
  • \n

    stream.memory.4xlarge

    \n
  • \n
  • \n

    stream.memory.8xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.large

    \n
  • \n
  • \n

    stream.memory.z1d.xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.2xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.3xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.6xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.12xlarge

    \n
  • \n
  • \n

    stream.graphics-design.large

    \n
  • \n
  • \n

    stream.graphics-design.xlarge

    \n
  • \n
  • \n

    stream.graphics-design.2xlarge

    \n
  • \n
  • \n

    stream.graphics-design.4xlarge

    \n
  • \n
  • \n

    stream.graphics-desktop.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.16xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.4xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.8xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.16xlarge

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

The instance type to use when launching fleet instances. The following instance types are available:

\n
    \n
  • \n

    stream.standard.small

    \n
  • \n
  • \n

    stream.standard.medium

    \n
  • \n
  • \n

    stream.standard.large

    \n
  • \n
  • \n

    stream.compute.large

    \n
  • \n
  • \n

    stream.compute.xlarge

    \n
  • \n
  • \n

    stream.compute.2xlarge

    \n
  • \n
  • \n

    stream.compute.4xlarge

    \n
  • \n
  • \n

    stream.compute.8xlarge

    \n
  • \n
  • \n

    stream.memory.large

    \n
  • \n
  • \n

    stream.memory.xlarge

    \n
  • \n
  • \n

    stream.memory.2xlarge

    \n
  • \n
  • \n

    stream.memory.4xlarge

    \n
  • \n
  • \n

    stream.memory.8xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.large

    \n
  • \n
  • \n

    stream.memory.z1d.xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.2xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.3xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.6xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.12xlarge

    \n
  • \n
  • \n

    stream.graphics-design.large

    \n
  • \n
  • \n

    stream.graphics-design.xlarge

    \n
  • \n
  • \n

    stream.graphics-design.2xlarge

    \n
  • \n
  • \n

    stream.graphics-design.4xlarge

    \n
  • \n
  • \n

    stream.graphics-desktop.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.16xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.4xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.8xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.24xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.24xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6.4xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.large

    \n
  • \n
  • \n

    stream.graphics.g6f.xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.4xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6f.4xlarge

    \n
  • \n
", "smithy.api#required": {} } }, @@ -6105,7 +6105,7 @@ "ImageBuilderName": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The name of the image builder that was used to create the private image. If the image is shared, this value is null.

" + "smithy.api#documentation": "

The name of the image builder that was used to create the private image. If the image is shared, copied, or updated by using Managed Image Updates, this value is null.

" } }, "Platform": { @@ -6235,7 +6235,7 @@ "InstanceType": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The instance type for the image builder. The following instance types are available:

\n
    \n
  • \n

    stream.standard.small

    \n
  • \n
  • \n

    stream.standard.medium

    \n
  • \n
  • \n

    stream.standard.large

    \n
  • \n
  • \n

    stream.compute.large

    \n
  • \n
  • \n

    stream.compute.xlarge

    \n
  • \n
  • \n

    stream.compute.2xlarge

    \n
  • \n
  • \n

    stream.compute.4xlarge

    \n
  • \n
  • \n

    stream.compute.8xlarge

    \n
  • \n
  • \n

    stream.memory.large

    \n
  • \n
  • \n

    stream.memory.xlarge

    \n
  • \n
  • \n

    stream.memory.2xlarge

    \n
  • \n
  • \n

    stream.memory.4xlarge

    \n
  • \n
  • \n

    stream.memory.8xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.large

    \n
  • \n
  • \n

    stream.memory.z1d.xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.2xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.3xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.6xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.12xlarge

    \n
  • \n
  • \n

    stream.graphics-design.large

    \n
  • \n
  • \n

    stream.graphics-design.xlarge

    \n
  • \n
  • \n

    stream.graphics-design.2xlarge

    \n
  • \n
  • \n

    stream.graphics-design.4xlarge

    \n
  • \n
  • \n

    stream.graphics-desktop.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.16xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.4xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.8xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.16xlarge

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

The instance type for the image builder. The following instance types are available:

\n
    \n
  • \n

    stream.standard.small

    \n
  • \n
  • \n

    stream.standard.medium

    \n
  • \n
  • \n

    stream.standard.large

    \n
  • \n
  • \n

    stream.compute.large

    \n
  • \n
  • \n

    stream.compute.xlarge

    \n
  • \n
  • \n

    stream.compute.2xlarge

    \n
  • \n
  • \n

    stream.compute.4xlarge

    \n
  • \n
  • \n

    stream.compute.8xlarge

    \n
  • \n
  • \n

    stream.memory.large

    \n
  • \n
  • \n

    stream.memory.xlarge

    \n
  • \n
  • \n

    stream.memory.2xlarge

    \n
  • \n
  • \n

    stream.memory.4xlarge

    \n
  • \n
  • \n

    stream.memory.8xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.large

    \n
  • \n
  • \n

    stream.memory.z1d.xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.2xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.3xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.6xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.12xlarge

    \n
  • \n
  • \n

    stream.graphics-design.large

    \n
  • \n
  • \n

    stream.graphics-design.xlarge

    \n
  • \n
  • \n

    stream.graphics-design.2xlarge

    \n
  • \n
  • \n

    stream.graphics-design.4xlarge

    \n
  • \n
  • \n

    stream.graphics-desktop.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.16xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.4xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.8xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.24xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.24xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6.4xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.large

    \n
  • \n
  • \n

    stream.graphics.g6f.xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.4xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6f.4xlarge

    \n
  • \n
" } }, "Platform": { @@ -7990,17 +7990,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -8014,17 +8003,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -8038,17 +8016,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -8062,17 +8029,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -10121,7 +10077,7 @@ "InstanceType": { "target": "com.amazonaws.appstream#String", "traits": { - "smithy.api#documentation": "

The instance type to use when launching fleet instances. The following instance types are available:

\n
    \n
  • \n

    stream.standard.small

    \n
  • \n
  • \n

    stream.standard.medium

    \n
  • \n
  • \n

    stream.standard.large

    \n
  • \n
  • \n

    stream.standard.xlarge

    \n
  • \n
  • \n

    stream.standard.2xlarge

    \n
  • \n
  • \n

    stream.compute.large

    \n
  • \n
  • \n

    stream.compute.xlarge

    \n
  • \n
  • \n

    stream.compute.2xlarge

    \n
  • \n
  • \n

    stream.compute.4xlarge

    \n
  • \n
  • \n

    stream.compute.8xlarge

    \n
  • \n
  • \n

    stream.memory.large

    \n
  • \n
  • \n

    stream.memory.xlarge

    \n
  • \n
  • \n

    stream.memory.2xlarge

    \n
  • \n
  • \n

    stream.memory.4xlarge

    \n
  • \n
  • \n

    stream.memory.8xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.large

    \n
  • \n
  • \n

    stream.memory.z1d.xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.2xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.3xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.6xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.12xlarge

    \n
  • \n
  • \n

    stream.graphics-design.large

    \n
  • \n
  • \n

    stream.graphics-design.xlarge

    \n
  • \n
  • \n

    stream.graphics-design.2xlarge

    \n
  • \n
  • \n

    stream.graphics-design.4xlarge

    \n
  • \n
  • \n

    stream.graphics-desktop.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.16xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.4xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.8xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.16xlarge

    \n
  • \n
\n

The following instance types are available for Elastic fleets:

\n
    \n
  • \n

    stream.standard.small

    \n
  • \n
  • \n

    stream.standard.medium

    \n
  • \n
  • \n

    stream.standard.large

    \n
  • \n
  • \n

    stream.standard.xlarge

    \n
  • \n
  • \n

    stream.standard.2xlarge

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

The instance type to use when launching fleet instances. The following instance types are available:

\n
    \n
  • \n

    stream.standard.small

    \n
  • \n
  • \n

    stream.standard.medium

    \n
  • \n
  • \n

    stream.standard.large

    \n
  • \n
  • \n

    stream.standard.xlarge

    \n
  • \n
  • \n

    stream.standard.2xlarge

    \n
  • \n
  • \n

    stream.compute.large

    \n
  • \n
  • \n

    stream.compute.xlarge

    \n
  • \n
  • \n

    stream.compute.2xlarge

    \n
  • \n
  • \n

    stream.compute.4xlarge

    \n
  • \n
  • \n

    stream.compute.8xlarge

    \n
  • \n
  • \n

    stream.memory.large

    \n
  • \n
  • \n

    stream.memory.xlarge

    \n
  • \n
  • \n

    stream.memory.2xlarge

    \n
  • \n
  • \n

    stream.memory.4xlarge

    \n
  • \n
  • \n

    stream.memory.8xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.large

    \n
  • \n
  • \n

    stream.memory.z1d.xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.2xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.3xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.6xlarge

    \n
  • \n
  • \n

    stream.memory.z1d.12xlarge

    \n
  • \n
  • \n

    stream.graphics-design.large

    \n
  • \n
  • \n

    stream.graphics-design.xlarge

    \n
  • \n
  • \n

    stream.graphics-design.2xlarge

    \n
  • \n
  • \n

    stream.graphics-design.4xlarge

    \n
  • \n
  • \n

    stream.graphics-desktop.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g4dn.16xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.4xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.8xlarge

    \n
  • \n
  • \n

    stream.graphics-pro.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g5.24xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.4xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.16xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.12xlarge

    \n
  • \n
  • \n

    stream.graphics.g6.24xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6.4xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6.8xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.large

    \n
  • \n
  • \n

    stream.graphics.g6f.xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.2xlarge

    \n
  • \n
  • \n

    stream.graphics.g6f.4xlarge

    \n
  • \n
  • \n

    stream.graphics.gr6f.4xlarge

    \n
  • \n
\n

The following instance types are available for Elastic fleets:

\n
    \n
  • \n

    stream.standard.small

    \n
  • \n
  • \n

    stream.standard.medium

    \n
  • \n
  • \n

    stream.standard.large

    \n
  • \n
  • \n

    stream.standard.xlarge

    \n
  • \n
  • \n

    stream.standard.2xlarge

    \n
  • \n
" } }, "ComputeCapacity": { diff --git a/codegen/sdk/aws-models/appsync.json b/codegen/sdk/aws-models/appsync.json index 9bf4842142f..9df5557042d 100644 --- a/codegen/sdk/aws-models/appsync.json +++ b/codegen/sdk/aws-models/appsync.json @@ -1005,17 +1005,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1029,17 +1018,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1053,17 +1031,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1077,17 +1044,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/apptest.json b/codegen/sdk/aws-models/apptest.json index a80d7cc7c51..7e4e235b8bd 100644 --- a/codegen/sdk/aws-models/apptest.json +++ b/codegen/sdk/aws-models/apptest.json @@ -601,17 +601,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -625,17 +614,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -649,17 +627,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -673,17 +640,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/arc-region-switch.json b/codegen/sdk/aws-models/arc-region-switch.json index 111f67aa23b..5a4ef1bd3f9 100644 --- a/codegen/sdk/aws-models/arc-region-switch.json +++ b/codegen/sdk/aws-models/arc-region-switch.json @@ -420,7 +420,7 @@ "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#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.

For more information, see Region switch in ARC in the Amazon Application Recovery Controller User Guide.

", "smithy.api#title": "ARC - Region switch", "smithy.protocols#rpcv2Cbor": {}, "smithy.rules#endpointRuleSet": { @@ -953,102 +953,6 @@ "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": { diff --git a/codegen/sdk/aws-models/arc-zonal-shift.json b/codegen/sdk/aws-models/arc-zonal-shift.json index 5a2376bad4d..4539d81bf39 100644 --- a/codegen/sdk/aws-models/arc-zonal-shift.json +++ b/codegen/sdk/aws-models/arc-zonal-shift.json @@ -14,6 +14,28 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.arczonalshift#AllowedWindow": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 19, + "max": 19 + }, + "smithy.api#pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):[0-9]{2}:[0-9]{2}-(Mon|Tue|Wed|Thu|Fri|Sat|Sun):[0-9]{2}:[0-9]{2}$" + } + }, + "com.amazonaws.arczonalshift#AllowedWindows": { + "type": "list", + "member": { + "target": "com.amazonaws.arczonalshift#AllowedWindow" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + } + } + }, "com.amazonaws.arczonalshift#AppliedStatus": { "type": "enum", "members": { @@ -247,6 +269,18 @@ } } }, + "com.amazonaws.arczonalshift#BlockingAlarms": { + "type": "list", + "member": { + "target": "com.amazonaws.arczonalshift#ControlCondition" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.arczonalshift#CancelPracticeRun": { "type": "operation", "input": { @@ -518,6 +552,12 @@ "traits": { "smithy.api#enumValue": "PracticeInBlockedWindows" } + }, + "PRACTICE_OUTSIDE_ALLOWED_WINDOWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PracticeOutsideAllowedWindows" + } } } }, @@ -554,18 +594,6 @@ } } }, - "com.amazonaws.arczonalshift#ControlConditions": { - "type": "list", - "member": { - "target": "com.amazonaws.arczonalshift#ControlCondition" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, "com.amazonaws.arczonalshift#CreatePracticeRunConfiguration": { "type": "operation", "input": { @@ -616,7 +644,7 @@ "blockedWindows": { "target": "com.amazonaws.arczonalshift#BlockedWindows", "traits": { - "smithy.api#documentation": "

Optionally, you can block ARC from starting practice runs for specific windows of days and times.

The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.

For example, say you run business report summaries three days a week. For this scenario, you might set the following recurring days and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30.

" + "smithy.api#documentation": "

Optionally, you can block ARC from starting practice runs for specific windows of days and times.

The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.

For example, say you run business report summaries three days a week. For this scenario, you could set the following recurring days and times as blocked windows, for example: Mon:00:00-Mon:10:00 Wed-20:30-Wed:21:30 Fri-20:30-Fri:21:30.

The blockedWindows have to start and end on the same day. Windows that span multiple days aren't supported.

" } }, "blockedDates": { @@ -626,15 +654,21 @@ } }, "blockingAlarms": { - "target": "com.amazonaws.arczonalshift#ControlConditions", + "target": "com.amazonaws.arczonalshift#BlockingAlarms", "traits": { - "smithy.api#documentation": "

An Amazon CloudWatch alarm that you can specify for zonal autoshift practice runs. This alarm blocks ARC from starting practice run zonal shifts, and ends a practice run that's in progress, when the alarm is in an ALARM state.

" + "smithy.api#documentation": "

Blocking alarms for practice runs are optional alarms that you can specify that block practice runs when one or more of the alarms is in an ALARM state.

" + } + }, + "allowedWindows": { + "target": "com.amazonaws.arczonalshift#AllowedWindows", + "traits": { + "smithy.api#documentation": "

Optionally, you can allow ARC to start practice runs for specific windows of days and times.

The format for allowed windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple allowed windows with spaces.

For example, say you want to allow practice runs only on Wednesdays and Fridays from noon to 5 p.m. For this scenario, you could set the following recurring days and times as allowed windows, for example: Wed-12:00-Wed:17:00 Fri-12:00-Fri:17:00.

The allowedWindows have to start and end on the same day. Windows that span multiple days aren't supported.

" } }, "outcomeAlarms": { - "target": "com.amazonaws.arczonalshift#ControlConditions", + "target": "com.amazonaws.arczonalshift#OutcomeAlarms", "traits": { - "smithy.api#documentation": "

The outcome alarm for practice runs is a required Amazon CloudWatch alarm that you specify that ends a practice run when the alarm is in an ALARM state.

Configure the alarm to monitor the health of your application when traffic is shifted away from an Availability Zone during each practice run. You should configure the alarm to go into an ALARM state if your application is impacted by the zonal shift, and you want to stop the zonal shift, to let traffic for the resource return to the Availability Zone.

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

Outcome alarms for practice runs are alarms that you specify that end a practice run when one or more of the alarms is in an ALARM state.

Configure one or more of these alarms to monitor the health of your application when traffic is shifted away from an Availability Zone during each practice run. You should configure these alarms to go into an ALARM state if you want to stop a zonal shift, to let traffic for the resource return to the original Availability Zone.

", "smithy.api#required": {} } } @@ -1325,6 +1359,18 @@ "smithy.api#pattern": "^.*$" } }, + "com.amazonaws.arczonalshift#OutcomeAlarms": { + "type": "list", + "member": { + "target": "com.amazonaws.arczonalshift#ControlCondition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.arczonalshift#PercDataPlane": { "type": "service", "version": "2022-10-30", @@ -1893,17 +1939,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1917,17 +1952,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1941,17 +1965,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1965,17 +1978,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2055,22 +2057,28 @@ "type": "structure", "members": { "blockingAlarms": { - "target": "com.amazonaws.arczonalshift#ControlConditions", + "target": "com.amazonaws.arczonalshift#BlockingAlarms", "traits": { - "smithy.api#documentation": "

The blocking alarm for practice runs is an optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state.

" + "smithy.api#documentation": "

Blocking alarms for practice runs are optional alarms that you can specify that block practice runs when one or more of the alarms is in an ALARM state.

" } }, "outcomeAlarms": { - "target": "com.amazonaws.arczonalshift#ControlConditions", + "target": "com.amazonaws.arczonalshift#OutcomeAlarms", "traits": { - "smithy.api#documentation": "

The outcome alarm for practice runs is an alarm that you specify that ends a practice run when the alarm is in an ALARM state.

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

Outcome alarms for practice runs are alarms that you specify that end a practice run when one or more of the alarms is in an ALARM state.

", "smithy.api#required": {} } }, "blockedWindows": { "target": "com.amazonaws.arczonalshift#BlockedWindows", "traits": { - "smithy.api#documentation": "

An array of one or more windows of days and times that you can block ARC from starting practice runs for a resource.

Specify the blocked windows in UTC, using the format DAY:HH:MM-DAY:HH:MM, separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30.

" + "smithy.api#documentation": "

An array of one or more windows of days and times that you can block ARC from starting practice runs for a resource.

Specify the blocked windows in UTC, using the format DAY:HH:MM-DAY:HH:MM, separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30.

The blockedWindows have to start and end on the same day. Windows that span multiple days aren't supported.

" + } + }, + "allowedWindows": { + "target": "com.amazonaws.arczonalshift#AllowedWindows", + "traits": { + "smithy.api#documentation": "

An array of one or more windows of days and times that you can allow ARC to start practice runs for a resource.

For example, say you want to allow practice runs only on Wednesdays and Fridays from noon to 5 p.m. For this scenario, you could set the following recurring days and times as allowed windows, for example: Wed-12:00-Wed:17:00 Fri-12:00-Fri:17:00.

The allowedWindows have to start and end on the same day. Windows that span multiple days aren't supported.

" } }, "blockedDates": { @@ -2567,15 +2575,21 @@ } }, "blockingAlarms": { - "target": "com.amazonaws.arczonalshift#ControlConditions", + "target": "com.amazonaws.arczonalshift#BlockingAlarms", "traits": { - "smithy.api#documentation": "

Add, change, or remove the Amazon CloudWatch alarm that you optionally specify as the blocking alarm for practice runs.

" + "smithy.api#documentation": "

Add, change, or remove the Amazon CloudWatch alarms that you optionally specify as the blocking alarms for practice runs.

" + } + }, + "allowedWindows": { + "target": "com.amazonaws.arczonalshift#AllowedWindows", + "traits": { + "smithy.api#documentation": "

Add, change, or remove windows of days and times for when you can, optionally, allow ARC to start a practice run for a resource.

The format for allowed windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple allowed windows with spaces.

For example, say you want to allow practice runs only on Wednesdays and Fridays from noon to 5 p.m. For this scenario, you could set the following recurring days and times as allowed windows, for example: Wed-12:00-Wed:17:00 Fri-12:00-Fri:17:00.

The allowedWindows have to start and end on the same day. Windows that span multiple days aren't supported.

" } }, "outcomeAlarms": { - "target": "com.amazonaws.arczonalshift#ControlConditions", + "target": "com.amazonaws.arczonalshift#OutcomeAlarms", "traits": { - "smithy.api#documentation": "

Specify a new the Amazon CloudWatch alarm as the outcome alarm for practice runs.

" + "smithy.api#documentation": "

Specify one or more Amazon CloudWatch alarms as the outcome alarms for practice runs.

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

The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuation, ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.

You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED, you authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.

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

The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuration, ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.

You can update the zonal autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED, you authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.

", "smithy.api#http": { "method": "PUT", "uri": "/managedresources/{resourceIdentifier}", @@ -2880,6 +2894,18 @@ "traits": { "smithy.api#enumValue": "UnsupportedPracticeCancelShiftType" } + }, + "INVALID_PRACTICE_ALLOWED_WINDOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidPracticeAllowedWindow" + } + }, + "CONFLICTING_PRACTICE_WINDOWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidPracticeWindows" + } } } }, diff --git a/codegen/sdk/aws-models/artifact.json b/codegen/sdk/aws-models/artifact.json index 1eaacfd2fff..8567d57e38e 100644 --- a/codegen/sdk/aws-models/artifact.json +++ b/codegen/sdk/aws-models/artifact.json @@ -786,17 +786,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -818,17 +807,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -850,17 +828,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -882,17 +849,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -914,17 +870,6 @@ "UseDualStack": false } }, - { - "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": { @@ -946,17 +891,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -979,18 +913,28 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://artifact-fips.us-isof-south-1.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -1001,43 +945,53 @@ } ] }, - "url": "https://artifact-fips.us-isof-south-1.csp.hci.ic.gov" + "url": "https://artifact.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eusc-de-east-1" + } + ] + }, + "url": "https://artifact-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingRegion": "us-isof-south-1" + "signingRegion": "eusc-de-east-1" } ] }, - "url": "https://artifact.us-isof-south-1.csp.hci.ic.gov" + "url": "https://artifact.eusc-de-east-1.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } diff --git a/codegen/sdk/aws-models/athena.json b/codegen/sdk/aws-models/athena.json index 5ebd84f95e8..6342089aa20 100644 --- a/codegen/sdk/aws-models/athena.json +++ b/codegen/sdk/aws-models/athena.json @@ -1094,17 +1094,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1118,17 +1107,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1142,17 +1120,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1166,17 +1133,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/auditmanager.json b/codegen/sdk/aws-models/auditmanager.json index 2df4cbf4867..b978cce2207 100644 --- a/codegen/sdk/aws-models/auditmanager.json +++ b/codegen/sdk/aws-models/auditmanager.json @@ -2554,17 +2554,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2578,17 +2567,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2602,17 +2580,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2626,17 +2593,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/auto-scaling-plans.json b/codegen/sdk/aws-models/auto-scaling-plans.json index a6869afb63d..2b9caed1c29 100644 --- a/codegen/sdk/aws-models/auto-scaling-plans.json +++ b/codegen/sdk/aws-models/auto-scaling-plans.json @@ -838,17 +838,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -862,17 +851,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -886,17 +864,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -910,17 +877,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/auto-scaling.json b/codegen/sdk/aws-models/auto-scaling.json index 7f184728002..85c4b784638 100644 --- a/codegen/sdk/aws-models/auto-scaling.json +++ b/codegen/sdk/aws-models/auto-scaling.json @@ -2188,17 +2188,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2212,17 +2201,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2236,17 +2214,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2260,17 +2227,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -2625,6 +2581,9 @@ "target": "com.amazonaws.autoscaling#BlockDeviceMapping" } }, + "com.amazonaws.autoscaling#BooleanType": { + "type": "boolean" + }, "com.amazonaws.autoscaling#BurstablePerformance": { "type": "enum", "members": { @@ -2704,6 +2663,12 @@ "smithy.api#documentation": "

The name of the Auto Scaling group.

", "smithy.api#required": {} } + }, + "WaitForTransitioningInstances": { + "target": "com.amazonaws.autoscaling#BooleanType", + "traits": { + "smithy.api#documentation": "

When cancelling an instance refresh, this indicates whether to wait for in-flight launches \n and terminations to complete. The default is true.

\n

When set to false, Amazon EC2 Auto Scaling cancels the instance refresh \n without waiting for any pending launches or terminations to complete.

" + } } } }, diff --git a/codegen/sdk/aws-models/b2bi.json b/codegen/sdk/aws-models/b2bi.json index d8a2e61c77b..e77a6cc5d98 100644 --- a/codegen/sdk/aws-models/b2bi.json +++ b/codegen/sdk/aws-models/b2bi.json @@ -611,17 +611,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -635,17 +624,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -659,17 +637,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -683,17 +650,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -953,6 +909,12 @@ } } }, + "com.amazonaws.b2bi#CodeList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, "com.amazonaws.b2bi#ConflictException": { "type": "structure", "members": { @@ -1029,6 +991,9 @@ "traits": { "smithy.api#documentation": "Customer uses this to provide a sample on what should file look like after conversion\nX12 EDI use case around this would be discovering the file syntax" } + }, + "advancedOptions": { + "target": "com.amazonaws.b2bi#AdvancedOptions" } }, "traits": { @@ -1853,6 +1818,45 @@ "transactionSet": "X12_110", "version": "VERSION_4010" } + }, + "advancedOptions": { + "x12": { + "splitOptions": { + "splitBy": "NONE" + }, + "validationOptions": { + "validationRules": [ + { + "codeListValidationRule": { + "elementId": "1234", + "codesToAdd": [ + "A", + "B", + "C" + ], + "codesToRemove": [ + "X", + "Y", + "Z" + ] + } + }, + { + "elementRequirementValidationRule": { + "elementPosition": "NM1-01", + "requirement": "MANDATORY" + } + }, + { + "elementLengthValidationRule": { + "elementId": "5678", + "maxLength": 10, + "minLength": 2 + } + } + ] + } + } } }, "mapping": { @@ -1884,6 +1888,45 @@ "transactionSet": "X12_110", "version": "VERSION_4010" } + }, + "advancedOptions": { + "x12": { + "splitOptions": { + "splitBy": "NONE" + }, + "validationOptions": { + "validationRules": [ + { + "codeListValidationRule": { + "elementId": "1234", + "codesToAdd": [ + "A", + "B", + "C" + ], + "codesToRemove": [ + "X", + "Y", + "Z" + ] + } + }, + { + "elementRequirementValidationRule": { + "elementPosition": "NM1-01", + "requirement": "MANDATORY" + } + }, + { + "elementLengthValidationRule": { + "elementId": "5678", + "maxLength": 10, + "minLength": 2 + } + } + ] + } + } } }, "mapping": { @@ -2422,6 +2465,35 @@ "smithy.api#documentation": "

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

" } }, + "com.amazonaws.b2bi#ElementId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A string type representing an X12 element ID. Element IDs are four-digit numeric identifiers that uniquely identify elements within the X12 standard. This type enforces a pattern of exactly four digits to ensure valid element IDs are used in validation rules.

" + } + }, + "com.amazonaws.b2bi#ElementPosition": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A string type representing the position of an element within an X12 segment. The format follows the pattern of segment identifier followed by element position (e.g., \"ST-01\" for the first element of the ST segment) and optionally a component position (e.g., \"ST-01-02\" for the second component of the first element). This type is used in validation rules to precisely identify which element in which position is being validated.

" + } + }, + "com.amazonaws.b2bi#ElementRequirement": { + "type": "enum", + "members": { + "OPTIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPTIONAL" + } + }, + "MANDATORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANDATORY" + } + } + } + }, "com.amazonaws.b2bi#Email": { "type": "string", "traits": { @@ -3105,6 +3177,45 @@ "transactionSet": "X12_110", "version": "VERSION_4010" } + }, + "advancedOptions": { + "x12": { + "splitOptions": { + "splitBy": "NONE" + }, + "validationOptions": { + "validationRules": [ + { + "codeListValidationRule": { + "elementId": "1234", + "codesToAdd": [ + "A", + "B", + "C" + ], + "codesToRemove": [ + "X", + "Y", + "Z" + ] + } + }, + { + "elementRequirementValidationRule": { + "elementPosition": "NM1-01", + "requirement": "MANDATORY" + } + }, + { + "elementLengthValidationRule": { + "elementId": "5678", + "maxLength": 10, + "minLength": 2 + } + } + ] + } + } } }, "mapping": { @@ -4167,6 +4278,9 @@ "traits": { "smithy.api#documentation": "

A structure that contains the X12 transaction set and version for the transformer output.

" } + }, + "advancedOptions": { + "target": "com.amazonaws.b2bi#AdvancedOptions" } }, "traits": { @@ -4928,6 +5042,42 @@ "transactionSet": "X12_110", "version": "VERSION_4010" } + }, + "advancedOptions": { + "x12": { + "validationOptions": { + "validationRules": [ + { + "codeListValidationRule": { + "elementId": "1280", + "codesToAdd": [ + "X", + "Y", + "Z" + ], + "codesToRemove": [ + "A", + "B", + "C" + ] + } + }, + { + "elementRequirementValidationRule": { + "elementPosition": "NM1-01", + "requirement": "OPTIONAL" + } + }, + { + "elementLengthValidationRule": { + "elementId": "0803", + "maxLength": 30, + "minLength": 5 + } + } + ] + } + } } } }, @@ -4980,7 +5130,7 @@ "validationMessages": { "target": "com.amazonaws.b2bi#ValidationMessages", "traits": { - "smithy.api#documentation": "

Returns an array of strings, each containing a message that Amazon Web Services B2B Data Interchange generates during the conversion.

" + "smithy.api#documentation": "

Returns an array of validation messages that Amazon Web Services B2B Data Interchange generates during the conversion process. These messages include both standard EDI validation results and custom validation messages when custom validation rules are configured. Custom validation messages provide detailed feedback on element length constraints, code list validations, and element requirement checks applied during the outbound EDI generation process.

" } } }, @@ -5191,6 +5341,65 @@ "sample split parsed file content" ] } + }, + { + "title": "Sample TestParsing call with Validation Options", + "input": { + "ediType": { + "x12Details": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "fileFormat": "JSON", + "advancedOptions": { + "x12": { + "validationOptions": { + "validationRules": [ + { + "codeListValidationRule": { + "elementId": "1280", + "codesToAdd": [ + "X", + "Y", + "Z" + ], + "codesToRemove": [ + "A", + "B", + "C" + ] + } + }, + { + "elementRequirementValidationRule": { + "elementPosition": "NM1-01", + "requirement": "OPTIONAL" + } + }, + { + "elementLengthValidationRule": { + "elementId": "0803", + "maxLength": 30, + "minLength": 5 + } + } + ] + } + } + }, + "inputFile": { + "bucketName": "test-bucket", + "key": "sampleFile.txt" + } + }, + "output": { + "parsedFileContent": "", + "parsedSplitFileContents": [ + "sample split parsed file content", + "sample split parsed file content" + ] + } } ], "smithy.api#http": { @@ -5251,6 +5460,12 @@ "traits": { "smithy.api#documentation": "

Returns an array of parsed file contents when the input file is split according to the specified split options. Each element in the array represents a separate split file's parsed content.

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

Returns an array of validation messages generated during EDI validation. These messages provide detailed information about validation errors, warnings, or confirmations based on the configured X12 validation rules such as element length constraints, code list validations, and element requirement checks. This field is populated when the TestParsing API validates EDI documents.

" + } } }, "traits": { @@ -6212,6 +6427,45 @@ "transactionSet": "X12_110", "version": "VERSION_4010" } + }, + "advancedOptions": { + "x12": { + "splitOptions": { + "splitBy": "NONE" + }, + "validationOptions": { + "validationRules": [ + { + "codeListValidationRule": { + "elementId": "1234", + "codesToAdd": [ + "A", + "B", + "C" + ], + "codesToRemove": [ + "X", + "Y", + "Z" + ] + } + }, + { + "elementRequirementValidationRule": { + "elementPosition": "NM1-01", + "requirement": "MANDATORY" + } + }, + { + "elementLengthValidationRule": { + "elementId": "5678", + "maxLength": 10, + "minLength": 2 + } + } + ] + } + } } }, "mapping": { @@ -6241,6 +6495,45 @@ "transactionSet": "X12_110", "version": "VERSION_4010" } + }, + "advancedOptions": { + "x12": { + "splitOptions": { + "splitBy": "NONE" + }, + "validationOptions": { + "validationRules": [ + { + "codeListValidationRule": { + "elementId": "1234", + "codesToAdd": [ + "A", + "B", + "C" + ], + "codesToRemove": [ + "X", + "Y", + "Z" + ] + } + }, + { + "elementRequirementValidationRule": { + "elementPosition": "NM1-01", + "requirement": "MANDATORY" + } + }, + { + "elementLengthValidationRule": { + "elementId": "5678", + "maxLength": 10, + "minLength": 2 + } + } + ] + } + } } }, "mapping": { @@ -6482,7 +6775,7 @@ } }, "traits": { - "smithy.api#documentation": "

Occurs when a B2BI object cannot be validated against a request from another object.

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

Occurs when a B2BI object cannot be validated against a request from another object. This exception can be thrown during standard EDI validation or when custom validation rules fail, such as when element length constraints are violated, invalid codes are used in code list validations, or required elements are missing based on configured element requirement rules.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6583,6 +6876,12 @@ "traits": { "smithy.api#documentation": "

Specifies options for splitting X12 EDI files. These options control how large X12 files are divided into smaller, more manageable units.

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

Specifies validation options for X12 EDI processing. These options control how validation rules are applied during EDI document processing, including custom validation rules for element length constraints, code list validations, and element requirement checks.

" + } } }, "traits": { @@ -6609,6 +6908,33 @@ "smithy.api#pattern": "^[a-zA-Z0-9 ]*$" } }, + "com.amazonaws.b2bi#X12CodeListValidationRule": { + "type": "structure", + "members": { + "elementId": { + "target": "com.amazonaws.b2bi#ElementId", + "traits": { + "smithy.api#documentation": "

Specifies the four-digit element ID to which the code list modifications apply. This identifies which X12 element will have its allowed code values modified.

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

Specifies a list of code values to add to the element's allowed values. These codes will be considered valid for the specified element in addition to the standard codes defined by the X12 specification.

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

Specifies a list of code values to remove from the element's allowed values. These codes will be considered invalid for the specified element, even if they are part of the standard codes defined by the X12 specification.

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

Defines a validation rule that modifies the allowed code values for a specific X12 element. This rule allows you to add or remove valid codes from an element's standard code list, providing flexibility to accommodate trading partner-specific requirements or industry variations. You can specify codes to add to expand the allowed values beyond the X12 standard, or codes to remove to restrict the allowed values for stricter validation.

" + } + }, "com.amazonaws.b2bi#X12ComponentSeparator": { "type": "string", "traits": { @@ -6701,6 +7027,65 @@ "smithy.api#documentation": "

A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.

If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.

" } }, + "com.amazonaws.b2bi#X12ElementLengthValidationRule": { + "type": "structure", + "members": { + "elementId": { + "target": "com.amazonaws.b2bi#ElementId", + "traits": { + "smithy.api#documentation": "

Specifies the four-digit element ID to which the length constraints will be applied. This identifies which X12 element will have its length requirements modified.

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

Specifies the maximum allowed length for the identified element. This value must be between 1 and 200 characters and defines the upper limit for the element's content length.

", + "smithy.api#range": { + "min": 1, + "max": 1000000 + }, + "smithy.api#required": {} + } + }, + "minLength": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Specifies the minimum required length for the identified element. This value must be between 1 and 200 characters and defines the lower limit for the element's content length.

", + "smithy.api#range": { + "min": 1, + "max": 1000000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines a validation rule that specifies custom length constraints for a specific X12 element. This rule allows you to override the standard minimum and maximum length requirements for an element, enabling validation of trading partner-specific length requirements that may differ from the X12 specification. Both minimum and maximum length values must be specified and must be between 1 and 200 characters.

" + } + }, + "com.amazonaws.b2bi#X12ElementRequirementValidationRule": { + "type": "structure", + "members": { + "elementPosition": { + "target": "com.amazonaws.b2bi#ElementPosition", + "traits": { + "smithy.api#documentation": "

Specifies the position of the element within an X12 segment for which the requirement status will be modified. The format follows the pattern of segment identifier followed by element position (e.g., \"ST-01\" for the first element of the ST segment).

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

Specifies the requirement status for the element at the specified position. Valid values are OPTIONAL (the element may be omitted) or MANDATORY (the element must be present).

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

Defines a validation rule that modifies the requirement status of a specific X12 element within a segment. This rule allows you to make optional elements mandatory or mandatory elements optional, providing flexibility to accommodate different trading partner requirements and business rules. The rule targets a specific element position within a segment and sets its requirement status to either OPTIONAL or MANDATORY.

" + } + }, "com.amazonaws.b2bi#X12Envelope": { "type": "structure", "members": { @@ -6891,7 +7276,7 @@ "validateEdi": { "target": "com.amazonaws.b2bi#X12ValidateEdi", "traits": { - "smithy.api#documentation": "

Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.

" + "smithy.api#documentation": "

Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE. When enabled, this performs both standard EDI validation and applies any configured custom validation rules including element length constraints, code list validations, and element requirement checks. Validation results are returned in the response validation messages.

" } }, "controlNumbers": { @@ -9076,6 +9461,55 @@ "com.amazonaws.b2bi#X12ValidateEdi": { "type": "boolean" }, + "com.amazonaws.b2bi#X12ValidationOptions": { + "type": "structure", + "members": { + "validationRules": { + "target": "com.amazonaws.b2bi#X12ValidationRules", + "traits": { + "smithy.api#documentation": "

Specifies a list of validation rules to apply during EDI document processing. These rules can include code list modifications, element length constraints, and element requirement changes.

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

Contains configuration options for X12 EDI validation. This structure allows you to specify custom validation rules that will be applied during EDI document processing, including element length constraints, code list modifications, and element requirement changes. These validation options provide flexibility to accommodate trading partner-specific requirements while maintaining EDI compliance. The validation rules are applied in addition to standard X12 validation to ensure documents meet both standard and custom requirements.

" + } + }, + "com.amazonaws.b2bi#X12ValidationRule": { + "type": "union", + "members": { + "codeListValidationRule": { + "target": "com.amazonaws.b2bi#X12CodeListValidationRule", + "traits": { + "smithy.api#documentation": "

Specifies a code list validation rule that modifies the allowed code values for a specific X12 element. This rule enables you to customize which codes are considered valid for an element, allowing for trading partner-specific code requirements.

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

Specifies an element length validation rule that defines custom length constraints for a specific X12 element. This rule allows you to enforce minimum and maximum length requirements that may differ from the standard X12 specification.

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

Specifies an element requirement validation rule that modifies whether a specific X12 element is required or optional within a segment. This rule provides flexibility to accommodate different trading partner requirements for element presence.

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

Represents a single validation rule that can be applied during X12 EDI processing. This is a union type that can contain one of several specific validation rule types: code list validation rules for modifying allowed element codes, element length validation rules for enforcing custom length constraints, or element requirement validation rules for changing mandatory/optional status. Each validation rule targets specific aspects of EDI document validation to ensure compliance with trading partner requirements and business rules.

" + } + }, + "com.amazonaws.b2bi#X12ValidationRules": { + "type": "list", + "member": { + "target": "com.amazonaws.b2bi#X12ValidationRule" + }, + "traits": { + "smithy.api#documentation": "

A list of X12 validation rules to be applied during EDI document processing. This collection allows you to specify multiple validation rules of different types that will be enforced when validating X12 EDI documents.

" + } + }, "com.amazonaws.b2bi#X12Version": { "type": "enum", "members": { diff --git a/codegen/sdk/aws-models/backup-gateway.json b/codegen/sdk/aws-models/backup-gateway.json index 92ff53efc74..cd8dd098010 100644 --- a/codegen/sdk/aws-models/backup-gateway.json +++ b/codegen/sdk/aws-models/backup-gateway.json @@ -887,17 +887,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -911,17 +900,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -935,17 +913,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -959,17 +926,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/backup.json b/codegen/sdk/aws-models/backup.json index fc524330073..447be31781f 100644 --- a/codegen/sdk/aws-models/backup.json +++ b/codegen/sdk/aws-models/backup.json @@ -4024,17 +4024,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4048,17 +4037,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4072,17 +4050,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4096,17 +4063,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/backupsearch.json b/codegen/sdk/aws-models/backupsearch.json index a9bd5537b7e..d56fa752f71 100644 --- a/codegen/sdk/aws-models/backupsearch.json +++ b/codegen/sdk/aws-models/backupsearch.json @@ -24,18 +24,18 @@ "CreatedAfter": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

This timestamp includes recovery points only \n created after the specified time.

" + "smithy.api#documentation": "

This timestamp includes recovery points only created after the specified time.

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

This timestamp includes recovery points only \n created before the specified time.

" + "smithy.api#documentation": "

This timestamp includes recovery points only created before the specified time.

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

This filters by recovery points within the CreatedAfter \n and CreatedBefore timestamps.

" + "smithy.api#documentation": "

This filters by recovery points within the CreatedAfter and CreatedBefore timestamps.

" } }, "com.amazonaws.backupsearch#ConflictException": { @@ -64,7 +64,7 @@ } }, "traits": { - "smithy.api#documentation": "

This exception occurs when a conflict with a previous successful\n operation is detected. This generally occurs when the previous \n operation did not have time to propagate to the host serving the \n current request.

\n

A retry (with appropriate backoff logic) is the recommended \n response to this exception.

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

This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.

A retry (with appropriate backoff logic) is the recommended response to this exception.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -122,9 +122,7 @@ "name": "backup-search" }, "aws.endpoints#dualStackOnlyEndpoints": {}, - "aws.endpoints#standardPartitionalEndpoints": { - "endpointPatternType": "service_region_dnsSuffix" - }, + "aws.endpoints#standardRegionalEndpoints": {}, "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ @@ -150,7 +148,7 @@ "date" ] }, - "smithy.api#documentation": "Backup Search\n

Backup Search is the recovery point and item level search for Backup.

\n

For additional information, see:

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

Backup Search is the recovery point and item level search for Backup.

For additional information, see:

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -263,15 +261,8 @@ } ], "endpoint": { - "url": "https://backup-search-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, + "url": "https://backup-search-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, "headers": {} }, "type": "endpoint" @@ -279,15 +270,8 @@ { "conditions": [], "endpoint": { - "url": "https://backup-search.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" - } - ] - }, + "url": "https://backup-search.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, "headers": {} }, "type": "endpoint" @@ -336,14 +320,6 @@ "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1" - } - ] - }, "url": "https://backup-search-fips.us-east-1.api.aws" } }, @@ -356,14 +332,6 @@ "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1" - } - ] - }, "url": "https://backup-search.us-east-1.api.aws" } }, @@ -376,14 +344,6 @@ "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1" - } - ] - }, "url": "https://backup-search-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, @@ -396,14 +356,6 @@ "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1" - } - ] - }, "url": "https://backup-search.cn-northwest-1.api.amazonwebservices.com.cn" } }, @@ -416,14 +368,6 @@ "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, "url": "https://backup-search-fips.us-gov-west-1.api.aws" } }, @@ -436,14 +380,6 @@ "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1" - } - ] - }, "url": "https://backup-search.us-gov-west-1.api.aws" } }, @@ -452,166 +388,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://backup-search-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://backup-search.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://backup-search-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://backup-search.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eu-isoe-west-1" - } - ] - }, - "url": "https://backup-search-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eu-isoe-west-1" - } - ] - }, - "url": "https://backup-search.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isof-south-1" - } - ] - }, - "url": "https://backup-search-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isof-south-1" - } - ] - }, - "url": "https://backup-search.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { @@ -629,24 +405,24 @@ "RecoveryPointsScannedCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

This number is the sum of all backups that \n have been scanned so far during a search job.

" + "smithy.api#documentation": "

This number is the sum of all backups that have been scanned so far during a search job.

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

This number is the sum of all items that \n have been scanned so far during a search job.

" + "smithy.api#documentation": "

This number is the sum of all items that have been scanned so far during a search job.

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

This number is the sum of all items that match \n the item filters in a search job in progress.

" + "smithy.api#documentation": "

This number is the sum of all items that match the item filters in a search job in progress.

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

This contains information results retrieved from \n a search job that may not have completed.

" + "smithy.api#documentation": "

This contains information results retrieved from a search job that may not have completed.

" } }, "com.amazonaws.backupsearch#EBSItemFilter": { @@ -655,30 +431,30 @@ "FilePaths": { "target": "com.amazonaws.backupsearch#StringConditionList", "traits": { - "smithy.api#documentation": "

You can include 1 to 10 values.

\n

If one file path is included, the results will \n return only items that match the file path.

\n

If more than one file path is included, the \n results will return all items that match any of the \n file paths.

" + "smithy.api#documentation": "

You can include 1 to 10 values.

If one file path is included, the results will return only items that match the file path.

If more than one file path is included, the results will return all items that match any of the file paths.

" } }, "Sizes": { "target": "com.amazonaws.backupsearch#LongConditionList", "traits": { - "smithy.api#documentation": "

You can include 1 to 10 values.

\n

If one is included, the results will \n return only items that match.

\n

If more than one is included, the \n results will return all items that match any of \n the included values.

" + "smithy.api#documentation": "

You can include 1 to 10 values.

If one is included, the results will return only items that match.

If more than one is included, the results will return all items that match any of the included values.

" } }, "CreationTimes": { "target": "com.amazonaws.backupsearch#TimeConditionList", "traits": { - "smithy.api#documentation": "

You can include 1 to 10 values.

\n

If one is included, the results will \n return only items that match.

\n

If more than one is included, the \n results will return all items that match any of \n the included values.

" + "smithy.api#documentation": "

You can include 1 to 10 values.

If one is included, the results will return only items that match.

If more than one is included, the results will return all items that match any of the included values.

" } }, "LastModificationTimes": { "target": "com.amazonaws.backupsearch#TimeConditionList", "traits": { - "smithy.api#documentation": "

You can include 1 to 10 values.

\n

If one is included, the results will \n return only items that match.

\n

If more than one is included, the \n results will return all items that match any of \n the included values.

" + "smithy.api#documentation": "

You can include 1 to 10 values.

If one is included, the results will return only items that match.

If more than one is included, the results will return all items that match any of the included values.

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

This contains arrays of objects, which may include \n CreationTimes time condition objects, FilePaths \n string objects, LastModificationTimes time \n condition objects,

" + "smithy.api#documentation": "

This contains arrays of objects, which may include CreationTimes time condition objects, FilePaths string objects, LastModificationTimes time condition objects,

" } }, "com.amazonaws.backupsearch#EBSItemFilters": { @@ -699,13 +475,13 @@ "BackupResourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

These are one or more items in the \n results that match values for the Amazon Resource \n Name (ARN) of recovery points returned in a search \n of Amazon EBS backup metadata.

" + "smithy.api#documentation": "

These are one or more items in the results that match values for the Amazon Resource Name (ARN) of recovery points returned in a search of Amazon EBS backup metadata.

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

These are one or more items in the \n results that match values for the Amazon Resource \n Name (ARN) of source resources returned in a search \n of Amazon EBS backup metadata.

" + "smithy.api#documentation": "

These are one or more items in the results that match values for the Amazon Resource Name (ARN) of source resources returned in a search of Amazon EBS backup metadata.

" } }, "BackupVaultName": { @@ -717,36 +493,36 @@ "FileSystemIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

These are one or more items in the \n results that match values for file systems returned \n in a search of Amazon EBS backup metadata.

" + "smithy.api#documentation": "

These are one or more items in the results that match values for file systems returned in a search of Amazon EBS backup metadata.

" } }, "FilePath": { "target": "com.amazonaws.backupsearch#FilePath", "traits": { - "smithy.api#documentation": "

These are one or more items in the \n results that match values for file paths returned \n in a search of Amazon EBS backup metadata.

" + "smithy.api#documentation": "

These are one or more items in the results that match values for file paths returned in a search of Amazon EBS backup metadata.

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

These are one or more items in the \n results that match values for file sizes returned \n in a search of Amazon EBS backup metadata.

" + "smithy.api#documentation": "

These are one or more items in the results that match values for file sizes returned in a search of Amazon EBS backup metadata.

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

These are one or more items in the \n results that match values for creation times returned \n in a search of Amazon EBS backup metadata.

" + "smithy.api#documentation": "

These are one or more items in the results that match values for creation times returned in a search of Amazon EBS backup metadata.

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

These are one or more items in the \n results that match values for Last Modified Time returned \n in a search of Amazon EBS backup metadata.

" + "smithy.api#documentation": "

These are one or more items in the results that match values for Last Modified Time returned in a search of Amazon EBS backup metadata.

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

These are the items returned in the results of \n a search of Amazon EBS backup metadata.

" + "smithy.api#documentation": "

These are the items returned in the results of a search of Amazon EBS backup metadata.

" } }, "com.amazonaws.backupsearch#EncryptionKeyArn": { @@ -800,44 +576,44 @@ "ExportJobIdentifier": { "target": "com.amazonaws.backupsearch#GenericId", "traits": { - "smithy.api#documentation": "

This is the unique string that identifies a \n specific export job.

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

This is the unique string that identifies a specific export job.

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

This is the unique ARN (Amazon Resource Name) that \n belongs to the new export job.

" + "smithy.api#documentation": "

This is the unique ARN (Amazon Resource Name) that belongs to the new export job.

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

The status of the export job is one of the \n following:

\n

\n CREATED; RUNNING; \n FAILED; or COMPLETED.

" + "smithy.api#documentation": "

The status of the export job is one of the following:

CREATED; RUNNING; FAILED; or COMPLETED.

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

This is a timestamp of the time the export job \n was created.

" + "smithy.api#documentation": "

This is a timestamp of the time the export job was created.

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

This is a timestamp of the time the export job \n compeleted.

" + "smithy.api#documentation": "

This is a timestamp of the time the export job compeleted.

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

A status message is a string that is returned for an export\n job.

\n

A status message is included for any status other \n than COMPLETED without issues.

" + "smithy.api#documentation": "

A status message is a string that is returned for an export job.

A status message is included for any status other than COMPLETED without issues.

" } }, "SearchJobArn": { "target": "com.amazonaws.backupsearch#SearchJobArn", "traits": { - "smithy.api#documentation": "

The unique string that identifies the Amazon Resource \n Name (ARN) of the specified search job.

" + "smithy.api#documentation": "

The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.

" } } }, @@ -851,7 +627,7 @@ "s3ExportSpecification": { "target": "com.amazonaws.backupsearch#S3ExportSpecification", "traits": { - "smithy.api#documentation": "

This specifies the destination Amazon S3 \n bucket for the export job. And, if included, it also \n specifies the destination prefix.

" + "smithy.api#documentation": "

This specifies the destination Amazon S3 bucket for the export job. And, if included, it also specifies the destination prefix.

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

This operation retrieves metadata of a search job, \n including its progress.

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

This operation retrieves metadata of a search job, including its progress.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -897,7 +673,7 @@ "SearchJobIdentifier": { "target": "com.amazonaws.backupsearch#GenericId", "traits": { - "smithy.api#documentation": "

Required unique string that specifies the \n search job.

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

Required unique string that specifies the search job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -919,58 +695,58 @@ "SearchScopeSummary": { "target": "com.amazonaws.backupsearch#SearchScopeSummary", "traits": { - "smithy.api#documentation": "

Returned summary of the specified search job scope, \n including:\n

\n
    \n
  • \n

    TotalBackupsToScanCount, the number of \n recovery points returned by the search.

    \n
  • \n
  • \n

    TotalItemsToScanCount, the number of \n items returned by the search.

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

Returned summary of the specified search job scope, including:

  • TotalBackupsToScanCount, the number of recovery points returned by the search.

  • TotalItemsToScanCount, the number of items returned by the search.

" } }, "CurrentSearchProgress": { "target": "com.amazonaws.backupsearch#CurrentSearchProgress", "traits": { - "smithy.api#documentation": "

Returns numbers representing BackupsScannedCount, \n ItemsScanned, and ItemsMatched.

" + "smithy.api#documentation": "

Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.

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

A status message will be returned for either a \n earch job with a status of ERRORED or a status of \n COMPLETED jobs with issues.

\n

For example, a message may say that a search \n contained recovery points unable to be scanned because \n of a permissions issue.

" + "smithy.api#documentation": "

A status message will be returned for either a earch job with a status of ERRORED or a status of COMPLETED jobs with issues.

For example, a message may say that a search contained recovery points unable to be scanned because of a permissions issue.

" } }, "EncryptionKeyArn": { "target": "com.amazonaws.backupsearch#EncryptionKeyArn", "traits": { - "smithy.api#documentation": "

The encryption key for the specified \n search job.

\n

Example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" + "smithy.api#documentation": "

The encryption key for the specified search job.

Example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

The date and time that a search job completed, in Unix format and Coordinated\n Universal Time (UTC). The value of CompletionTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#documentation": "

The date and time that a search job completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

The current status of the specified search job.

\n

A search job may have one of the following statuses: \n RUNNING; COMPLETED; STOPPED; \n FAILED; TIMED_OUT; or EXPIRED\n .

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

The current status of the specified search job.

A search job may have one of the following statuses: RUNNING; COMPLETED; STOPPED; FAILED; TIMED_OUT; or EXPIRED .

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

The search scope is all backup \n properties input into a search.

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

The search scope is all backup properties input into a search.

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

Item Filters represent all input item \n properties specified when the search was \n created.

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

Item Filters represent all input item properties specified when the search was created.

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

The date and time that a search job was created, in Unix format and Coordinated\n Universal Time (UTC). The value of CompletionTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

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

The date and time that a search job was created, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

", "smithy.api#required": {} } }, @@ -984,7 +760,7 @@ "SearchJobArn": { "target": "com.amazonaws.backupsearch#SearchJobArn", "traits": { - "smithy.api#documentation": "

The unique string that identifies the Amazon Resource \n Name (ARN) of the specified search job.

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

The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.

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

This operation retrieves the metadata of an export job.

\n

An export job is an operation that transmits the results \n of a search job to a specified S3 bucket in a \n .csv file.

\n

An export job allows you to retain results of a search \n beyond the search job's scheduled retention of 7 days.

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

This operation retrieves the metadata of an export job.

An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file.

An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -1022,7 +798,7 @@ "ExportJobIdentifier": { "target": "com.amazonaws.backupsearch#GenericId", "traits": { - "smithy.api#documentation": "

This is the unique string that identifies a \n specific export job.

\n

Required for this operation.

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

This is the unique string that identifies a specific export job.

Required for this operation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1038,14 +814,14 @@ "ExportJobIdentifier": { "target": "com.amazonaws.backupsearch#GenericId", "traits": { - "smithy.api#documentation": "

This is the unique string that identifies the \n specified export job.

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

This is the unique string that identifies the specified export job.

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

The unique Amazon Resource Name (ARN) that uniquely identifies \n the export job.

" + "smithy.api#documentation": "

The unique Amazon Resource Name (ARN) that uniquely identifies the export job.

" } }, "Status": { @@ -1057,31 +833,31 @@ "CreationTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that an export job was created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationTime is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#documentation": "

The date and time that an export job was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

The date and time that an export job completed, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationTime is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#documentation": "

The date and time that an export job completed, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

A status message is a string that is returned for search job \n with a status of FAILED, along with steps to remedy \n and retry the operation.

" + "smithy.api#documentation": "

A status message is a string that is returned for search job with a status of FAILED, along with steps to remedy and retry the operation.

" } }, "ExportSpecification": { "target": "com.amazonaws.backupsearch#ExportSpecification", "traits": { - "smithy.api#documentation": "

The export specification consists of the destination \n S3 bucket to which the search results were exported, along \n with the destination prefix.

" + "smithy.api#documentation": "

The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.

" } }, "SearchJobArn": { "target": "com.amazonaws.backupsearch#SearchJobArn", "traits": { - "smithy.api#documentation": "

The unique string that identifies the Amazon Resource \n Name (ARN) of the specified search job.

" + "smithy.api#documentation": "

The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.

" } } }, @@ -1130,18 +906,18 @@ "S3ItemFilters": { "target": "com.amazonaws.backupsearch#S3ItemFilters", "traits": { - "smithy.api#documentation": "

This array can contain CreationTimes, ETags, \n ObjectKeys, Sizes, or VersionIds objects.

" + "smithy.api#documentation": "

This array can contain CreationTimes, ETags, ObjectKeys, Sizes, or VersionIds objects.

" } }, "EBSItemFilters": { "target": "com.amazonaws.backupsearch#EBSItemFilters", "traits": { - "smithy.api#documentation": "

This array can contain CreationTimes, \n FilePaths, LastModificationTimes, or Sizes objects.

" + "smithy.api#documentation": "

This array can contain CreationTimes, FilePaths, LastModificationTimes, or Sizes objects.

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

Item Filters represent all input item \n properties specified when the search was \n created.

\n

Contains either EBSItemFilters or \n S3ItemFilters

" + "smithy.api#documentation": "

Item Filters represent all input item properties specified when the search was created.

Contains either EBSItemFilters or S3ItemFilters

" } }, "com.amazonaws.backupsearch#ListSearchJobBackups": { @@ -1158,7 +934,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation returns a list of all backups (recovery \n points) in a paginated format that were included in \n the search job.

\n

If a search does not display an expected backup in \n the results, you can call this operation to display each \n backup included in the search. Any backups that were not \n included because they have a FAILED status \n from a permissions issue will be displayed, along with a \n status message.

\n

Only recovery points with a backup index that has \n a status of ACTIVE will be included in search results. \n If the index has any other status, its status will be \n displayed along with a status message.

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

This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.

If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a FAILED status from a permissions issue will be displayed, along with a status message.

Only recovery points with a backup index that has a status of ACTIVE will be included in search results. If the index has any other status, its status will be displayed along with a status message.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -1187,7 +963,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned backups \n included in a search job.

\n

For example, if a request\n is made to return MaxResults number of backups, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

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

The next item following a partial list of returned backups included in a search job.

For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "smithy.api#httpQuery": "nextToken" } }, @@ -1214,14 +990,14 @@ "Results": { "target": "com.amazonaws.backupsearch#SearchJobBackupsResults", "traits": { - "smithy.api#documentation": "

The recovery points returned the results of a \n search job

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

The recovery points returned the results of a search job

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

The next item following a partial list of returned backups \n included in a search job.

\n

For example, if a request\n is made to return MaxResults number of backups, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" + "smithy.api#documentation": "

The next item following a partial list of returned backups included in a search job.

For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" } } }, @@ -1270,7 +1046,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned \n search job results.

\n

For example, if a request\n is made to return MaxResults number of \n search job results, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

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

The next item following a partial list of returned search job results.

For example, if a request is made to return MaxResults number of search job results, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "smithy.api#httpQuery": "nextToken" } }, @@ -1304,7 +1080,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The next item following a partial list of \n search job results.

\n

For example, if a request\n is made to return MaxResults number of backups, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" + "smithy.api#documentation": "

The next item following a partial list of search job results.

For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" } } }, @@ -1321,7 +1097,7 @@ "target": "com.amazonaws.backupsearch#ListSearchJobsOutput" }, "traits": { - "smithy.api#documentation": "

This operation returns a list of search jobs belonging \n to an account.

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

This operation returns a list of search jobs belonging to an account.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -1352,7 +1128,7 @@ "ByStatus": { "target": "com.amazonaws.backupsearch#SearchJobState", "traits": { - "smithy.api#documentation": "

Include this parameter to filter list by search \n job status.

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

Include this parameter to filter list by search job status.

", "smithy.api#httpQuery": "Status", "smithy.api#notProperty": {} } @@ -1360,7 +1136,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned \n search jobs.

\n

For example, if a request\n is made to return MaxResults number of backups, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

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

The next item following a partial list of returned search jobs.

For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "smithy.api#httpQuery": "NextToken", "smithy.api#notProperty": {} } @@ -1389,7 +1165,7 @@ "SearchJobs": { "target": "com.amazonaws.backupsearch#SearchJobs", "traits": { - "smithy.api#documentation": "

The search jobs among the list, with details of \n the returned search jobs.

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

The search jobs among the list, with details of the returned search jobs.

", "smithy.api#notProperty": {}, "smithy.api#required": {} } @@ -1397,7 +1173,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned backups \n included in a search job.

\n

For example, if a request\n is made to return MaxResults number of backups, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

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

The next item following a partial list of returned backups included in a search job.

For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

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

This operation exports search results of a search job \n to a specified destination S3 bucket.

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

This operation exports search results of a search job to a specified destination S3 bucket.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -1441,7 +1217,7 @@ "Status": { "target": "com.amazonaws.backupsearch#ExportJobStatus", "traits": { - "smithy.api#documentation": "

The search jobs to be included in the export job \n can be filtered by including this parameter.

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

The search jobs to be included in the export job can be filtered by including this parameter.

", "smithy.api#httpQuery": "Status", "smithy.api#notProperty": {} } @@ -1457,7 +1233,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned backups \n included in a search job.

\n

For example, if a request\n is made to return MaxResults number of backups, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

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

The next item following a partial list of returned backups included in a search job.

For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "smithy.api#httpQuery": "NextToken", "smithy.api#notProperty": {} } @@ -1494,7 +1270,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned backups \n included in a search job.

\n

For example, if a request\n is made to return MaxResults number of backups, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

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

The next item following a partial list of returned backups included in a search job.

For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", "smithy.api#notProperty": {} } } @@ -1531,7 +1307,7 @@ "ResourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies \n the resource.>

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

The Amazon Resource Name (ARN) that uniquely identifies the resource.>

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1561,7 +1337,7 @@ "Value": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

The value of an item included in one of the search \n item filters.

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

The value of an item included in one of the search item filters.

", "smithy.api#required": {} } }, @@ -1569,12 +1345,12 @@ "target": "com.amazonaws.backupsearch#LongConditionOperator", "traits": { "smithy.api#default": "EQUALS_TO", - "smithy.api#documentation": "

A string that defines what values will be \n returned.

\n

If this is included, avoid combinations of \n operators that will return all possible values. \n For example, including both EQUALS_TO \n and NOT_EQUALS_TO with a value of 4 \n will return all values.

" + "smithy.api#documentation": "

A string that defines what values will be returned.

If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.

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

The long condition contains a Value \n and can optionally contain an Operator.

" + "smithy.api#documentation": "

The long condition contains a Value and can optionally contain an Operator.

" } }, "com.amazonaws.backupsearch#LongConditionList": { @@ -1682,7 +1458,7 @@ } }, "traits": { - "smithy.api#documentation": "

The resource was not found for this request.

\n

Confirm the resource information, such as the ARN or type is correct \n and exists, then retry the request.

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

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1722,18 +1498,18 @@ "S3ResultItem": { "target": "com.amazonaws.backupsearch#S3ResultItem", "traits": { - "smithy.api#documentation": "

These are items returned in the search results \n of an Amazon S3 search.

" + "smithy.api#documentation": "

These are items returned in the search results of an Amazon S3 search.

" } }, "EBSResultItem": { "target": "com.amazonaws.backupsearch#EBSResultItem", "traits": { - "smithy.api#documentation": "

These are items returned in the search results \n of an Amazon EBS search.

" + "smithy.api#documentation": "

These are items returned in the search results of an Amazon EBS search.

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

This is an object representing the item \n returned in the results of a search for a specific \n resource type.

" + "smithy.api#documentation": "

This is an object representing the item returned in the results of a search for a specific resource type.

" } }, "com.amazonaws.backupsearch#Results": { @@ -1748,19 +1524,19 @@ "DestinationBucket": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

This specifies the destination Amazon S3 \n bucket for the export job.

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

This specifies the destination Amazon S3 bucket for the export job.

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

This specifies the prefix for the destination \n Amazon S3 bucket for the export job.

" + "smithy.api#documentation": "

This specifies the prefix for the destination Amazon S3 bucket for the export job.

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

This specification contains a required string of the \n destination bucket; optionally, you can include the \n destination prefix.

" + "smithy.api#documentation": "

This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.

" } }, "com.amazonaws.backupsearch#S3ItemFilter": { @@ -1769,36 +1545,36 @@ "ObjectKeys": { "target": "com.amazonaws.backupsearch#StringConditionList", "traits": { - "smithy.api#documentation": "

You can include 1 to 10 values.

\n

If one value is included, the results will \n return only items that match the value.

\n

If more than one value is included, the \n results will return all items that match any of the \n values.

" + "smithy.api#documentation": "

You can include 1 to 10 values.

If one value is included, the results will return only items that match the value.

If more than one value is included, the results will return all items that match any of the values.

" } }, "Sizes": { "target": "com.amazonaws.backupsearch#LongConditionList", "traits": { - "smithy.api#documentation": "

You can include 1 to 10 values.

\n

If one value is included, the results will \n return only items that match the value.

\n

If more than one value is included, the \n results will return all items that match any of the \n values.

" + "smithy.api#documentation": "

You can include 1 to 10 values.

If one value is included, the results will return only items that match the value.

If more than one value is included, the results will return all items that match any of the values.

" } }, "CreationTimes": { "target": "com.amazonaws.backupsearch#TimeConditionList", "traits": { - "smithy.api#documentation": "

You can include 1 to 10 values.

\n

If one value is included, the results will \n return only items that match the value.

\n

If more than one value is included, the \n results will return all items that match any of the \n values.

" + "smithy.api#documentation": "

You can include 1 to 10 values.

If one value is included, the results will return only items that match the value.

If more than one value is included, the results will return all items that match any of the values.

" } }, "VersionIds": { "target": "com.amazonaws.backupsearch#StringConditionList", "traits": { - "smithy.api#documentation": "

You can include 1 to 10 values.

\n

If one value is included, the results will \n return only items that match the value.

\n

If more than one value is included, the \n results will return all items that match any of the \n values.

" + "smithy.api#documentation": "

You can include 1 to 10 values.

If one value is included, the results will return only items that match the value.

If more than one value is included, the results will return all items that match any of the values.

" } }, "ETags": { "target": "com.amazonaws.backupsearch#StringConditionList", "traits": { - "smithy.api#documentation": "

You can include 1 to 10 values.

\n

If one value is included, the results will \n return only items that match the value.

\n

If more than one value is included, the \n results will return all items that match any of the \n values.

" + "smithy.api#documentation": "

You can include 1 to 10 values.

If one value is included, the results will return only items that match the value.

If more than one value is included, the results will return all items that match any of the values.

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

This contains arrays of objects, which may include \n ObjectKeys, Sizes, CreationTimes, VersionIds, and/or \n Etags.

" + "smithy.api#documentation": "

This contains arrays of objects, which may include ObjectKeys, Sizes, CreationTimes, VersionIds, and/or Etags.

" } }, "com.amazonaws.backupsearch#S3ItemFilters": { @@ -1819,13 +1595,13 @@ "BackupResourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

These are items in the returned results that match \n recovery point Amazon Resource Names (ARN) input during \n a search of Amazon S3 backup metadata.

" + "smithy.api#documentation": "

These are items in the returned results that match recovery point Amazon Resource Names (ARN) input during a search of Amazon S3 backup metadata.

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

These are items in the returned results that match \n source Amazon Resource Names (ARN) input during \n a search of Amazon S3 backup metadata.

" + "smithy.api#documentation": "

These are items in the returned results that match source Amazon Resource Names (ARN) input during a search of Amazon S3 backup metadata.

" } }, "BackupVaultName": { @@ -1837,36 +1613,36 @@ "ObjectKey": { "target": "com.amazonaws.backupsearch#ObjectKey", "traits": { - "smithy.api#documentation": "

This is one or more items \n returned in the results of a search of Amazon S3 \n backup metadata that match the values input for \n object key.

" + "smithy.api#documentation": "

This is one or more items returned in the results of a search of Amazon S3 backup metadata that match the values input for object key.

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

These are items in the returned results that match \n values for object size(s) input during a search of \n Amazon S3 backup metadata.

" + "smithy.api#documentation": "

These are items in the returned results that match values for object size(s) input during a search of Amazon S3 backup metadata.

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

These are one or more items in the returned results \n that match values for item creation time input during \n a search of Amazon S3 backup metadata.

" + "smithy.api#documentation": "

These are one or more items in the returned results that match values for item creation time input during a search of Amazon S3 backup metadata.

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

These are one or more items in the returned results \n that match values for ETags input during \n a search of Amazon S3 backup metadata.

" + "smithy.api#documentation": "

These are one or more items in the returned results that match values for ETags input during a search of Amazon S3 backup metadata.

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

These are one or more items in the returned results \n that match values for version IDs input during \n a search of Amazon S3 backup metadata.

" + "smithy.api#documentation": "

These are one or more items in the returned results that match values for version IDs input during a search of Amazon S3 backup metadata.

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

These are the items returned in the results of \n a search of Amazon S3 backup metadata.

" + "smithy.api#documentation": "

These are the items returned in the results of a search of Amazon S3 backup metadata.

" } }, "com.amazonaws.backupsearch#SearchJob": { @@ -1962,13 +1738,13 @@ "BackupResourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies \n the backup resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the backup resources.

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

The Amazon Resource Name (ARN) that uniquely identifies \n the source resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the source resources.

" } }, "IndexCreationTime": { @@ -1985,7 +1761,7 @@ } }, "traits": { - "smithy.api#documentation": "

This contains the information about recovery \n points returned in results of a search job.

" + "smithy.api#documentation": "

This contains the information about recovery points returned in results of a search job.

" } }, "com.amazonaws.backupsearch#SearchJobBackupsResults": { @@ -2041,7 +1817,7 @@ "SearchJobArn": { "target": "com.amazonaws.backupsearch#SearchJobArn", "traits": { - "smithy.api#documentation": "

The unique string that identifies the Amazon Resource \n Name (ARN) of the specified search job.

" + "smithy.api#documentation": "

The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.

" } }, "Name": { @@ -2071,13 +1847,13 @@ "SearchScopeSummary": { "target": "com.amazonaws.backupsearch#SearchScopeSummary", "traits": { - "smithy.api#documentation": "

Returned summary of the specified search job scope, \n including:\n

\n
    \n
  • \n

    TotalBackupsToScanCount, the number of \n recovery points returned by the search.

    \n
  • \n
  • \n

    TotalItemsToScanCount, the number of \n items returned by the search.

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

Returned summary of the specified search job scope, including:

  • TotalBackupsToScanCount, the number of recovery points returned by the search.

  • TotalItemsToScanCount, the number of items returned by the search.

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

A status message will be returned for either a \n earch job with a status of ERRORED or a status of \n COMPLETED jobs with issues.

\n

For example, a message may say that a search \n contained recovery points unable to be scanned because \n of a permissions issue.

" + "smithy.api#documentation": "

A status message will be returned for either a earch job with a status of ERRORED or a status of COMPLETED jobs with issues.

For example, a message may say that a search contained recovery points unable to be scanned because of a permissions issue.

" } } }, @@ -2149,7 +1925,7 @@ "BackupResourceTypes": { "target": "com.amazonaws.backupsearch#ResourceTypeList", "traits": { - "smithy.api#documentation": "

The resource types included in a search.

\n

Eligible resource types include S3 and EBS.

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

The resource types included in a search.

Eligible resource types include S3 and EBS.

", "smithy.api#required": {} } }, @@ -2162,24 +1938,24 @@ "SourceResourceArns": { "target": "com.amazonaws.backupsearch#ResourceArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies \n the source resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the source resources.

" } }, "BackupResourceArns": { "target": "com.amazonaws.backupsearch#RecoveryPointArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies \n the backup resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the backup resources.

" } }, "BackupResourceTags": { "target": "com.amazonaws.backupsearch#TagMap", "traits": { - "smithy.api#documentation": "

These are one or more tags on the backup (recovery \n point).

" + "smithy.api#documentation": "

These are one or more tags on the backup (recovery point).

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

The search scope is all backup \n properties input into a search.

" + "smithy.api#documentation": "

The search scope is all backup properties input into a search.

" } }, "com.amazonaws.backupsearch#SearchScopeSummary": { @@ -2188,18 +1964,18 @@ "TotalRecoveryPointsToScanCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

This is the count of the total number of backups \n that will be scanned in a search.

" + "smithy.api#documentation": "

This is the count of the total number of backups that will be scanned in a search.

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

This is the count of the total number of items \n that will be scanned in a search.

" + "smithy.api#documentation": "

This is the count of the total number of items that will be scanned in a search.

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

The summary of the specified search job scope, \n including:\n

\n
    \n
  • \n

    TotalBackupsToScanCount, the number of \n recovery points returned by the search.

    \n
  • \n
  • \n

    TotalItemsToScanCount, the number of \n items returned by the search.

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

The summary of the specified search job scope, including:

  • TotalBackupsToScanCount, the number of recovery points returned by the search.

  • TotalItemsToScanCount, the number of items returned by the search.

" } }, "com.amazonaws.backupsearch#ServiceQuotaExceededException": { @@ -2259,12 +2035,15 @@ { "target": "com.amazonaws.backupsearch#ConflictException" }, + { + "target": "com.amazonaws.backupsearch#ResourceNotFoundException" + }, { "target": "com.amazonaws.backupsearch#ServiceQuotaExceededException" } ], "traits": { - "smithy.api#documentation": "

This operation creates a search job which returns \n recovery points filtered by SearchScope and items \n filtered by ItemFilters.

\n

You can optionally include ClientToken, \n EncryptionKeyArn, Name, and/or Tags.

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

This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.

You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -2285,7 +2064,7 @@ "Name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Include alphanumeric characters to create a \n name for this search job.

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

Include alphanumeric characters to create a name for this search job.

", "smithy.api#length": { "max": 500 } @@ -2294,26 +2073,26 @@ "EncryptionKeyArn": { "target": "com.amazonaws.backupsearch#EncryptionKeyArn", "traits": { - "smithy.api#documentation": "

The encryption key for the specified \n search job.

" + "smithy.api#documentation": "

The encryption key for the specified search job.

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

Include this parameter to allow multiple identical \n calls for idempotency.

\n

A client token is valid for 8 hours after the first \n request that uses it is completed. After this time,\n any request with the same token is treated as a \n new request.

" + "smithy.api#documentation": "

Include this parameter to allow multiple identical calls for idempotency.

A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.

" } }, "SearchScope": { "target": "com.amazonaws.backupsearch#SearchScope", "traits": { - "smithy.api#documentation": "

This object can contain BackupResourceTypes, \n BackupResourceArns, BackupResourceCreationTime, \n BackupResourceTags, and SourceResourceArns to \n filter the recovery points returned by the search \n job.

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

This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.

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

Item Filters represent all input item \n properties specified when the search was \n created.

\n

Contains either EBSItemFilters or \n S3ItemFilters

" + "smithy.api#documentation": "

Item Filters represent all input item properties specified when the search was created.

Contains either EBSItemFilters or S3ItemFilters

" } } }, @@ -2327,13 +2106,13 @@ "SearchJobArn": { "target": "com.amazonaws.backupsearch#SearchJobArn", "traits": { - "smithy.api#documentation": "

The unique string that identifies the Amazon Resource \n Name (ARN) of the specified search job.

" + "smithy.api#documentation": "

The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.

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

The date and time that a job was created, in Unix format and Coordinated\n Universal Time (UTC). The value of CompletionTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#documentation": "

The date and time that a job was created, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

This operations starts a job to export the results \n of search job to a designated S3 bucket.

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

This operations starts a job to export the results of search job to a designated S3 bucket.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -2390,26 +2169,26 @@ "ExportSpecification": { "target": "com.amazonaws.backupsearch#ExportSpecification", "traits": { - "smithy.api#documentation": "

This specification contains a required string of the \n destination bucket; optionally, you can include the \n destination prefix.

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

This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.

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

Include this parameter to allow multiple identical \n calls for idempotency.

\n

A client token is valid for 8 hours after the first \n request that uses it is completed. After this time,\n any request with the same token is treated as a \n new request.

" + "smithy.api#documentation": "

Include this parameter to allow multiple identical calls for idempotency.

A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.

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

Optional tags to include. A tag is a key-value pair you can use to manage, \n filter, and search for your resources. Allowed characters include UTF-8 letters, \n numbers, spaces, and the following characters: + - = . _ : /.

" + "smithy.api#documentation": "

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

" } }, "RoleArn": { "target": "com.amazonaws.backupsearch#IamRoleArn", "traits": { - "smithy.api#documentation": "

This parameter specifies the role ARN used to start \n the search results export jobs.

" + "smithy.api#documentation": "

This parameter specifies the role ARN used to start the search results export jobs.

" } } }, @@ -2423,13 +2202,13 @@ "ExportJobArn": { "target": "com.amazonaws.backupsearch#ExportJobArn", "traits": { - "smithy.api#documentation": "

This is the unique ARN (Amazon Resource Name) that \n belongs to the new export job.

" + "smithy.api#documentation": "

This is the unique ARN (Amazon Resource Name) that belongs to the new export job.

" } }, "ExportJobIdentifier": { "target": "com.amazonaws.backupsearch#GenericId", "traits": { - "smithy.api#documentation": "

This is the unique identifier that \n specifies the new export job.

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

This is the unique identifier that specifies the new export job.

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

This operations ends a search job.

\n

Only a search job with a status of RUNNING \n can be stopped.

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

This operations ends a search job.

Only a search job with a status of RUNNING can be stopped.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -2501,12 +2280,12 @@ "target": "com.amazonaws.backupsearch#StringConditionOperator", "traits": { "smithy.api#default": "EQUALS_TO", - "smithy.api#documentation": "

A string that defines what values will be \n returned.

\n

If this is included, avoid combinations of \n operators that will return all possible values. \n For example, including both EQUALS_TO \n and NOT_EQUALS_TO with a value of 4 \n will return all values.

" + "smithy.api#documentation": "

A string that defines what values will be returned.

If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.

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

This contains the value of the string and can contain \n one or more operators.

" + "smithy.api#documentation": "

This contains the value of the string and can contain one or more operators.

" } }, "com.amazonaws.backupsearch#StringConditionList": { @@ -2620,7 +2399,7 @@ "ResourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies \n the resource.

\n

This is the resource that will have the indicated tags.

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

The Amazon Resource Name (ARN) that uniquely identifies the resource.

This is the resource that will have the indicated tags.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2628,7 +2407,7 @@ "Tags": { "target": "com.amazonaws.backupsearch#TagMap", "traits": { - "smithy.api#documentation": "

Required tags to include. A tag is a key-value pair you can use to manage, \n filter, and search for your resources. Allowed characters include UTF-8 letters, \n numbers, spaces, and the following characters: + - = . _ : /.

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

Required tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

", "smithy.api#required": {} } } @@ -2697,12 +2476,12 @@ "target": "com.amazonaws.backupsearch#TimeConditionOperator", "traits": { "smithy.api#default": "EQUALS_TO", - "smithy.api#documentation": "

A string that defines what values will be \n returned.

\n

If this is included, avoid combinations of \n operators that will return all possible values. \n For example, including both EQUALS_TO \n and NOT_EQUALS_TO with a value of 4 \n will return all values.

" + "smithy.api#documentation": "

A string that defines what values will be returned.

If this is included, avoid combinations of operators that will return all possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a value of 4 will return all values.

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

A time condition denotes a creation time, last modification time, \n or other time.

" + "smithy.api#documentation": "

A time condition denotes a creation time, last modification time, or other time.

" } }, "com.amazonaws.backupsearch#TimeConditionList": { @@ -2774,7 +2553,7 @@ "ResourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies \n the resource where you want to remove tags.

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

The Amazon Resource Name (ARN) that uniquely identifies the resource where you want to remove tags.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2782,7 +2561,7 @@ "TagKeys": { "target": "com.amazonaws.backupsearch#TagKeys", "traits": { - "smithy.api#documentation": "

This required parameter contains the tag keys you \n want to remove from the source.

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

This required parameter contains the tag keys you want to remove from the source.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } diff --git a/codegen/sdk/aws-models/batch.json b/codegen/sdk/aws-models/batch.json index 2a5f847d9a6..9fbb29b5e8b 100644 --- a/codegen/sdk/aws-models/batch.json +++ b/codegen/sdk/aws-models/batch.json @@ -1041,17 +1041,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1065,17 +1054,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1089,17 +1067,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1113,17 +1080,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1880,7 +1836,7 @@ "target": "com.amazonaws.batch#CRType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of compute environment: EC2, SPOT, FARGATE,\n or FARGATE_SPOT. For more information, see Compute environments in the\n Batch User Guide.

\n

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the\n Batch User Guide.

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

The type of compute environment: EC2, SPOT, FARGATE,\n or FARGATE_SPOT. For more information, see Compute environments in the\n Batch User Guide.

\n

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the\n Batch User Guide.

\n \n

Multi-node parallel jobs aren't supported on Spot Instances.

\n
", "smithy.api#required": {} } }, @@ -1913,7 +1869,7 @@ "instanceTypes": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The instances types that can be launched. You can specify instance families to launch any\n instance type within those families (for example, c5 or p3), or you can\n specify specific sizes within a family (such as c5.8xlarge). You can also choose\n optimal to select instance types (from the C4, M4, and R4 instance families) that\n match the demand of your job queues.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

\n
\n \n

When you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.

\n
\n \n

Currently, optimal uses instance types from the C4, M4, and R4 instance\n families. In Regions that don't have instance types from those instance families, instance types\n from the C5, M5, and R5 instance families are used.

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

The instances types that can be launched. You can specify instance families to launch any\n instance type within those families (for example, c5 or p3), or you can\n specify specific sizes within a family (such as c5.8xlarge).

\n

Batch can select the instance type for you if you choose one of the following:

\n
    \n
  • \n

    \n optimal to select instance types (from the c4, m4,\n r4, c5, m5, and r5\n instance families) that match the demand of your job queues.

    \n
  • \n
  • \n

    \n default_x86_64 to choose x86 based instance types (from the m6i,\n c6i, r6i, and c7i instance families) that matches the resource demands of the job queue.

    \n
  • \n
  • \n

    \n default_arm64 to choose x86 based instance types (from the m6g,\n c6g, r6g, and c7g instance families) that matches the resource demands of the job queue.

    \n
  • \n
\n \n

Starting on 11/01/2025 the behavior of optimal is going to be changed to\n match default_x86_64.\n \n During the change your instance families could be updated to a newer\n generation.\n You do not need to perform any actions for the upgrade to\n happen. For more information about change, see Optimal instance type configuration to\n receive automatic instance family updates.

\n
\n \n

Instance family availability varies by\n Amazon Web Services Region.\n For example, some Amazon Web Services Regions may not have any fourth generation instance families\n but have fifth and sixth generation instance families.

\n

When using default_x86_64 or default_arm64\n instance bundles, Batch selects instance families based on a balance of\n cost-effectiveness and performance. While newer generation instances often provide\n better price-performance, Batch may choose an earlier generation instance family\n if it provides the optimal combination of availability, cost, and performance for\n your workload. For example, in an\n Amazon Web Services Region\n where both c6i and c7i instances are available, Batch might select c6i instances\n if they offer better cost-effectiveness for your specific job requirements. For more information on Batch instance types and Amazon Web Services Region availability, see Instance type compute table in the Batch User Guide.

\n

Batch periodically updates your instances in default bundles to newer,\n more cost-effective options. Updates happen automatically without requiring any\n action from you. Your workloads continue running during updates with no interruption\n

\n
\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

\n
\n \n

When you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.

\n
" } }, "imageId": { @@ -2034,7 +1990,7 @@ "instanceTypes": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The instances types that can be launched. You can specify instance families to launch any\n instance type within those families (for example, c5 or p3), or you can\n specify specific sizes within a family (such as c5.8xlarge). You can also choose\n optimal to select instance types (from the C4, M4, and R4 instance families) that\n match the demand of your job queues.

\n

When updating a compute environment, changing this setting requires an infrastructure update\n of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

\n
\n \n

When you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.

\n
\n \n

Currently, optimal uses instance types from the C4, M4, and R4 instance\n families. In Regions that don't have instance types from those instance families, instance types\n from the C5, M5, and R5 instance families are used.

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

The instances types that can be launched. You can specify instance families to launch any\n instance type within those families (for example, c5 or p3), or you can\n specify specific sizes within a family (such as c5.8xlarge).

\n

Batch can select the instance type for you if you choose one of the following:

\n
    \n
  • \n

    \n optimal to select instance types (from the c4, m4,\n r4, c5, m5, and r5\n instance families) that match the demand of your job queues.

    \n
  • \n
  • \n

    \n default_x86_64 to choose x86 based instance types (from the m6i,\n c6i, r6i, and c7i instance families) that matches the resource demands of the job queue.

    \n
  • \n
  • \n

    \n default_arm64 to choose x86 based instance types (from the m6g,\n c6g, r6g, and c7g instance families) that matches the resource demands of the job queue.

    \n
  • \n
\n \n

Starting on 11/01/2025 the behavior of optimal is going to be changed to\n match default_x86_64.\n \n During the change your instance families could be updated to a newer\n generation.\n You do not need to perform any actions for the upgrade to\n happen. For more information about change, see Optimal instance type configuration to\n receive automatic instance family updates.

\n
\n \n

Instance family availability varies by\n Amazon Web Services Region.\n For example, some Amazon Web Services Regions may not have any fourth generation instance families\n but have fifth and sixth generation instance families.

\n

When using default_x86_64 or default_arm64\n instance bundles, Batch selects instance families based on a balance of\n cost-effectiveness and performance. While newer generation instances often provide\n better price-performance, Batch may choose an earlier generation instance family\n if it provides the optimal combination of availability, cost, and performance for\n your workload. For example, in an\n Amazon Web Services Region\n where both c6i and c7i instances are available, Batch might select c6i instances\n if they offer better cost-effectiveness for your specific job requirements. For more information on Batch instance types and Amazon Web Services Region availability, see Instance type compute table in the Batch User Guide.

\n

Batch periodically updates your instances in default bundles to newer,\n more cost-effective options. Updates happen automatically without requiring any\n action from you. Your workloads continue running during updates with no interruption\n

\n
\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

\n
\n \n

When you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.

\n
" } }, "ec2KeyPair": { @@ -2623,7 +2579,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Batch compute environment. You can create MANAGED or\n UNMANAGED compute environments. MANAGED compute environments can\n use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use\n EC2 resources.

\n

In a managed compute environment, Batch manages the capacity and instance types of the\n compute resources within the environment. This is based on the compute resource specification\n that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand\n Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in\n your managed compute environment. You can optionally set a maximum price so that Spot\n Instances only launch when the Spot Instance price is less than a specified percentage of the\n On-Demand price.

\n \n

Multi-node parallel jobs aren't supported on Spot Instances.

\n
\n

In an unmanaged compute environment, you can manage your own EC2 compute resources and\n have flexibility with how you configure your compute resources. For example, you can use\n custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance\n AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment,\n you can use the DescribeComputeEnvironments operation to find the Amazon ECS\n cluster that's associated with it. Then, launch your container instances into that Amazon ECS\n cluster. For more information, see Launching an Amazon ECS container\n instance in the Amazon Elastic Container Service Developer Guide.

\n \n

To create a compute environment that uses EKS resources, the caller must have\n permissions to call eks:DescribeCluster.

\n
\n \n

Batch doesn't automatically upgrade the AMIs in a compute environment after it's\n created. For example, it also doesn't update the AMIs in your compute environment when a\n newer version of the Amazon ECS optimized AMI is available. You're responsible for the management\n of the guest operating system. This includes any updates and security patches. You're also\n responsible for any additional application software or utilities that you install on the\n compute resources. There are two ways to use a new AMI for your Batch jobs. The original\n method is to complete these steps:

\n
    \n
  1. \n

    Create a new compute environment with the new AMI.

    \n
  2. \n
  3. \n

    Add the compute environment to an existing job queue.

    \n
  4. \n
  5. \n

    Remove the earlier compute environment from your job queue.

    \n
  6. \n
  7. \n

    Delete the earlier compute environment.

    \n
  8. \n
\n

In April 2022, Batch added enhanced support for updating compute environments. For\n more information, see Updating compute environments.\n To use the enhanced updating of compute environments to update AMIs, follow these\n rules:

\n
    \n
  • \n

    Either don't set the service role (serviceRole) parameter or set it to\n the AWSBatchServiceRole service-linked role.

    \n
  • \n
  • \n

    Set the allocation strategy (allocationStrategy) parameter to\n BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, or\n SPOT_PRICE_CAPACITY_OPTIMIZED.

    \n
  • \n
  • \n

    Set the update to latest image version (updateToLatestImageVersion)\n parameter to true. The updateToLatestImageVersion parameter \n is used when you update a compute environment. This parameter is ignored when you create \n a compute environment.

    \n
  • \n
  • \n

    Don't specify an AMI ID in imageId, imageIdOverride (in\n \n ec2Configuration\n ), or in the launch template\n (launchTemplate). In that case, Batch selects the latest Amazon ECS\n optimized AMI that's supported by Batch at the time the infrastructure update is\n initiated. Alternatively, you can specify the AMI ID in the imageId or\n imageIdOverride parameters, or the launch template identified by the\n LaunchTemplate properties. Changing any of these properties starts an\n infrastructure update. If the AMI ID is specified in the launch template, it can't be\n replaced by specifying an AMI ID in either the imageId or\n imageIdOverride parameters. It can only be replaced by specifying a\n different launch template, or if the launch template version is set to\n $Default or $Latest, by setting either a new default version\n for the launch template (if $Default) or by adding a new version to the\n launch template (if $Latest).

    \n
  • \n
\n

If these rules are followed, any update that starts an infrastructure update causes the\n AMI ID to be re-selected. If the version setting in the launch template\n (launchTemplate) is set to $Latest or $Default, the\n latest or default version of the launch template is evaluated up at the time of the\n infrastructure update, even if the launchTemplate wasn't updated.

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

Creates an Batch compute environment. You can create MANAGED or\n UNMANAGED compute environments. MANAGED compute environments can\n use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use\n EC2 resources.

\n

In a managed compute environment, Batch manages the capacity and instance types of the\n compute resources within the environment. This is based on the compute resource specification\n that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand\n Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in\n your managed compute environment. You can optionally set a maximum price so that Spot\n Instances only launch when the Spot Instance price is less than a specified percentage of the\n On-Demand price.

\n

In an unmanaged compute environment, you can manage your own EC2 compute resources and\n have flexibility with how you configure your compute resources. For example, you can use\n custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance\n AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment,\n you can use the DescribeComputeEnvironments operation to find the Amazon ECS\n cluster that's associated with it. Then, launch your container instances into that Amazon ECS\n cluster. For more information, see Launching an Amazon ECS container\n instance in the Amazon Elastic Container Service Developer Guide.

\n \n

Batch doesn't automatically upgrade the AMIs in a compute environment after it's\n created. For more information on how to update a compute environment's AMI, see Updating compute environments in the Batch User Guide.

\n
", "smithy.api#examples": [ { "title": "To create a managed EC2 compute environment", @@ -2763,7 +2719,7 @@ "eksConfiguration": { "target": "com.amazonaws.batch#EksConfiguration", "traits": { - "smithy.api#documentation": "

The details for the Amazon EKS cluster that supports the compute environment.

" + "smithy.api#documentation": "

The details for the Amazon EKS cluster that supports the compute environment.

\n \n

To create a compute environment that uses EKS resources, the caller must have\n permissions to call eks:DescribeCluster.

\n
" } }, "context": { @@ -4631,7 +4587,7 @@ "target": "com.amazonaws.batch#ImageType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The image type to match with the instance type to select an AMI. The supported values are\n different for ECS and EKS resources.

\n
\n
ECS
\n
\n

If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2) is used. If a new image type is\n specified in an update, but neither an imageId nor a imageIdOverride\n parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's\n supported by Batch is used.

\n
\n
ECS_AL2
\n
\n

\n Amazon Linux\n 2: Default for all non-GPU instance families.

\n
\n
ECS_AL2_NVIDIA
\n
\n

\n Amazon Linux 2\n (GPU): Default for all GPU instance families (for example P4 and\n G4) and can be used for all non Amazon Web Services Graviton-based instance types.

\n
\n
ECS_AL2023
\n
\n

\n Amazon Linux 2023: Batch\n supports Amazon Linux 2023.

\n \n

Amazon Linux 2023 does not support A1 instances.

\n
\n
\n
ECS_AL1
\n
\n

\n Amazon Linux. Amazon Linux has\n reached the end-of-life of standard support. For more information, see Amazon Linux AMI.

\n
\n
\n
\n
EKS
\n
\n

If the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux\n AMI (EKS_AL2) is used. If a new image type is specified in an update,\n but neither an imageId nor a imageIdOverride parameter is specified,\n then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.

\n
\n
EKS_AL2
\n
\n

\n Amazon\n Linux 2: Default for all non-GPU instance families.

\n
\n
EKS_AL2_NVIDIA
\n
\n

\n Amazon\n Linux 2 (accelerated): Default for all GPU instance families (for example,\n P4 and G4) and can be used for all non Amazon Web Services Graviton-based\n instance types.

\n
\n
EKS_AL2023
\n
\n

\n Amazon\n Linux 2023: Batch supports Amazon Linux 2023.

\n \n

Amazon Linux 2023 does not support A1 instances.

\n
\n
\n
EKS_AL2023_NVIDIA
\n
\n

\n Amazon\n Linux 2023 (accelerated): GPU instance families and can be used for all non Amazon Web Services\n Graviton-based instance types.

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

The image type to match with the instance type to select an AMI. The supported values are\n different for ECS and EKS resources.

\n
\n
ECS
\n
\n

If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2) is used. If a new image type is\n specified in an update, but neither an imageId nor a imageIdOverride\n parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's\n supported by Batch is used.

\n \n

Amazon Web Services will end support for Amazon ECS optimized AL2-optimized and AL2-accelerated AMIs. Starting in January 2026, Batch will change\n the default AMI for new Amazon ECS compute environments from Amazon Linux 2 to Amazon Linux 2023.\n We recommend migrating Batch Amazon ECS compute environments to Amazon Linux 2023 to maintain\n optimal performance and security. For more information on upgrading from AL2 to AL2023, see How to migrate\n from ECS AL2 to ECS AL2023 in the Batch User Guide.

\n
\n
\n
ECS_AL2
\n
\n

\n Amazon Linux\n 2: Default for all non-GPU instance families.

\n
\n
ECS_AL2_NVIDIA
\n
\n

\n Amazon Linux 2\n (GPU): Default for all GPU instance families (for example P4 and\n G4) and can be used for all non Amazon Web Services Graviton-based instance types.

\n
\n
ECS_AL2023
\n
\n

\n Amazon Linux 2023: Batch\n supports Amazon Linux 2023.

\n \n

Amazon Linux 2023 does not support A1 instances.

\n
\n
\n
ECS_AL2023_NVIDIA
\n
\n

\n Amazon Linux 2023\n (GPU): For all GPU instance families and can be used for all non Amazon Web Services Graviton-based instance types.

\n \n

ECS_AL2023_NVIDIA doesn't support p3 and g3 instance types.

\n
\n
\n
\n
\n
EKS
\n
\n

If the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux\n AMI (EKS_AL2) is used. If a new image type is specified in an update,\n but neither an imageId nor a imageIdOverride parameter is specified,\n then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.

\n \n

Starting end of October 2025 Amazon EKS optimized Amazon Linux 2023 AMIs will be the\n default on Batch for EKS versions prior to 1.33. Starting from Kubernetes version 1.33,\n EKS optimized Amazon Linux 2023 AMIs will be the default when it becomes supported on\n Batch.

\n

Amazon Web Services will end\n support for Amazon EKS AL2-optimized and AL2-accelerated AMIs, starting 11/26/25. You can continue\n using Batch-provided Amazon EKS optimized Amazon Linux 2 AMIs on your Amazon EKS compute\n environments beyond the 11/26/25 end-of-support date, these compute environments will no\n longer receive any new software updates, security patches, or bug fixes from\n Amazon Web Services. For more information on upgrading from AL2 to AL2023, see How to upgrade from EKS AL2 to EKS AL2023 in the Batch User Guide.

\n
\n
\n
EKS_AL2
\n
\n

\n Amazon\n Linux 2: Default for all non-GPU instance families.

\n
\n
EKS_AL2_NVIDIA
\n
\n

\n Amazon\n Linux 2 (accelerated): Default for all GPU instance families (for example,\n P4 and G4) and can be used for all non Amazon Web Services Graviton-based\n instance types.

\n
\n
EKS_AL2023
\n
\n

\n Amazon\n Linux 2023: Batch supports Amazon Linux 2023.

\n \n

Amazon Linux 2023 does not support A1 instances.

\n
\n
\n
EKS_AL2023_NVIDIA
\n
\n

\n Amazon\n Linux 2023 (accelerated): GPU instance families and can be used for all non Amazon Web Services\n Graviton-based instance types.

\n
\n
\n
\n
", "smithy.api#required": {} } }, @@ -4744,7 +4700,7 @@ "ipcMode": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The IPC resource namespace to use for the containers in the task.

" + "smithy.api#documentation": "

The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. For more information see ipcMode in EcsTaskProperties.

" } }, "taskRoleArn": { @@ -4756,7 +4712,7 @@ "pidMode": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The process namespace to use for the containers in the task.

" + "smithy.api#documentation": "

The process namespace to use for the containers in the task. The valid values are\n host, or task. For more information see pidMode in EcsTaskProperties.

" } }, "networkConfiguration": { @@ -6946,7 +6902,7 @@ "targetInstanceTypes": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The instance type or family that this override launch template should be applied to.

\n

This parameter is required when defining a launch template override.

\n

Information included in this parameter must meet the following requirements:

\n
    \n
  • \n

    Must be a valid Amazon EC2 instance type or family.

    \n
  • \n
  • \n

    \n optimal isn't allowed.

    \n
  • \n
  • \n

    \n targetInstanceTypes can target only instance types and families that are included within the \n ComputeResource.instanceTypes\n set. targetInstanceTypes doesn't need to include all of the instances from the instanceType set, but at least a subset. For example, if ComputeResource.instanceTypes includes [m5, g5], targetInstanceTypes can include [m5.2xlarge] and [m5.large] but not [c5.large].

    \n
  • \n
  • \n

    \n targetInstanceTypes included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.

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

The instance type or family that this override launch template should be applied to.

\n

This parameter is required when defining a launch template override.

\n

Information included in this parameter must meet the following requirements:

\n
    \n
  • \n

    Must be a valid Amazon EC2 instance type or family.

    \n
  • \n
  • \n

    The following Batch InstanceTypes are not allowed: optimal, default_x86_64, and default_arm64.

    \n
  • \n
  • \n

    \n targetInstanceTypes can target only instance types and families that are included within the \n ComputeResource.instanceTypes\n set. targetInstanceTypes doesn't need to include all of the instances from the instanceType set, but at least a subset. For example, if ComputeResource.instanceTypes includes [m5, g5], targetInstanceTypes can include [m5.2xlarge] and [m5.large] but not [c5.large].

    \n
  • \n
  • \n

    \n targetInstanceTypes included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.

    \n
  • \n
" } }, "userdataType": { @@ -7649,7 +7605,7 @@ "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
" + "smithy.api#documentation": "

The filter to apply to the query. Only one filter can be used at a time. When the filter\n is used, jobStatus is ignored. The results are sorted by the createdAt field,\n with the most recent jobs being first.

\n
\n
JOB_NAME
\n
\n

The value of the filter is a case-insensitive match for the job name. If the value\n ends with an asterisk (*), the filter matches any job name that begins with the string\n before the '*'. This corresponds to the jobName value. For example,\n test1 matches both Test1 and test1, and\n test1* matches both test1 and Test10. When the\n JOB_NAME filter is used, the results are grouped by the job name and\n version.

\n
\n
BEFORE_CREATED_AT
\n
\n

The value for the filter is the time that's before the job was created. This\n corresponds to the createdAt value. The value is a string representation of\n the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

\n
\n
AFTER_CREATED_AT
\n
\n

The value for the filter is the time that's after the job was created. This\n corresponds to the createdAt value. The value is a string representation of\n the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

\n
\n
" } } }, @@ -7782,7 +7738,7 @@ "target": "com.amazonaws.batch#LogDriver", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The log driver to use for the container. The valid values that are listed for this parameter\n are log drivers that the Amazon ECS container agent can communicate with by default.

\n

The supported log drivers are awslogs, fluentd, gelf,\n json-file, journald, logentries, syslog, and\n splunk.

\n \n

Jobs that are running on Fargate resources are restricted to the awslogs and\n splunk log drivers.

\n
\n
\n
awsfirelens
\n
\n

Specifies the firelens logging driver. For more information on configuring Firelens, see\n Send\n Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner in the\n Amazon Elastic Container Service Developer Guide.

\n
\n
awslogs
\n
\n

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver\n in the Batch User Guide and Amazon CloudWatch Logs logging\n driver in the Docker documentation.

\n
\n
fluentd
\n
\n

Specifies the Fluentd logging driver. For more information including usage and options,\n see Fluentd logging\n driver in the Docker documentation.

\n
\n
gelf
\n
\n

Specifies the Graylog Extended Format (GELF) logging driver. For more information\n including usage and options, see Graylog Extended Format logging\n driver in the Docker documentation.

\n
\n
journald
\n
\n

Specifies the journald logging driver. For more information including usage and options,\n see Journald logging\n driver in the Docker documentation.

\n
\n
json-file
\n
\n

Specifies the JSON file logging driver. For more information including usage and options,\n see JSON File\n logging driver in the Docker documentation.

\n
\n
splunk
\n
\n

Specifies the Splunk logging driver. For more information including usage and options,\n see Splunk logging\n driver in the Docker documentation.

\n
\n
syslog
\n
\n

Specifies the syslog logging driver. For more information including usage and options,\n see Syslog logging\n driver in the Docker documentation.

\n
\n
\n \n

If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS\n container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to\n work with that driver. We encourage you to submit pull requests for changes that you want to\n have included. However, Amazon Web Services doesn't currently support running modified copies of this\n software.

\n
\n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

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

The log driver to use for the container. The valid values that are listed for this parameter\n are log drivers that the Amazon ECS container agent can communicate with by default.

\n

The supported log drivers are awsfirelens, awslogs, fluentd, gelf,\n json-file, journald, logentries, syslog, and\n splunk.

\n \n

Jobs that are running on Fargate resources are restricted to the awslogs and\n splunk log drivers.

\n
\n
\n
awsfirelens
\n
\n

Specifies the firelens logging driver. For more information on configuring Firelens, see\n Send\n Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner in the\n Amazon Elastic Container Service Developer Guide.

\n
\n
awslogs
\n
\n

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver\n in the Batch User Guide and Amazon CloudWatch Logs logging\n driver in the Docker documentation.

\n
\n
fluentd
\n
\n

Specifies the Fluentd logging driver. For more information including usage and options,\n see Fluentd logging\n driver in the Docker documentation.

\n
\n
gelf
\n
\n

Specifies the Graylog Extended Format (GELF) logging driver. For more information\n including usage and options, see Graylog Extended Format logging\n driver in the Docker documentation.

\n
\n
journald
\n
\n

Specifies the journald logging driver. For more information including usage and options,\n see Journald logging\n driver in the Docker documentation.

\n
\n
json-file
\n
\n

Specifies the JSON file logging driver. For more information including usage and options,\n see JSON File\n logging driver in the Docker documentation.

\n
\n
splunk
\n
\n

Specifies the Splunk logging driver. For more information including usage and options,\n see Splunk logging\n driver in the Docker documentation.

\n
\n
syslog
\n
\n

Specifies the syslog logging driver. For more information including usage and options,\n see Syslog logging\n driver in the Docker documentation.

\n
\n
\n \n

If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS\n container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to\n work with that driver. We encourage you to submit pull requests for changes that you want to\n have included. However, Amazon Web Services doesn't currently support running modified copies of this\n software.

\n
\n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

", "smithy.api#required": {} } }, @@ -8538,13 +8494,13 @@ "operatingSystemFamily": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The operating system for the compute environment. Valid values are:\n LINUX (default), WINDOWS_SERVER_2019_CORE,\n WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and\n WINDOWS_SERVER_2022_FULL.

\n \n

The following parameters can’t be set for Windows containers: linuxParameters,\n privileged, user, ulimits,\n readonlyRootFilesystem, and efsVolumeConfiguration.

\n
\n \n

The Batch Scheduler checks the compute environments that are attached to the job queue before \n registering a task definition with Fargate. In this scenario, the job queue is where the job is \n submitted. If the job requires a Windows container and the first compute environment is LINUX, \n the compute environment is skipped and the next compute environment is checked until a Windows-based \n compute environment is found.

\n
\n \n

Fargate Spot is not supported for ARM64 and Windows-based containers on Fargate. \n A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job \n queue with only Fargate Spot compute environments. However, you can attach both FARGATE and\n FARGATE_SPOT compute environments to the same job queue.

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

The operating system for the compute environment. Valid values are:\n LINUX (default), WINDOWS_SERVER_2019_CORE,\n WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and\n WINDOWS_SERVER_2022_FULL.

\n \n

The following parameters can’t be set for Windows containers: linuxParameters,\n privileged, user, ulimits,\n readonlyRootFilesystem, and efsVolumeConfiguration.

\n
\n \n

The Batch Scheduler checks the compute environments that are attached to the job queue before \n registering a task definition with Fargate. In this scenario, the job queue is where the job is \n submitted. If the job requires a Windows container and the first compute environment is LINUX, \n the compute environment is skipped and the next compute environment is checked until a Windows-based \n compute environment is found.

\n
\n \n

Fargate Spot is not supported on Windows-based containers on Fargate. \n A job queue will be blocked if a Windows job is submitted to a job \n queue with only Fargate Spot compute environments. However, you can attach both FARGATE and\n FARGATE_SPOT compute environments to the same job queue.

\n
" } }, "cpuArchitecture": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The vCPU architecture. The default value is X86_64. Valid values are\n X86_64 and ARM64.

\n \n

This parameter must be set to X86_64 for Windows containers.

\n
\n \n

Fargate Spot is not supported for ARM64 and Windows-based containers on\n Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is\n submitted to a job queue with only Fargate Spot compute environments. However, you can attach\n both FARGATE and FARGATE_SPOT compute environments to the same job\n queue.

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

The vCPU architecture. The default value is X86_64. Valid values are\n X86_64 and ARM64.

\n \n

This parameter must be set to X86_64 for Windows containers.

\n
\n \n

Fargate Spot is not supported on Windows-based containers on\n Fargate. A job queue will be blocked if a Windows job is\n submitted to a job queue with only Fargate Spot compute environments. However, you can attach\n both FARGATE and FARGATE_SPOT compute environments to the same job\n queue.

\n
" } } }, @@ -9131,7 +9087,7 @@ "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A share identifier or share identifier prefix. If the string ends with an asterisk\n (*), this entry specifies the weight factor to use for share identifiers that start with\n that prefix. The list of share identifiers in a fair-share policy can't overlap. For\n example, you can't have one that specifies a shareIdentifier of UserA*\n and another that specifies a shareIdentifier of UserA-1.

\n

There can be no more than 500 share identifiers active in a job queue.

\n

The string is limited to 255 alphanumeric characters, and can be followed by an asterisk\n (*).

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

A share identifier or share identifier prefix. If the string ends with an asterisk\n (*), this entry specifies the weight factor to use for share identifiers that start with\n that prefix. The list of share identifiers in a fair-share policy can't overlap. For\n example, you can't have one that specifies a shareIdentifier of UserA*\n and another that specifies a shareIdentifier of UserA1.

\n

There can be no more than 500 share identifiers active in a job queue.

\n

The string is limited to 255 alphanumeric characters, and can be followed by an asterisk\n (*).

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

" + "smithy.api#documentation": "

The share identifier for the service job. Don't specify this parameter if the job\n queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share\n scheduling policy, then this parameter must be specified.

" } }, "timeoutConfig": { @@ -10370,7 +10326,7 @@ "clientToken": { "target": "com.amazonaws.batch#ClientRequestToken", "traits": { - "smithy.api#documentation": "

If this parameter is specified and two update requests with identical payloads and \n clientTokens are received, these requests are considered the same request and \n the second request is rejected. A clientToken is valid for 8 hours or until\n one hour after the consumable resource is deleted, whichever is less.

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

If this parameter is specified and two update requests with identical payloads and \n clientTokens are received, these requests are considered the same request. Both requests will succeed, but the update will only happen once. A clientToken is valid for 8 hours.

", "smithy.api#idempotencyToken": {} } } diff --git a/codegen/sdk/aws-models/bcm-dashboards.json b/codegen/sdk/aws-models/bcm-dashboards.json new file mode 100644 index 00000000000..c892ddfe11f --- /dev/null +++ b/codegen/sdk/aws-models/bcm-dashboards.json @@ -0,0 +1,2503 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.bcmdashboards#AWSBCMDashboardsService": { + "type": "service", + "version": "2025-08-18", + "operations": [ + { + "target": "com.amazonaws.bcmdashboards#CreateDashboard" + }, + { + "target": "com.amazonaws.bcmdashboards#DeleteDashboard" + }, + { + "target": "com.amazonaws.bcmdashboards#GetDashboard" + }, + { + "target": "com.amazonaws.bcmdashboards#GetResourcePolicy" + }, + { + "target": "com.amazonaws.bcmdashboards#ListDashboards" + }, + { + "target": "com.amazonaws.bcmdashboards#ListTagsForResource" + }, + { + "target": "com.amazonaws.bcmdashboards#TagResource" + }, + { + "target": "com.amazonaws.bcmdashboards#UntagResource" + }, + { + "target": "com.amazonaws.bcmdashboards#UpdateDashboard" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "BCM Dashboards", + "arnNamespace": "bcm-dashboards", + "endpointPrefix": "bcm-dashboards" + }, + "aws.auth#sigv4": { + "name": "bcm-dashboards" + }, + "aws.endpoints#dualStackOnlyEndpoints": {}, + "aws.endpoints#standardPartitionalEndpoints": { + "endpointPatternType": "service_region_dnsSuffix" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "

Amazon Web Services Billing and Cost Management Dashboards is a service that enables you to create, manage, and share dashboards that combine multiple visualizations of your Amazon Web Services cost and usage data. You can combine multiple data sources including Cost Explorer, Savings Plans, and Reserved Instance metrics into unified dashboards, helping you analyze spending patterns and share cost insights across your organization.

You can use the Amazon Web Services Billing and Cost Management Dashboards API to programmatically create, manage, and share dashboards. This includes creating custom dashboards, configuring widgets, managing dashboard permissions, and sharing dashboards across accounts in your organization.

", + "smithy.api#title": "AWS Billing and Cost Management Dashboards", + "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" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "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://bcm-dashboards-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://bcm-dashboards.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "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": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://bcm-dashboards-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": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://bcm-dashboards.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": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1" + } + ] + }, + "url": "https://bcm-dashboards-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": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1" + } + ] + }, + "url": "https://bcm-dashboards.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": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://bcm-dashboards-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": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://bcm-dashboards.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.bcmdashboards#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bcmdashboards#GenericString", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.bcmdashboards#CostAndUsageQuery": { + "type": "structure", + "members": { + "metrics": { + "target": "com.amazonaws.bcmdashboards#MetricNames", + "traits": { + "smithy.api#documentation": "

The specific cost and usage metrics to retrieve.

Valid values for CostAndUsageQuery metrics are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

", + "smithy.api#required": {} + } + }, + "timeRange": { + "target": "com.amazonaws.bcmdashboards#DateTimeRange", + "traits": { + "smithy.api#documentation": "

The time period for which to retrieve data. Can be specified as absolute dates or relative time periods.

", + "smithy.api#required": {} + } + }, + "granularity": { + "target": "com.amazonaws.bcmdashboards#Granularity", + "traits": { + "smithy.api#documentation": "

The granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.

", + "smithy.api#required": {} + } + }, + "groupBy": { + "target": "com.amazonaws.bcmdashboards#GroupDefinitions", + "traits": { + "smithy.api#documentation": "

Specifies how to group the retrieved data, such as by SERVICE, ACCOUNT, or TAG.

" + } + }, + "filter": { + "target": "com.amazonaws.bcmdashboards#Expression", + "traits": { + "smithy.api#documentation": "

The filter expression to be applied to the cost and usage data.

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

Defines the parameters for retrieving Amazon Web Services cost and usage data. Includes specifications for metrics, time periods, granularity, grouping dimensions, and filtering conditions.

" + } + }, + "com.amazonaws.bcmdashboards#CostCategoryValues": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The key of the cost category to filter on.

" + } + }, + "values": { + "target": "com.amazonaws.bcmdashboards#StringList", + "traits": { + "smithy.api#documentation": "

The values to match for the specified cost category key.

" + } + }, + "matchOptions": { + "target": "com.amazonaws.bcmdashboards#MatchOptions", + "traits": { + "smithy.api#documentation": "

The match options for cost category values, such as EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH.

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

Specifies the values and match options for cost category-based filtering in cost and usage queries.

" + } + }, + "com.amazonaws.bcmdashboards#CreateDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdashboards#CreateDashboardRequest" + }, + "output": { + "target": "com.amazonaws.bcmdashboards#CreateDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdashboards#AccessDeniedException" + }, + { + "target": "com.amazonaws.bcmdashboards#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdashboards#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bcmdashboards#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdashboards#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new dashboard that can contain multiple widgets displaying cost and usage data. You can add custom widgets or use predefined widgets, arranging them in your preferred layout.

", + "smithy.api#examples": [ + { + "title": "Creating a dashboard", + "input": { + "name": "cost-dashboards", + "description": "Dashboard for tracking costs", + "widgets": [ + { + "title": "Monthly Cost Trend", + "width": 4, + "height": 7, + "horizontalOffset": 0, + "configs": [ + { + "displayConfig": { + "graph": { + "costTrend": { + "visualType": "LINE" + } + } + }, + "queryParameters": { + "costAndUsage": { + "granularity": "MONTHLY", + "groupBy": [ + { + "key": "SERVICE", + "type": "DIMENSION" + } + ], + "metrics": [ + "UnblendedCost" + ], + "timeRange": { + "endTime": { + "type": "RELATIVE", + "value": "now" + }, + "startTime": { + "type": "RELATIVE", + "value": "-9M" + } + } + } + } + } + ] + } + ] + } + } + ] + } + }, + "com.amazonaws.bcmdashboards#CreateDashboardRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bcmdashboards#DashboardName", + "traits": { + "smithy.api#documentation": "

The name of the dashboard. The name must be unique within your account.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bcmdashboards#Description", + "traits": { + "smithy.api#documentation": "

A description of the dashboard's purpose or contents.

" + } + }, + "widgets": { + "target": "com.amazonaws.bcmdashboards#WidgetList", + "traits": { + "smithy.api#documentation": "

An array of widget configurations that define the visualizations to be displayed in the dashboard. Each dashboard can contain up to 20 widgets.

", + "smithy.api#required": {} + } + }, + "resourceTags": { + "target": "com.amazonaws.bcmdashboards#ResourceTagList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the dashboard resource for organization and management.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdashboards#CreateDashboardResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bcmdashboards#DashboardArn", + "traits": { + "smithy.api#documentation": "

The ARN of the newly created dashboard.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdashboards#DashboardArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:dashboard/(\\*|[-a-z0-9]+)$" + } + }, + "com.amazonaws.bcmdashboards#DashboardName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 50 + }, + "smithy.api#pattern": "^(?!.* {2})[a-zA-Z][a-zA-Z0-9 _-]{0,48}[a-zA-Z0-9_-]$" + } + }, + "com.amazonaws.bcmdashboards#DashboardReference": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bcmdashboards#DashboardArn", + "traits": { + "smithy.api#documentation": "

The ARN of the referenced dashboard.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bcmdashboards#DashboardName", + "traits": { + "smithy.api#documentation": "

The name of the referenced dashboard.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bcmdashboards#Description", + "traits": { + "smithy.api#documentation": "

The description of the referenced dashboard.

" + } + }, + "type": { + "target": "com.amazonaws.bcmdashboards#DashboardType", + "traits": { + "smithy.api#documentation": "

The dashboard type.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bcmdashboards#GenericTimeStamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the dashboard was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bcmdashboards#GenericTimeStamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the dashboard was last modified.

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

Contains basic information about a dashboard, including its ARN, name, type, and timestamps.

" + } + }, + "com.amazonaws.bcmdashboards#DashboardReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdashboards#DashboardReference" + } + }, + "com.amazonaws.bcmdashboards#DashboardType": { + "type": "enum", + "members": { + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.bcmdashboards#DateTimeRange": { + "type": "structure", + "members": { + "startTime": { + "target": "com.amazonaws.bcmdashboards#DateTimeValue", + "traits": { + "smithy.api#documentation": "

The start time of the date range for querying data.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.bcmdashboards#DateTimeValue", + "traits": { + "smithy.api#documentation": "

The end time of the date range for querying data.

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

Defines a time period with explicit start and end times for data queries.

" + } + }, + "com.amazonaws.bcmdashboards#DateTimeType": { + "type": "enum", + "members": { + "ABSOLUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABSOLUTE" + } + }, + "RELATIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELATIVE" + } + } + } + }, + "com.amazonaws.bcmdashboards#DateTimeValue": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bcmdashboards#DateTimeType", + "traits": { + "smithy.api#documentation": "

The type of date/time value: ABSOLUTE for specific dates or RELATIVE for dynamic time periods.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bcmdashboards#GenericString", + "traits": { + "smithy.api#documentation": "

The actual date/time value.

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

Represents a point in time that can be specified as either an absolute date (for example, \"2025-07-01\") or a relative time period using ISO 8601 duration format (for example, \"-P3M\" for three months ago).

" + } + }, + "com.amazonaws.bcmdashboards#DeleteDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdashboards#DeleteDashboardRequest" + }, + "output": { + "target": "com.amazonaws.bcmdashboards#DeleteDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdashboards#AccessDeniedException" + }, + { + "target": "com.amazonaws.bcmdashboards#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdashboards#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdashboards#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specified dashboard. This action cannot be undone.

", + "smithy.api#examples": [ + { + "title": "Deleting a dashboard", + "input": { + "arn": "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh" + }, + "output": { + "arn": "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh" + } + } + ] + } + }, + "com.amazonaws.bcmdashboards#DeleteDashboardRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bcmdashboards#DashboardArn", + "traits": { + "smithy.api#documentation": "

The ARN of the dashboard to be deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdashboards#DeleteDashboardResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bcmdashboards#DashboardArn", + "traits": { + "smithy.api#documentation": "

The ARN of the dashboard that was deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdashboards#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^(?!.* {2})[ a-zA-Z0-9.,!?;:@#$%&\\-_/\\\\]*$" + } + }, + "com.amazonaws.bcmdashboards#Dimension": { + "type": "enum", + "members": { + "AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AZ" + } + }, + "INSTANCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_TYPE" + } + }, + "LINKED_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINKED_ACCOUNT" + } + }, + "OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPERATION" + } + }, + "PURCHASE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PURCHASE_TYPE" + } + }, + "REGION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGION" + } + }, + "SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE" + } + }, + "USAGE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USAGE_TYPE" + } + }, + "USAGE_TYPE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USAGE_TYPE_GROUP" + } + }, + "RECORD_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECORD_TYPE" + } + }, + "RESOURCE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_ID" + } + }, + "SUBSCRIPTION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBSCRIPTION_ID" + } + }, + "TAG_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAG_KEY" + } + }, + "OPERATING_SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPERATING_SYSTEM" + } + }, + "TENANCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TENANCY" + } + }, + "BILLING_ENTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BILLING_ENTITY" + } + }, + "RESERVATION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESERVATION_ID" + } + }, + "COST_CATEGORY_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COST_CATEGORY_NAME" + } + }, + "DATABASE_ENGINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATABASE_ENGINE" + } + }, + "LEGAL_ENTITY_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEGAL_ENTITY_NAME" + } + }, + "SAVINGS_PLANS_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAVINGS_PLANS_TYPE" + } + }, + "INSTANCE_TYPE_FAMILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_TYPE_FAMILY" + } + }, + "CACHE_ENGINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CACHE_ENGINE" + } + }, + "DEPLOYMENT_OPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYMENT_OPTION" + } + }, + "SCOPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCOPE" + } + }, + "PLATFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLATFORM" + } + } + } + }, + "com.amazonaws.bcmdashboards#DimensionValues": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bcmdashboards#Dimension", + "traits": { + "smithy.api#documentation": "

The key of the dimension to filter on (for example, SERVICE, USAGE_TYPE, or OPERATION).

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.bcmdashboards#StringList", + "traits": { + "smithy.api#documentation": "

The values to match for the specified dimension key.

", + "smithy.api#required": {} + } + }, + "matchOptions": { + "target": "com.amazonaws.bcmdashboards#MatchOptions", + "traits": { + "smithy.api#documentation": "

The match options for dimension values, such as EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH.

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

Specifies the values and match options for dimension-based filtering in cost and usage queries.

" + } + }, + "com.amazonaws.bcmdashboards#DisplayConfig": { + "type": "union", + "members": { + "graph": { + "target": "com.amazonaws.bcmdashboards#GraphDisplayConfigMap", + "traits": { + "smithy.api#documentation": "

The configuration for graphical display of the widget data, including chart type and visual options.

" + } + }, + "table": { + "target": "com.amazonaws.bcmdashboards#TableDisplayConfigStruct", + "traits": { + "smithy.api#documentation": "

The configuration for tabular display of the widget data.

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

Defines how the widget's data should be visualized, including chart type, color schemes, axis configurations, and other display preferences.

" + } + }, + "com.amazonaws.bcmdashboards#Expression": { + "type": "structure", + "members": { + "or": { + "target": "com.amazonaws.bcmdashboards#Expressions", + "traits": { + "smithy.api#documentation": "

A list of expressions to combine with OR logic.

" + } + }, + "and": { + "target": "com.amazonaws.bcmdashboards#Expressions", + "traits": { + "smithy.api#documentation": "

A list of expressions to combine with AND logic.

" + } + }, + "not": { + "target": "com.amazonaws.bcmdashboards#Expression", + "traits": { + "smithy.api#documentation": "

An expression to negate with NOT logic.

" + } + }, + "dimensions": { + "target": "com.amazonaws.bcmdashboards#DimensionValues", + "traits": { + "smithy.api#documentation": "

The dimension values to include in the filter expression.

" + } + }, + "tags": { + "target": "com.amazonaws.bcmdashboards#TagValues", + "traits": { + "smithy.api#documentation": "

The tag values to include in the filter expression.

" + } + }, + "costCategories": { + "target": "com.amazonaws.bcmdashboards#CostCategoryValues", + "traits": { + "smithy.api#documentation": "

The cost category values to include in the filter expression.

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

Defines complex filtering conditions using logical operators (AND, OR, NOT) and various filter types.

" + } + }, + "com.amazonaws.bcmdashboards#Expressions": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdashboards#Expression" + } + }, + "com.amazonaws.bcmdashboards#GenericString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.bcmdashboards#GenericTimeStamp": { + "type": "timestamp" + }, + "com.amazonaws.bcmdashboards#GetDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdashboards#GetDashboardRequest" + }, + "output": { + "target": "com.amazonaws.bcmdashboards#GetDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdashboards#AccessDeniedException" + }, + { + "target": "com.amazonaws.bcmdashboards#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdashboards#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmdashboards#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdashboards#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.

", + "smithy.api#examples": [ + { + "title": "Getting information about a dashboard", + "input": { + "arn": "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh" + }, + "output": { + "arn": "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", + "name": "cost-dashboards", + "description": "Dashboard for tracking costs", + "type": "CUSTOM", + "createdAt": 1.753741462721E9, + "updatedAt": 1.753741462721E9, + "widgets": [ + { + "title": "Monthly Cost Trend", + "width": 4, + "height": 7, + "horizontalOffset": 0, + "configs": [ + { + "displayConfig": { + "graph": { + "costTrend": { + "visualType": "LINE" + } + } + }, + "queryParameters": { + "costAndUsage": { + "granularity": "MONTHLY", + "groupBy": [ + { + "key": "SERVICE", + "type": "DIMENSION" + } + ], + "metrics": [ + "UnblendedCost" + ], + "timeRange": { + "endTime": { + "type": "RELATIVE", + "value": "now" + }, + "startTime": { + "type": "RELATIVE", + "value": "-6M" + } + } + } + } + } + ] + } + ] + } + } + ], + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmdashboards#GetDashboardRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bcmdashboards#DashboardArn", + "traits": { + "smithy.api#documentation": "

The ARN of the dashboard to retrieve. This is required to uniquely identify the dashboard.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdashboards#GetDashboardResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bcmdashboards#DashboardArn", + "traits": { + "smithy.api#documentation": "

The ARN of the retrieved dashboard.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bcmdashboards#DashboardName", + "traits": { + "smithy.api#documentation": "

The name of the retrieved dashboard.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bcmdashboards#Description", + "traits": { + "smithy.api#documentation": "

The description of the retrieved dashboard.

" + } + }, + "type": { + "target": "com.amazonaws.bcmdashboards#DashboardType", + "traits": { + "smithy.api#documentation": "

Indicates the dashboard type.

", + "smithy.api#required": {} + } + }, + "widgets": { + "target": "com.amazonaws.bcmdashboards#WidgetList", + "traits": { + "smithy.api#documentation": "

An array of widget configurations that make up the dashboard.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bcmdashboards#GenericTimeStamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the dashboard was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bcmdashboards#GenericTimeStamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the dashboard was last modified.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdashboards#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdashboards#GetResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.bcmdashboards#GetResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdashboards#AccessDeniedException" + }, + { + "target": "com.amazonaws.bcmdashboards#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdashboards#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmdashboards#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdashboards#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the resource-based policy attached to a dashboard, showing sharing configurations and permissions.

", + "smithy.api#examples": [ + { + "title": "Getting resource policy for a resource", + "input": { + "resourceArn": "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh" + }, + "output": { + "policyDocument": "{}", + "resourceArn": "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh" + } + } + ], + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmdashboards#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bcmdashboards#DashboardArn", + "traits": { + "smithy.api#documentation": "

The ARN of the dashboard whose resource-based policy you want to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdashboards#GetResourcePolicyResponse": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bcmdashboards#DashboardArn", + "traits": { + "smithy.api#documentation": "

The ARN of the dashboard for which the resource-based policy was retrieved.

", + "smithy.api#required": {} + } + }, + "policyDocument": { + "target": "com.amazonaws.bcmdashboards#GenericString", + "traits": { + "smithy.api#documentation": "

The JSON policy document that represents the dashboard's resource-based policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdashboards#Granularity": { + "type": "enum", + "members": { + "HOURLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOURLY" + } + }, + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAILY" + } + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHLY" + } + } + } + }, + "com.amazonaws.bcmdashboards#GraphDisplayConfig": { + "type": "structure", + "members": { + "visualType": { + "target": "com.amazonaws.bcmdashboards#VisualType", + "traits": { + "smithy.api#documentation": "

The type of visualization to use for the data.

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

Defines the visual representation settings for widget data, including the visualization type, styling options, and display preferences for different metric types.

" + } + }, + "com.amazonaws.bcmdashboards#GraphDisplayConfigMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bcmdashboards#GenericString" + }, + "value": { + "target": "com.amazonaws.bcmdashboards#GraphDisplayConfig" + } + }, + "com.amazonaws.bcmdashboards#GroupDefinition": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The key to use for grouping cost and usage data.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S\\s]*$", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bcmdashboards#GroupDefinitionType", + "traits": { + "smithy.api#default": "DIMENSION", + "smithy.api#documentation": "

The type of grouping to apply.

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

Specifies how to group cost and usage data.

" + } + }, + "com.amazonaws.bcmdashboards#GroupDefinitionType": { + "type": "enum", + "members": { + "DIMENSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIMENSION" + } + }, + "TAG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAG" + } + }, + "COST_CATEGORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COST_CATEGORY" + } + } + } + }, + "com.amazonaws.bcmdashboards#GroupDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdashboards#GroupDefinition" + } + }, + "com.amazonaws.bcmdashboards#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bcmdashboards#GenericString", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bcmdashboards#ListDashboards": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdashboards#ListDashboardsRequest" + }, + "output": { + "target": "com.amazonaws.bcmdashboards#ListDashboardsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdashboards#AccessDeniedException" + }, + { + "target": "com.amazonaws.bcmdashboards#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdashboards#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdashboards#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all dashboards in your account.

", + "smithy.api#examples": [ + { + "title": "Listing dashboards for a user", + "input": {}, + "output": { + "dashboards": [ + { + "createdAt": 1.753741462721E9, + "updatedAt": 1.753741462721E9, + "arn": "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", + "name": "monthly-cost-dashboard", + "description": "Dashboard for tracking monthly cost", + "type": "CUSTOM" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "dashboards" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "ListDashboardsSuccess", + "params": {}, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.bcmdashboards#ListDashboardsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bcmdashboards#MaxResults", + "traits": { + "smithy.api#default": 20, + "smithy.api#documentation": "

The maximum number of results to return in a single call. The default value is 20.

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

The token for the next page of results. Use the value returned in the previous response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdashboards#ListDashboardsResponse": { + "type": "structure", + "members": { + "dashboards": { + "target": "com.amazonaws.bcmdashboards#DashboardReferenceList", + "traits": { + "smithy.api#documentation": "

An array of dashboard references, containing basic information about each dashboard.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bcmdashboards#NextPageToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. Not returned if there are no more results to retrieve.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdashboards#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdashboards#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.bcmdashboards#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdashboards#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdashboards#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmdashboards#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdashboards#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all tags associated with a specified dashboard resource.

", + "smithy.api#examples": [ + { + "title": "Listing tags for a resource", + "input": { + "resourceArn": "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh" + }, + "output": { + "resourceTags": [ + { + "key": "keyOne", + "value": "valueOne" + }, + { + "key": "keyTwo", + "value": "valueTwo" + } + ] + } + } + ], + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmdashboards#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bcmdashboards#DashboardArn", + "traits": { + "smithy.api#documentation": "

The unique identifier for the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdashboards#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "resourceTags": { + "target": "com.amazonaws.bcmdashboards#ResourceTagList", + "traits": { + "smithy.api#documentation": "

The list of tags associated with the specified dashboard resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdashboards#MatchOption": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "ABSENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABSENT" + } + }, + "STARTS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTS_WITH" + } + }, + "ENDS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDS_WITH" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "GREATER_THAN_OR_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN_OR_EQUAL" + } + }, + "CASE_SENSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CASE_SENSITIVE" + } + }, + "CASE_INSENSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CASE_INSENSITIVE" + } + } + } + }, + "com.amazonaws.bcmdashboards#MatchOptions": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdashboards#MatchOption" + } + }, + "com.amazonaws.bcmdashboards#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bcmdashboards#MetricName": { + "type": "enum", + "members": { + "AmortizedCost": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AmortizedCost" + } + }, + "BlendedCost": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BlendedCost" + } + }, + "NetAmortizedCost": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetAmortizedCost" + } + }, + "NetUnblendedCost": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetUnblendedCost" + } + }, + "NormalizedUsageAmount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NormalizedUsageAmount" + } + }, + "UnblendedCost": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnblendedCost" + } + }, + "UsageQuantity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UsageQuantity" + } + }, + "SpendCoveredBySavingsPlans": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SpendCoveredBySavingsPlans" + } + }, + "Hour": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hour" + } + }, + "Unit": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unit" + } + }, + "Cost": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cost" + } + } + } + }, + "com.amazonaws.bcmdashboards#MetricNames": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdashboards#MetricName" + } + }, + "com.amazonaws.bcmdashboards#NextPageToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.bcmdashboards#QueryParameters": { + "type": "union", + "members": { + "costAndUsage": { + "target": "com.amazonaws.bcmdashboards#CostAndUsageQuery", + "traits": { + "smithy.api#documentation": "

The parameters for querying cost and usage data, including metrics, time range, granularity, grouping dimensions, and filters.

" + } + }, + "savingsPlansCoverage": { + "target": "com.amazonaws.bcmdashboards#SavingsPlansCoverageQuery", + "traits": { + "smithy.api#documentation": "

The parameters for querying Savings Plans coverage data, showing how much of your eligible compute usage is covered by Savings Plans.

" + } + }, + "savingsPlansUtilization": { + "target": "com.amazonaws.bcmdashboards#SavingsPlansUtilizationQuery", + "traits": { + "smithy.api#documentation": "

The parameters for querying Savings Plans utilization data, showing how effectively your Savings Plans are being used.

" + } + }, + "reservationCoverage": { + "target": "com.amazonaws.bcmdashboards#ReservationCoverageQuery", + "traits": { + "smithy.api#documentation": "

The parameters for querying Reserved Instance coverage data, showing how much of your eligible instance usage is covered by Reserved Instances.

" + } + }, + "reservationUtilization": { + "target": "com.amazonaws.bcmdashboards#ReservationUtilizationQuery", + "traits": { + "smithy.api#documentation": "

The parameters for querying Reserved Instance utilization data, showing how effectively your Reserved Instances are being used.

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

Defines the data retrieval parameters for a widget.

" + } + }, + "com.amazonaws.bcmdashboards#ReservationCoverageQuery": { + "type": "structure", + "members": { + "timeRange": { + "target": "com.amazonaws.bcmdashboards#DateTimeRange", + "traits": { + "smithy.api#required": {} + } + }, + "groupBy": { + "target": "com.amazonaws.bcmdashboards#GroupDefinitions", + "traits": { + "smithy.api#documentation": "

Specifies how to group the Reserved Instance coverage data, such as by service, Region, or instance type.

" + } + }, + "granularity": { + "target": "com.amazonaws.bcmdashboards#Granularity", + "traits": { + "smithy.api#documentation": "

The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.

" + } + }, + "filter": { + "target": "com.amazonaws.bcmdashboards#Expression" + }, + "metrics": { + "target": "com.amazonaws.bcmdashboards#MetricNames", + "traits": { + "smithy.api#documentation": "

The coverage metrics to include in the results.

Valid values for ReservationCoverageQuery metrics are Hour, Unit, and Cost.

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

Defines the parameters for querying Reserved Instance coverage data, including grouping options, metrics, and sorting preferences.

" + } + }, + "com.amazonaws.bcmdashboards#ReservationUtilizationQuery": { + "type": "structure", + "members": { + "timeRange": { + "target": "com.amazonaws.bcmdashboards#DateTimeRange", + "traits": { + "smithy.api#required": {} + } + }, + "groupBy": { + "target": "com.amazonaws.bcmdashboards#GroupDefinitions", + "traits": { + "smithy.api#documentation": "

Specifies how to group the Reserved Instance utilization data, such as by service, Region, or instance type.

" + } + }, + "granularity": { + "target": "com.amazonaws.bcmdashboards#Granularity", + "traits": { + "smithy.api#documentation": "

The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.

" + } + }, + "filter": { + "target": "com.amazonaws.bcmdashboards#Expression" + } + }, + "traits": { + "smithy.api#documentation": "

Defines the parameters for querying Reserved Instance utilization data, including grouping options and time granularity.

" + } + }, + "com.amazonaws.bcmdashboards#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bcmdashboards#GenericString", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bcmdashboards#ResourceTag": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bcmdashboards#ResourceTagKey", + "traits": { + "smithy.api#documentation": "

The key of the tag to be attached to the dashboard resource.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bcmdashboards#ResourceTagValue", + "traits": { + "smithy.api#documentation": "

The value of the tag to be attached to the dashboard resource.

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

A key-value pair that can be attached to a dashboard for organization and management purposes.

" + } + }, + "com.amazonaws.bcmdashboards#ResourceTagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.bcmdashboards#ResourceTagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdashboards#ResourceTagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bcmdashboards#ResourceTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdashboards#ResourceTag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bcmdashboards#ResourceTagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.bcmdashboards#SavingsPlansCoverageQuery": { + "type": "structure", + "members": { + "timeRange": { + "target": "com.amazonaws.bcmdashboards#DateTimeRange", + "traits": { + "smithy.api#required": {} + } + }, + "metrics": { + "target": "com.amazonaws.bcmdashboards#MetricNames", + "traits": { + "smithy.api#documentation": "

The coverage metrics to include in the results.

Valid value for SavingsPlansCoverageQuery metrics is SpendCoveredBySavingsPlans.

" + } + }, + "granularity": { + "target": "com.amazonaws.bcmdashboards#Granularity", + "traits": { + "smithy.api#documentation": "

The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.

" + } + }, + "groupBy": { + "target": "com.amazonaws.bcmdashboards#GroupDefinitions", + "traits": { + "smithy.api#documentation": "

Specifies how to group the Savings Plans coverage data, such as by service or instance family.

" + } + }, + "filter": { + "target": "com.amazonaws.bcmdashboards#Expression" + } + }, + "traits": { + "smithy.api#documentation": "

Defines the parameters for querying Savings Plans coverage data, including metrics, grouping options, and time granularity.

" + } + }, + "com.amazonaws.bcmdashboards#SavingsPlansUtilizationQuery": { + "type": "structure", + "members": { + "timeRange": { + "target": "com.amazonaws.bcmdashboards#DateTimeRange", + "traits": { + "smithy.api#required": {} + } + }, + "granularity": { + "target": "com.amazonaws.bcmdashboards#Granularity", + "traits": { + "smithy.api#documentation": "

The time granularity of the retrieved data: HOURLY, DAILY, or MONTHLY.

" + } + }, + "filter": { + "target": "com.amazonaws.bcmdashboards#Expression" + } + }, + "traits": { + "smithy.api#documentation": "

Defines the parameters for querying Savings Plans utilization data, including time granularity and sorting preferences.

" + } + }, + "com.amazonaws.bcmdashboards#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bcmdashboards#GenericString", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request would exceed service quotas. For example, attempting to create more than 20 widgets in a dashboard or exceeding the maximum number of dashboards per account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.bcmdashboards#StringList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bcmdashboards#TableDisplayConfigStruct": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Configuration structure for customizing the tabular display of widget data.

" + } + }, + "com.amazonaws.bcmdashboards#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdashboards#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bcmdashboards#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdashboards#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdashboards#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmdashboards#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdashboards#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds or updates tags for a specified dashboard resource.

", + "smithy.api#examples": [ + { + "title": "Adding tag(s) to a resource", + "input": { + "resourceArn": "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", + "resourceTags": [ + { + "key": "keyOne", + "value": "valueOne" + } + ] + } + } + ] + } + }, + "com.amazonaws.bcmdashboards#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bcmdashboards#DashboardArn", + "traits": { + "smithy.api#documentation": "

The unique identifier for the resource.

", + "smithy.api#required": {} + } + }, + "resourceTags": { + "target": "com.amazonaws.bcmdashboards#ResourceTagList", + "traits": { + "smithy.api#documentation": "

The tags to add to the dashboard resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdashboards#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdashboards#TagValues": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The key of the tag to filter on.

" + } + }, + "values": { + "target": "com.amazonaws.bcmdashboards#StringList", + "traits": { + "smithy.api#documentation": "

The values to match for the specified tag key.

" + } + }, + "matchOptions": { + "target": "com.amazonaws.bcmdashboards#MatchOptions", + "traits": { + "smithy.api#documentation": "

The match options for tag values, such as EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH.

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

Specifies tag-based filtering options for cost and usage queries.

" + } + }, + "com.amazonaws.bcmdashboards#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bcmdashboards#GenericString", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bcmdashboards#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdashboards#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bcmdashboards#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdashboards#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdashboards#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmdashboards#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdashboards#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes specified tags from a dashboard resource.

", + "smithy.api#examples": [ + { + "title": "Removing tag(s) from a resource", + "input": { + "resourceArn": "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", + "resourceTagKeys": [ + "keyOne" + ] + } + } + ] + } + }, + "com.amazonaws.bcmdashboards#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bcmdashboards#DashboardArn", + "traits": { + "smithy.api#documentation": "

The unique identifier for the resource.

", + "smithy.api#required": {} + } + }, + "resourceTagKeys": { + "target": "com.amazonaws.bcmdashboards#ResourceTagKeyList", + "traits": { + "smithy.api#documentation": "

The keys of the tags to remove from the dashboard resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdashboards#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdashboards#UpdateDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdashboards#UpdateDashboardRequest" + }, + "output": { + "target": "com.amazonaws.bcmdashboards#UpdateDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdashboards#AccessDeniedException" + }, + { + "target": "com.amazonaws.bcmdashboards#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdashboards#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmdashboards#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdashboards#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing dashboard's properties, including its name, description, and widget configurations.

", + "smithy.api#examples": [ + { + "title": "Updating a dashboard", + "input": { + "arn": "arn:aws:bcm-dashboards::123456789012:dashboard/abcd1234-ab12-12ab-1ab2-abcd1234efgh", + "name": "cost-dashboards-updated", + "description": "Dashboard for tracking costs version 2", + "widgets": [ + { + "title": "Monthly Cost Trend", + "width": 4, + "height": 7, + "horizontalOffset": 2, + "configs": [ + { + "displayConfig": { + "graph": { + "costTrend": { + "visualType": "LINE" + } + } + }, + "queryParameters": { + "costAndUsage": { + "granularity": "MONTHLY", + "groupBy": [ + { + "key": "SERVICE", + "type": "DIMENSION" + } + ], + "metrics": [ + "UnblendedCost" + ], + "timeRange": { + "endTime": { + "type": "RELATIVE", + "value": "now" + }, + "startTime": { + "type": "RELATIVE", + "value": "-3M" + } + } + } + } + } + ] + } + ] + } + } + ] + } + }, + "com.amazonaws.bcmdashboards#UpdateDashboardRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bcmdashboards#DashboardArn", + "traits": { + "smithy.api#documentation": "

The ARN of the dashboard to update.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bcmdashboards#DashboardName", + "traits": { + "smithy.api#documentation": "

The new name for the dashboard. If not specified, the existing name is retained.

" + } + }, + "description": { + "target": "com.amazonaws.bcmdashboards#Description", + "traits": { + "smithy.api#documentation": "

The new description for the dashboard. If not specified, the existing description is retained.

" + } + }, + "widgets": { + "target": "com.amazonaws.bcmdashboards#WidgetList", + "traits": { + "smithy.api#documentation": "

The updated array of widget configurations for the dashboard. Replaces all existing widgets.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdashboards#UpdateDashboardResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.bcmdashboards#DashboardArn", + "traits": { + "smithy.api#documentation": "

The ARN of the updated dashboard.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdashboards#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bcmdashboards#GenericString", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The input parameters do not satisfy the requirements. Check the error message for specific validation details.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bcmdashboards#VisualType": { + "type": "enum", + "members": { + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + }, + "BAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAR" + } + }, + "STACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STACK" + } + } + } + }, + "com.amazonaws.bcmdashboards#Widget": { + "type": "structure", + "members": { + "title": { + "target": "com.amazonaws.bcmdashboards#WidgetTitle", + "traits": { + "smithy.api#documentation": "

The title of the widget.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bcmdashboards#Description", + "traits": { + "smithy.api#documentation": "

A description of the widget's purpose or the data it displays.

" + } + }, + "width": { + "target": "com.amazonaws.bcmdashboards#WidgetWidth", + "traits": { + "smithy.api#default": 4, + "smithy.api#documentation": "

The width of the widget in column spans. The dashboard layout consists of a grid system.

" + } + }, + "height": { + "target": "com.amazonaws.bcmdashboards#WidgetHeight", + "traits": { + "smithy.api#default": 7, + "smithy.api#documentation": "

The height of the widget in row spans. The dashboard layout consists of a grid system.

" + } + }, + "horizontalOffset": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the starting column position of the widget in the dashboard's grid layout. Used to control widget placement.

" + } + }, + "configs": { + "target": "com.amazonaws.bcmdashboards#WidgetConfigList", + "traits": { + "smithy.api#documentation": "

An array of configurations that define the data queries and display settings for the widget.

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

A configurable visualization component within a dashboard that displays specific cost and usage metrics. Each widget can show data as charts or tables and includes settings for data querying, filtering, and visual presentation.

" + } + }, + "com.amazonaws.bcmdashboards#WidgetConfig": { + "type": "structure", + "members": { + "queryParameters": { + "target": "com.amazonaws.bcmdashboards#QueryParameters", + "traits": { + "smithy.api#documentation": "

The parameters that define what data the widget should retrieve and how it should be filtered or grouped.

", + "smithy.api#required": {} + } + }, + "displayConfig": { + "target": "com.amazonaws.bcmdashboards#DisplayConfig", + "traits": { + "smithy.api#documentation": "

The configuration that determines how the retrieved data should be visualized in the widget.

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

Defines the complete configuration for a widget, including data retrieval settings and visualization preferences.

" + } + }, + "com.amazonaws.bcmdashboards#WidgetConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdashboards#WidgetConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bcmdashboards#WidgetHeight": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 4, + "max": 10 + } + } + }, + "com.amazonaws.bcmdashboards#WidgetList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdashboards#Widget" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.bcmdashboards#WidgetTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 50 + }, + "smithy.api#pattern": "^(?!.* {2})[a-zA-Z0-9_-][ a-zA-Z0-9_-]*[a-zA-Z0-9_-]$" + } + }, + "com.amazonaws.bcmdashboards#WidgetWidth": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 2, + "max": 6 + } + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/bcm-pricing-calculator.json b/codegen/sdk/aws-models/bcm-pricing-calculator.json index e7d0d8c9ef9..51c100fc1d4 100644 --- a/codegen/sdk/aws-models/bcm-pricing-calculator.json +++ b/codegen/sdk/aws-models/bcm-pricing-calculator.json @@ -386,166 +386,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://bcm-pricing-calculator-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://bcm-pricing-calculator.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://bcm-pricing-calculator-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://bcm-pricing-calculator.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eu-isoe-west-1" - } - ] - }, - "url": "https://bcm-pricing-calculator-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eu-isoe-west-1" - } - ] - }, - "url": "https://bcm-pricing-calculator.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isof-south-1" - } - ] - }, - "url": "https://bcm-pricing-calculator-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isof-south-1" - } - ] - }, - "url": "https://bcm-pricing-calculator.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { diff --git a/codegen/sdk/aws-models/bcm-recommended-actions.json b/codegen/sdk/aws-models/bcm-recommended-actions.json new file mode 100644 index 00000000000..15dd2a80742 --- /dev/null +++ b/codegen/sdk/aws-models/bcm-recommended-actions.json @@ -0,0 +1,997 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.bcmrecommendedactions#AWSBillingAndCostManagementRecommendedActions": { + "type": "service", + "version": "2024-11-14", + "operations": [ + { + "target": "com.amazonaws.bcmrecommendedactions#ListRecommendedActions" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "BCM Recommended Actions", + "arnNamespace": "bcm-recommended-actions", + "endpointPrefix": "bcm-recommended-actions", + "docId": "bcm-recommended-actions-2024-11-14" + }, + "aws.auth#sigv4": { + "name": "bcm-recommended-actions" + }, + "aws.endpoints#dualStackOnlyEndpoints": {}, + "aws.endpoints#standardPartitionalEndpoints": { + "endpointPatternType": "service_region_dnsSuffix" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "

You can use the Billing and Cost Management Recommended Actions API to programmatically query your best practices and recommendations to optimize your costs.

The Billing and Cost Management Recommended Actions API provides the following endpoint:

  • https://bcm-recommended-actions.us-east-1.api.aws

", + "smithy.api#title": "AWS Billing and Cost Management Recommended Actions", + "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" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "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://bcm-recommended-actions-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://bcm-recommended-actions.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "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": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://bcm-recommended-actions-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": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://bcm-recommended-actions.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": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1" + } + ] + }, + "url": "https://bcm-recommended-actions-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": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1" + } + ] + }, + "url": "https://bcm-recommended-actions.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": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://bcm-recommended-actions-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": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://bcm-recommended-actions.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.bcmrecommendedactions#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BCMRecommendedActionsAccessDenied", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.bcmrecommendedactions#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.bcmrecommendedactions#ActionFilter": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bcmrecommendedactions#FilterName", + "traits": { + "smithy.api#documentation": "

The category to filter on. Valid values are FEATURE for feature type, SEVERITY for severity level, and TYPE for recommendation type.

", + "smithy.api#required": {} + } + }, + "matchOption": { + "target": "com.amazonaws.bcmrecommendedactions#MatchOption", + "traits": { + "smithy.api#documentation": "

Specifies how to apply the filter. Use EQUALS to include matching results or NOT_EQUALS to exclude matching results.

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.bcmrecommendedactions#FilterValues", + "traits": { + "smithy.api#documentation": "

One or more values to match against the specified key.

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

Describes a filter that returns a more specific list of recommended actions.

" + } + }, + "com.amazonaws.bcmrecommendedactions#ActionFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmrecommendedactions#ActionFilter" + } + }, + "com.amazonaws.bcmrecommendedactions#ActionType": { + "type": "enum", + "members": { + "ADD_ALTERNATE_BILLING_CONTACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD_ALTERNATE_BILLING_CONTACT" + } + }, + "CREATE_ANOMALY_MONITOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_ANOMALY_MONITOR" + } + }, + "CREATE_BUDGET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_BUDGET" + } + }, + "ENABLE_COST_OPTIMIZATION_HUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_COST_OPTIMIZATION_HUB" + } + }, + "MIGRATE_TO_GRANULAR_PERMISSIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIGRATE_TO_GRANULAR_PERMISSIONS" + } + }, + "PAYMENTS_DUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAYMENTS_DUE" + } + }, + "PAYMENTS_PAST_DUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAYMENTS_PAST_DUE" + } + }, + "REVIEW_ANOMALIES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVIEW_ANOMALIES" + } + }, + "REVIEW_BUDGET_ALERTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVIEW_BUDGET_ALERTS" + } + }, + "REVIEW_BUDGETS_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVIEW_BUDGETS_EXCEEDED" + } + }, + "REVIEW_EXPIRING_RI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVIEW_EXPIRING_RI" + } + }, + "REVIEW_EXPIRING_SP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVIEW_EXPIRING_SP" + } + }, + "REVIEW_FREETIER_USAGE_ALERTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVIEW_FREETIER_USAGE_ALERTS" + } + }, + "REVIEW_SAVINGS_OPPORTUNITY_RECOMMENDATIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVIEW_SAVINGS_OPPORTUNITY_RECOMMENDATIONS" + } + }, + "UPDATE_EXPIRED_PAYMENT_METHOD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_EXPIRED_PAYMENT_METHOD" + } + }, + "UPDATE_INVALID_PAYMENT_METHOD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_INVALID_PAYMENT_METHOD" + } + }, + "UPDATE_TAX_EXEMPTION_CERTIFICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_TAX_EXEMPTION_CERTIFICATE" + } + }, + "UPDATE_TAX_REGISTRATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_TAX_REGISTRATION_NUMBER" + } + } + } + }, + "com.amazonaws.bcmrecommendedactions#Context": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bcmrecommendedactions#Feature": { + "type": "enum", + "members": { + "ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT" + } + }, + "BUDGETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUDGETS" + } + }, + "COST_ANOMALY_DETECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COST_ANOMALY_DETECTION" + } + }, + "COST_OPTIMIZATION_HUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COST_OPTIMIZATION_HUB" + } + }, + "FREE_TIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FREE_TIER" + } + }, + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } + }, + "PAYMENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAYMENTS" + } + }, + "RESERVATIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESERVATIONS" + } + }, + "SAVINGS_PLANS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAVINGS_PLANS" + } + }, + "TAX_SETTINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TAX_SETTINGS" + } + } + } + }, + "com.amazonaws.bcmrecommendedactions#FilterName": { + "type": "enum", + "members": { + "FEATURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FEATURE" + } + }, + "SEVERITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEVERITY" + } + }, + "TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TYPE" + } + } + } + }, + "com.amazonaws.bcmrecommendedactions#FilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "[\\S\\s]*" + } + }, + "com.amazonaws.bcmrecommendedactions#FilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmrecommendedactions#FilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bcmrecommendedactions#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BCMRecommendedActionsInternalServer", + "httpResponseCode": 500 + }, + "smithy.api#documentation": "

An unexpected error occurred during the processing of your request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bcmrecommendedactions#ListRecommendedActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmrecommendedactions#ListRecommendedActionsRequest" + }, + "output": { + "target": "com.amazonaws.bcmrecommendedactions#ListRecommendedActionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmrecommendedactions#AccessDeniedException" + }, + { + "target": "com.amazonaws.bcmrecommendedactions#InternalServerException" + }, + { + "target": "com.amazonaws.bcmrecommendedactions#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmrecommendedactions#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of recommended actions that match the filter criteria.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "recommendedActions" + }, + "smithy.test#smokeTests": [ + { + "id": "ListRecommendedActionsSuccess", + "params": { + "maxResults": 10 + }, + "expect": { + "failure": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams" + } + ] + } + }, + "com.amazonaws.bcmrecommendedactions#ListRecommendedActionsRequest": { + "type": "structure", + "members": { + "filter": { + "target": "com.amazonaws.bcmrecommendedactions#RequestFilter", + "traits": { + "smithy.api#documentation": "

The criteria that you want all returned recommended actions to match.

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

The maximum number of results to return in the response.

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

The pagination token that indicates the next set of results that you want to retrieve.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmrecommendedactions#ListRecommendedActionsResponse": { + "type": "structure", + "members": { + "recommendedActions": { + "target": "com.amazonaws.bcmrecommendedactions#RecommendedActions", + "traits": { + "smithy.api#documentation": "

The list of recommended actions that satisfy the filter criteria.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bcmrecommendedactions#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token that indicates the next set of results that you want to retrieve.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmrecommendedactions#MatchOption": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "NOT_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EQUALS" + } + } + } + }, + "com.amazonaws.bcmrecommendedactions#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bcmrecommendedactions#NextStep": { + "type": "string" + }, + "com.amazonaws.bcmrecommendedactions#NextSteps": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmrecommendedactions#NextStep" + } + }, + "com.amazonaws.bcmrecommendedactions#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.bcmrecommendedactions#RecommendedAction": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID for the recommended action.

" + } + }, + "type": { + "target": "com.amazonaws.bcmrecommendedactions#ActionType", + "traits": { + "smithy.api#documentation": "

The type of action you can take by adopting the recommended action.

" + } + }, + "accountId": { + "target": "com.amazonaws.bcmrecommendedactions#AccountId", + "traits": { + "smithy.api#documentation": "

The account that the recommended action is for.

" + } + }, + "severity": { + "target": "com.amazonaws.bcmrecommendedactions#Severity", + "traits": { + "smithy.api#documentation": "

The severity associated with the recommended action.

" + } + }, + "feature": { + "target": "com.amazonaws.bcmrecommendedactions#Feature", + "traits": { + "smithy.api#documentation": "

The feature associated with the recommended action.

" + } + }, + "context": { + "target": "com.amazonaws.bcmrecommendedactions#Context", + "traits": { + "smithy.api#documentation": "

Context that applies to the recommended action.

" + } + }, + "nextSteps": { + "target": "com.amazonaws.bcmrecommendedactions#NextSteps", + "traits": { + "smithy.api#documentation": "

The possible next steps to execute the recommended action.

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

The time when the recommended action status was last updated.

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

Describes a specific recommended action.

" + } + }, + "com.amazonaws.bcmrecommendedactions#RecommendedActions": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmrecommendedactions#RecommendedAction" + } + }, + "com.amazonaws.bcmrecommendedactions#RequestFilter": { + "type": "structure", + "members": { + "actions": { + "target": "com.amazonaws.bcmrecommendedactions#ActionFilterList", + "traits": { + "smithy.api#documentation": "

A list of action filters that define criteria for filtering results. Each filter specifies a key, match option, and corresponding values to filter on.

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

Enables filtering of results based on specified action criteria. You can define multiple action filters to refine results using combinations of feature type, severity level, and recommendation type.

" + } + }, + "com.amazonaws.bcmrecommendedactions#Severity": { + "type": "enum", + "members": { + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" + } + }, + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARNING" + } + }, + "CRITICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRITICAL" + } + } + } + }, + "com.amazonaws.bcmrecommendedactions#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BCMRecommendedActionsThrottling", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "

The request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bcmrecommendedactions#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.bcmrecommendedactions#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

Provides a single, overarching explanation for the validation failure.

", + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.bcmrecommendedactions#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "

Lists each problematic field and why it failed validation.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BCMRecommendedActionsValidation", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an Amazon Web Services service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bcmrecommendedactions#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Provides the name of the field that failed validation.

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

Provides a message explaining why the field failed validation.

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

Provides specific details about why a particular field failed validation.

" + } + }, + "com.amazonaws.bcmrecommendedactions#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmrecommendedactions#ValidationExceptionField" + } + }, + "com.amazonaws.bcmrecommendedactions#ValidationExceptionReason": { + "type": "enum", + "members": { + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknownOperation" + } + }, + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cannotParse" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fieldValidationFailed" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/bedrock-agent-runtime.json b/codegen/sdk/aws-models/bedrock-agent-runtime.json index 967e1b79fd0..bf3a1244720 100644 --- a/codegen/sdk/aws-models/bedrock-agent-runtime.json +++ b/codegen/sdk/aws-models/bedrock-agent-runtime.json @@ -472,6 +472,12 @@ "smithy.api#pattern": "^[0-9a-zA-Z]+$" } }, + "com.amazonaws.bedrockagentruntime#AgentTraces": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#TracePart" + } + }, "com.amazonaws.bedrockagentruntime#AgentVersion": { "type": "string", "traits": { @@ -1047,17 +1053,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1071,17 +1066,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1095,17 +1079,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1119,17 +1092,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2996,6 +2958,23 @@ } } }, + "com.amazonaws.bedrockagentruntime#FlowControlNodeType": { + "type": "enum", + "members": { + "ITERATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Iterator" + } + }, + "LOOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Loop" + } + } + } + }, "com.amazonaws.bedrockagentruntime#FlowErrorCode": { "type": "enum", "members": { @@ -3121,6 +3100,18 @@ "traits": { "smithy.api#documentation": "

Contains information about a failure that occurred at the flow level during execution.

" } + }, + "nodeActionEvent": { + "target": "com.amazonaws.bedrockagentruntime#NodeActionEvent", + "traits": { + "smithy.api#documentation": "

Contains information about an action (operation) called by a node during execution.

" + } + }, + "nodeDependencyEvent": { + "target": "com.amazonaws.bedrockagentruntime#NodeDependencyEvent", + "traits": { + "smithy.api#documentation": "

Contains information about an internal trace of a specific node during execution.

" + } } }, "traits": { @@ -3556,6 +3547,86 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#FlowNodeIODataType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "String" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Number" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Boolean" + } + }, + "OBJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Object" + } + }, + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Array" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowNodeInputCategory": { + "type": "enum", + "members": { + "LOOP_CONDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoopCondition" + } + }, + "RETURN_VALUE_TO_LOOP_START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReturnValueToLoopStart" + } + }, + "EXIT_LOOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExitLoop" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowNodeInputExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowNodeInputName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagentruntime#FlowNodeOutputName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, "com.amazonaws.bedrockagentruntime#FlowOutputContent": { "type": "union", "members": { @@ -3754,7 +3825,13 @@ "nodeActionTrace": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeActionEvent", "traits": { - "smithy.api#documentation": "

Contains information about an action (operation) called by a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

" + "smithy.api#documentation": "

Contains information about an action (operation) called by a node.

" + } + }, + "nodeDependencyTrace": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceDependencyEvent", + "traits": { + "smithy.api#documentation": "

Contains information about an internal trace of a node.

" } } }, @@ -3821,6 +3898,36 @@ } } }, + "com.amazonaws.bedrockagentruntime#FlowTraceDependencyEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the node that generated the dependency trace.

", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the dependency trace was generated.

", + "smithy.api#required": {} + } + }, + "traceElements": { + "target": "com.amazonaws.bedrockagentruntime#TraceElements", + "traits": { + "smithy.api#documentation": "

The trace elements containing detailed information about the dependency.

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

Contains information about a dependency trace event in the flow.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#FlowTraceEvent": { "type": "structure", "members": { @@ -3873,6 +3980,18 @@ "smithy.api#documentation": "

The name of the operation that the node called.

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

The request payload sent to the downstream service.

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

The response payload received from the downstream service.

" + } } }, "traits": { @@ -3925,6 +4044,44 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputExecutionChain": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputExecutionChainItem" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputExecutionChainItem": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the node in the execution chain.

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

The index position of this item in the execution chain.

" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#FlowControlNodeType", + "traits": { + "smithy.api#documentation": "

The type of execution chain item. Supported values are Iterator and Loop.

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

Represents an item in the execution chain for flow trace node input tracking.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputField": { "type": "structure", "members": { @@ -3941,6 +4098,30 @@ "smithy.api#documentation": "

The content of the node input.

", "smithy.api#required": {} } + }, + "source": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputSource", + "traits": { + "smithy.api#documentation": "

The source node that provides input data to this field.

" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "

The data type of the input field for compatibility validation.

" + } + }, + "category": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputCategory", + "traits": { + "smithy.api#documentation": "

The category of the input field.

" + } + }, + "executionChain": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputExecutionChain", + "traits": { + "smithy.api#documentation": "

The execution path through nested nodes like iterators and loops.

" + } } }, "traits": { @@ -3960,6 +4141,36 @@ } } }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputSource": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the source node that provides the input data.

", + "smithy.api#required": {} + } + }, + "outputFieldName": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeOutputName", + "traits": { + "smithy.api#documentation": "

The name of the output field from the source node.

", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputExpression", + "traits": { + "smithy.api#documentation": "

The expression used to extract data from the source.

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

Represents the source of input data for a flow trace node field.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputContent": { "type": "union", "members": { @@ -4020,6 +4231,18 @@ "smithy.api#documentation": "

The content of the node output.

", "smithy.api#required": {} } + }, + "next": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputNextList", + "traits": { + "smithy.api#documentation": "

The next node that receives output data from this field.

" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "

The data type of the output field for compatibility validation.

" + } } }, "traits": { @@ -4039,6 +4262,35 @@ } } }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputNext": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the next node that receives the output data.

", + "smithy.api#required": {} + } + }, + "inputFieldName": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "

The name of the input field in the next node that receives the data.

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

Represents the next node that receives output data from a flow trace.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputNextList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputNext" + } + }, "com.amazonaws.bedrockagentruntime#Function": { "type": "string", "traits": { @@ -8462,6 +8714,92 @@ "smithy.api#pattern": "^\\S*$" } }, + "com.amazonaws.bedrockagentruntime#NodeActionEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the node that called the operation.

", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the operation was called.

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

The ID of the request that the node made to the operation.

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

The name of the service that the node called.

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

The name of the operation that the node called.

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

The request payload sent to the downstream service.

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

The response payload received from the downstream service.

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

Contains information about an action (operation) called by a node during execution.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#NodeDependencyEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the node that generated the dependency trace.

", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the dependency trace was generated.

", + "smithy.api#required": {} + } + }, + "traceElements": { + "target": "com.amazonaws.bedrockagentruntime#NodeTraceElements", + "traits": { + "smithy.api#documentation": "

The trace elements containing detailed information about the node execution.

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

Contains information about an internal trace of a specific node during execution.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#NodeErrorCode": { "type": "enum", "members": { @@ -8573,6 +8911,40 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#NodeInputExecutionChain": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputExecutionChainItem" + } + }, + "com.amazonaws.bedrockagentruntime#NodeInputExecutionChainItem": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the node in the execution chain.

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

The index position of this item in the execution chain.

" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#FlowControlNodeType", + "traits": { + "smithy.api#documentation": "

The type of execution chain item. Supported values are Iterator and Loop.

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

Represents an item in the execution chain for node input tracking.

" + } + }, "com.amazonaws.bedrockagentruntime#NodeInputField": { "type": "structure", "members": { @@ -8589,6 +8961,30 @@ "smithy.api#documentation": "

The content of the input field, which can contain text or structured data.

", "smithy.api#required": {} } + }, + "source": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputSource", + "traits": { + "smithy.api#documentation": "

The source node that provides input data to this field.

" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "

The data type of the input field for compatibility validation.

" + } + }, + "category": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputCategory", + "traits": { + "smithy.api#documentation": "

The category of the input field.

" + } + }, + "executionChain": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputExecutionChain", + "traits": { + "smithy.api#documentation": "

The execution path through nested nodes like iterators and loops.

" + } } }, "traits": { @@ -8614,6 +9010,35 @@ "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" } }, + "com.amazonaws.bedrockagentruntime#NodeInputSource": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the source node that provides the input data.

", + "smithy.api#required": {} + } + }, + "outputFieldName": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeOutputName", + "traits": { + "smithy.api#documentation": "

The name of the output field from the source node.

", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputExpression", + "traits": { + "smithy.api#documentation": "

The expression used to extract data from the source.

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

Represents the source of input data for a node field.

" + } + }, "com.amazonaws.bedrockagentruntime#NodeName": { "type": "string", "traits": { @@ -8666,6 +9091,18 @@ "smithy.api#documentation": "

The content of the output field, which can contain text or structured data.

", "smithy.api#required": {} } + }, + "next": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputNextList", + "traits": { + "smithy.api#documentation": "

The next node that receives output data from this field.

" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "

The data type of the output field for compatibility validation.

" + } } }, "traits": { @@ -8691,6 +9128,50 @@ "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" } }, + "com.amazonaws.bedrockagentruntime#NodeOutputNext": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the next node that receives the output data.

", + "smithy.api#required": {} + } + }, + "inputFieldName": { + "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "

The name of the input field in the next node that receives the data.

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

Represents the next node that receives output data.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#NodeOutputNextList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputNext" + } + }, + "com.amazonaws.bedrockagentruntime#NodeTraceElements": { + "type": "union", + "members": { + "agentTraces": { + "target": "com.amazonaws.bedrockagentruntime#AgentTraces", + "traits": { + "smithy.api#documentation": "

Agent trace information for the node execution.

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

Contains trace elements for node execution tracking.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#NodeType": { "type": "enum", "members": { @@ -12829,6 +13310,21 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#TraceElements": { + "type": "union", + "members": { + "agentTraces": { + "target": "com.amazonaws.bedrockagentruntime#AgentTraces", + "traits": { + "smithy.api#documentation": "

Agent trace information for the flow execution.

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

Contains trace elements for flow execution tracking.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#TraceId": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/bedrock-agent.json b/codegen/sdk/aws-models/bedrock-agent.json index 8c1c931727d..c17b47ff078 100644 --- a/codegen/sdk/aws-models/bedrock-agent.json +++ b/codegen/sdk/aws-models/bedrock-agent.json @@ -995,8 +995,10 @@ "type": "structure", "members": { "agentAliasArn": { - "target": "com.amazonaws.bedrockagent#AgentAliasArn", + "target": "com.amazonaws.bedrockagent#FlowAgentAliasArn", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alias of the agent to invoke.

", "smithy.api#required": {} } @@ -2081,17 +2083,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2105,17 +2096,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2129,17 +2109,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2153,17 +2122,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -6647,6 +6605,15 @@ "smithy.api#documentation": "

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

" } }, + "com.amazonaws.bedrockagent#FlowAgentAliasArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^$|^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$" + } + }, "com.amazonaws.bedrockagent#FlowAliasArn": { "type": "string", "traits": { @@ -7069,6 +7036,42 @@ "smithy.api#pattern": "^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$" } }, + "com.amazonaws.bedrockagent#FlowKnowledgeBaseId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 10 + }, + "smithy.api#pattern": "^$|^[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagent#FlowLambdaArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^$|^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:lambda:([a-z]{2,}-){2,}\\d:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.bedrockagent#FlowLexBotAliasArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 78 + }, + "smithy.api#pattern": "^$|^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:lex:([a-z]{2,}-){2,}\\d:\\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagent#FlowLexBotLocaleId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.bedrockagent#FlowName": { "type": "string", "traits": { @@ -7496,6 +7499,22 @@ } } }, + "com.amazonaws.bedrockagent#FlowPromptArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^$|^(arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)$" + } + }, + "com.amazonaws.bedrockagent#FlowPromptModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^$|^(arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:(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.bedrockagent#FlowResource": { "type": "resource", "identifiers": { @@ -7537,6 +7556,16 @@ } } }, + "com.amazonaws.bedrockagent#FlowS3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^$|^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, "com.amazonaws.bedrockagent#FlowStatus": { "type": "enum", "members": { @@ -10299,7 +10328,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 5000000 }, "smithy.api#sensitive": {} @@ -10311,6 +10340,8 @@ "code": { "target": "com.amazonaws.bedrockagent#InlineCode", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", "smithy.api#documentation": "

The code that's executed in your inline code node. The code can access input data from previous nodes in the flow, perform operations on that data, and produce output that can be used by other nodes in your flow.

The code must be valid in the programming language that you specify.

", "smithy.api#required": {} } @@ -10318,6 +10349,8 @@ "language": { "target": "com.amazonaws.bedrockagent#SupportedLanguages", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "Python_3", "smithy.api#documentation": "

The programming language used by your inline code node.

The code must be valid in the programming language that you specify. Currently, only Python 3 (Python_3) is supported.

", "smithy.api#required": {} } @@ -10725,8 +10758,10 @@ "type": "structure", "members": { "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseId", + "target": "com.amazonaws.bedrockagent#FlowKnowledgeBaseId", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", "smithy.api#documentation": "

The unique identifier of the knowledge base to query.

", "smithy.api#required": {} } @@ -10782,15 +10817,6 @@ "smithy.api#documentation": "

Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in a flow in the Amazon Bedrock User Guide.

" } }, - "com.amazonaws.bedrockagent#KnowledgeBaseId": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 10 - }, - "smithy.api#pattern": "^[0-9a-zA-Z]+$" - } - }, "com.amazonaws.bedrockagent#KnowledgeBaseModelIdentifier": { "type": "string", "traits": { @@ -11096,8 +11122,10 @@ "type": "structure", "members": { "lambdaArn": { - "target": "com.amazonaws.bedrockagent#LambdaArn", + "target": "com.amazonaws.bedrockagent#FlowLambdaArn", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function to invoke.

", "smithy.api#required": {} } @@ -11107,37 +11135,23 @@ "smithy.api#documentation": "

Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in a flow in the Amazon Bedrock User Guide.

" } }, - "com.amazonaws.bedrockagent#LexBotAliasArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 78 - }, - "smithy.api#pattern": "^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.bedrockagent#LexBotLocaleId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, "com.amazonaws.bedrockagent#LexFlowNodeConfiguration": { "type": "structure", "members": { "botAliasArn": { - "target": "com.amazonaws.bedrockagent#LexBotAliasArn", + "target": "com.amazonaws.bedrockagent#FlowLexBotAliasArn", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.

", "smithy.api#required": {} } }, "localeId": { - "target": "com.amazonaws.bedrockagent#LexBotLocaleId", + "target": "com.amazonaws.bedrockagent#FlowLexBotLocaleId", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", "smithy.api#documentation": "

The Region to invoke the Amazon Lex bot in.

", "smithy.api#required": {} } @@ -14204,6 +14218,8 @@ "templateType": { "target": "com.amazonaws.bedrockagent#PromptTemplateType", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "TEXT", "smithy.api#documentation": "

The type of prompt template.

", "smithy.api#required": {} } @@ -14216,8 +14232,10 @@ } }, "modelId": { - "target": "com.amazonaws.bedrockagent#PromptModelIdentifier", + "target": "com.amazonaws.bedrockagent#FlowPromptModelIdentifier", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", "smithy.api#documentation": "

The unique identifier of the model or inference profile to run inference with.

", "smithy.api#required": {} } @@ -14243,8 +14261,10 @@ "type": "structure", "members": { "promptArn": { - "target": "com.amazonaws.bedrockagent#PromptArn", + "target": "com.amazonaws.bedrockagent#FlowPromptArn", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the prompt from Prompt management.

", "smithy.api#required": {} } @@ -15528,8 +15548,10 @@ "type": "structure", "members": { "bucketName": { - "target": "com.amazonaws.bedrockagent#S3BucketName", + "target": "com.amazonaws.bedrockagent#FlowS3BucketName", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", "smithy.api#documentation": "

The name of the Amazon S3 bucket from which to retrieve data.

", "smithy.api#required": {} } @@ -16420,8 +16442,10 @@ "type": "structure", "members": { "bucketName": { - "target": "com.amazonaws.bedrockagent#S3BucketName", + "target": "com.amazonaws.bedrockagent#FlowS3BucketName", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", "smithy.api#documentation": "

The name of the Amazon S3 bucket in which to store the input into the node.

", "smithy.api#required": {} } diff --git a/codegen/sdk/aws-models/bedrock-agentcore-control.json b/codegen/sdk/aws-models/bedrock-agentcore-control.json index 9f18f1d41c8..7df30153c6d 100644 --- a/codegen/sdk/aws-models/bedrock-agentcore-control.json +++ b/codegen/sdk/aws-models/bedrock-agentcore-control.json @@ -14,7 +14,70 @@ "smithy.api#httpError": 403 } }, - "com.amazonaws.bedrockagentcorecontrol#Agent": { + "com.amazonaws.bedrockagentcorecontrol#AgentEndpointDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentEndpointResource": { + "type": "resource", + "identifiers": { + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId" + }, + "endpointName": { + "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntimeEndpoint" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntimeEndpoint" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntimeEndpoint" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntimeEndpoint" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeEndpoints" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentResource": { + "type": "resource", + "identifiers": { + "agentRuntimeId": { + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId" + } + }, + "create": { + "target": "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntime" + }, + "read": { + "target": "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntime" + }, + "update": { + "target": "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntime" + }, + "delete": { + "target": "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntime" + }, + "list": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimes" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeVersions" + } + ] + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntime": { "type": "structure", "members": { "agentRuntimeArn": { @@ -60,7 +123,7 @@ } }, "status": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentStatus", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeStatus", "traits": { "smithy.api#documentation": "

The current status of the agent runtime.

", "smithy.api#required": {} @@ -71,7 +134,16 @@ "smithy.api#documentation": "

Contains information about an agent runtime. An agent runtime is the execution environment for a Amazon Bedrock Agent.

" } }, - "com.amazonaws.bedrockagentcorecontrol#AgentArtifact": { + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::Runtime" + }, + "smithy.api#pattern": "^arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:agent/[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}:([0-9]{0,4}[1-9][0-9]{0,4})$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArtifact": { "type": "union", "members": { "containerConfiguration": { @@ -85,7 +157,7 @@ "smithy.api#documentation": "

The artifact of the agent.

" } }, - "com.amazonaws.bedrockagentcorecontrol#AgentEndpoint": { + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpoint": { "type": "structure", "members": { "name": { @@ -122,7 +194,7 @@ } }, "status": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpointStatus", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointStatus", "traits": { "smithy.api#documentation": "

The current status of the agent runtime endpoint.

", "smithy.api#required": {} @@ -160,42 +232,22 @@ "smithy.api#documentation": "

Contains information about an agent runtime endpoint. An endpoint provides a way to connect to and interact with an agent runtime.

" } }, - "com.amazonaws.bedrockagentcorecontrol#AgentEndpointDescription": { + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointArn": { "type": "string", "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } + "aws.api#arnReference": { + "type": "AWS::BedrockAgentCore::RuntimeEndpoint" + }, + "smithy.api#pattern": "^arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:agentEndpoint/[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$" } }, - "com.amazonaws.bedrockagentcorecontrol#AgentEndpointResource": { - "type": "resource", - "identifiers": { - "agentRuntimeId": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId" - }, - "endpointName": { - "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName" - } - }, - "create": { - "target": "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntimeEndpoint" - }, - "read": { - "target": "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntimeEndpoint" - }, - "update": { - "target": "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntimeEndpoint" - }, - "delete": { - "target": "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntimeEndpoint" - }, - "list": { - "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeEndpoints" + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}$" } }, - "com.amazonaws.bedrockagentcorecontrol#AgentEndpointStatus": { + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointStatus": { "type": "enum", "members": { "CREATING": { @@ -236,62 +288,10 @@ } } }, - "com.amazonaws.bedrockagentcorecontrol#AgentEndpoints": { + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpoints": { "type": "list", "member": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpoint" - } - }, - "com.amazonaws.bedrockagentcorecontrol#AgentResource": { - "type": "resource", - "identifiers": { - "agentRuntimeId": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId" - } - }, - "create": { - "target": "com.amazonaws.bedrockagentcorecontrol#CreateAgentRuntime" - }, - "read": { - "target": "com.amazonaws.bedrockagentcorecontrol#GetAgentRuntime" - }, - "update": { - "target": "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntime" - }, - "delete": { - "target": "com.amazonaws.bedrockagentcorecontrol#DeleteAgentRuntime" - }, - "list": { - "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimes" - }, - "operations": [ - { - "target": "com.amazonaws.bedrockagentcorecontrol#ListAgentRuntimeVersions" - } - ] - }, - "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn": { - "type": "string", - "traits": { - "aws.api#arnReference": { - "type": "AWS::BedrockAgentCore::Runtime" - }, - "smithy.api#pattern": "^arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:agent/[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}:([0-9]{0,4}[1-9][0-9]{0,4})$" - } - }, - "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointArn": { - "type": "string", - "traits": { - "aws.api#arnReference": { - "type": "AWS::BedrockAgentCore::RuntimeEndpoint" - }, - "smithy.api#pattern": "^arn:(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:agentEndpoint/[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$" - } - }, - "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}$" + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpoint" } }, "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId": { @@ -306,17 +306,7 @@ "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,47}$" } }, - "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - }, - "smithy.api#pattern": "^([1-9][0-9]{0,4})$" - } - }, - "com.amazonaws.bedrockagentcorecontrol#AgentStatus": { + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeStatus": { "type": "enum", "members": { "CREATING": { @@ -357,10 +347,20 @@ } } }, - "com.amazonaws.bedrockagentcorecontrol#Agents": { + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^([1-9][0-9]{0,4})$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#AgentRuntimes": { "type": "list", "member": { - "target": "com.amazonaws.bedrockagentcorecontrol#Agent" + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntime" } }, "com.amazonaws.bedrockagentcorecontrol#AllowedAudience": { @@ -398,8 +398,17 @@ { "target": "com.amazonaws.bedrockagentcorecontrol#GetTokenVault" }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ListTagsForResource" + }, { "target": "com.amazonaws.bedrockagentcorecontrol#SetTokenVaultCMK" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#TagResource" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#UntagResource" } ], "resources": [ @@ -461,7 +470,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "

Amazon Bedrock AgentCore is in preview release and is subject to change.

Amazon Bedrock Agent Core Control is a service that enables you to manage memory resources for your Amazon Bedrock agents.

Use this API to create, retrieve, update, and delete memory resources and their associated memory strategies. Memory resources enable your agents to store and retrieve information from conversations and interactions.

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

is in preview release and is subject to change.

Welcome to the Amazon Bedrock AgentCore Control plane API reference. Control plane actions configure, create, modify, and monitor Amazon Web Services resources.

", "smithy.api#title": "Amazon Bedrock Agent Core Control Plane Fronting Layer", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -971,17 +980,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -995,17 +993,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1019,17 +1006,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1043,17 +1019,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1352,6 +1317,9 @@ "smithy.api#documentation": "

The network mode for the browser. This field specifies how the browser connects to the network.

", "smithy.api#required": {} } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#VpcConfig" } }, "traits": { @@ -1366,6 +1334,12 @@ "traits": { "smithy.api#enumValue": "PUBLIC" } + }, + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC" + } } } }, @@ -1544,6 +1518,9 @@ "smithy.api#documentation": "

The network mode for the code interpreter. This field specifies how the code interpreter connects to the network.

", "smithy.api#required": {} } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#VpcConfig" } }, "traits": { @@ -1564,6 +1541,12 @@ "traits": { "smithy.api#enumValue": "SANDBOX" } + }, + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC" + } } } }, @@ -1775,7 +1758,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Secure Agent.

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

Creates an Amazon Bedrock AgentCore Runtime.

", "smithy.api#http": { "code": 201, "method": "PUT", @@ -1816,7 +1799,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Secure AgentEndpoint.

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

Creates an AgentCore Runtime endpoint.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -1831,7 +1814,7 @@ "agentRuntimeId": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent runtime to create an endpoint for.

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

The unique identifier of the AgentCore Runtime to create an endpoint for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1839,20 +1822,20 @@ "name": { "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName", "traits": { - "smithy.api#documentation": "

The name of the agent runtime endpoint.

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

The name of the AgentCore Runtime endpoint.

", "smithy.api#required": {} } }, "agentRuntimeVersion": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", "traits": { - "smithy.api#documentation": "

The version of the agent runtime to use for the endpoint.

" + "smithy.api#documentation": "

The version of the AgentCore Runtime to use for the endpoint.

" } }, "description": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpointDescription", "traits": { - "smithy.api#documentation": "

The description of the agent runtime endpoint.

" + "smithy.api#documentation": "

The description of the AgentCore Runtime endpoint.

" } }, "clientToken": { @@ -1861,6 +1844,12 @@ "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure idempotency of the request.

", "smithy.api#idempotencyToken": {} } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "

A map of tag keys and values to assign to the agent runtime endpoint. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" + } } }, "traits": { @@ -1873,35 +1862,35 @@ "targetVersion": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", "traits": { - "smithy.api#documentation": "

The target version of the agent runtime for the endpoint.

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

The target version of the AgentCore Runtime for the endpoint.

", "smithy.api#required": {} } }, "agentRuntimeEndpointArn": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent runtime endpoint.

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

The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.

", "smithy.api#required": {} } }, "agentRuntimeArn": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent runtime.

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

The Amazon Resource Name (ARN) of the AgentCore Runtime.

", "smithy.api#required": {} } }, "status": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpointStatus", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointStatus", "traits": { - "smithy.api#documentation": "

The current status of the agent runtime endpoint.

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

The current status of the AgentCore Runtime endpoint.

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the agent runtime endpoint was created.

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

The timestamp when the AgentCore Runtime endpoint was created.

", "smithy.api#required": {} } } @@ -1916,34 +1905,34 @@ "agentRuntimeName": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeName", "traits": { - "smithy.api#documentation": "

The name of the secure agent.

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

The name of the AgentCore Runtime.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentcorecontrol#Description", "traits": { - "smithy.api#documentation": "

The description of the agent runtime.

" + "smithy.api#documentation": "

The description of the AgentCore Runtime.

" } }, "agentRuntimeArtifact": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentArtifact", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArtifact", "traits": { - "smithy.api#documentation": "

The artifact of the agent.

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

The artifact of the AgentCore Runtime.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", "traits": { - "smithy.api#documentation": "

The IAM role ARN that provides permissions for the agent runtime.

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

The IAM role ARN that provides permissions for the AgentCore Runtime.

", "smithy.api#required": {} } }, "networkConfiguration": { "target": "com.amazonaws.bedrockagentcorecontrol#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

The network configuration for the agent runtime.

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

The network configuration for the AgentCore Runtime.

", "smithy.api#required": {} } }, @@ -1960,13 +1949,25 @@ "environmentVariables": { "target": "com.amazonaws.bedrockagentcorecontrol#EnvironmentVariablesMap", "traits": { - "smithy.api#documentation": "

Environment variables to set in the agent runtime environment.

" + "smithy.api#documentation": "

Environment variables to set in the AgentCore Runtime environment.

" } }, "authorizerConfiguration": { "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", "traits": { - "smithy.api#documentation": "

The authorizer configuration for the agent runtime.

" + "smithy.api#documentation": "

The authorizer configuration for the AgentCore Runtime.

" + } + }, + "requestHeaderConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#RequestHeaderConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for HTTP request headers that will be passed through to the runtime.

" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "

A map of tag keys and values to assign to the agent runtime. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" } } }, @@ -1980,41 +1981,41 @@ "agentRuntimeArn": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent runtime.

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

The Amazon Resource Name (ARN) of the AgentCore Runtime.

", "smithy.api#required": {} } }, "workloadIdentityDetails": { "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails", "traits": { - "smithy.api#documentation": "

The workload identity details for the agent runtime.

" + "smithy.api#documentation": "

The workload identity details for the AgentCore Runtime.

" } }, "agentRuntimeId": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent runtime.

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

The unique identifier of the AgentCore Runtime.

", "smithy.api#required": {} } }, "agentRuntimeVersion": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", "traits": { - "smithy.api#documentation": "

The version of the agent runtime.

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

The version of the AgentCore Runtime.

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the agent runtime was created.

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

The timestamp when the AgentCore Runtime was created.

", "smithy.api#required": {} } }, "status": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentStatus", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeStatus", "traits": { - "smithy.api#documentation": "

The current status of the agent runtime.

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

The current status of the AgentCore Runtime.

", "smithy.api#required": {} } } @@ -2207,6 +2208,12 @@ "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": {} } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "

A map of tag keys and values to assign to the browser. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" + } } }, "traits": { @@ -2322,6 +2329,12 @@ "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": {} } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "

A map of tag keys and values to assign to the code interpreter. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

" + } } }, "traits": { @@ -2421,7 +2434,7 @@ "clientToken": { "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", "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#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, the service ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", "smithy.api#idempotencyToken": {} } }, @@ -2435,14 +2448,14 @@ "protocolType": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolType", "traits": { - "smithy.api#documentation": "

The protocol type for the gateway. Currently supports MCP (Model Context Protocol).

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

The protocol type for the gateway.

", "smithy.api#required": {} } }, "protocolConfiguration": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolConfiguration", "traits": { - "smithy.api#documentation": "

The configuration settings for the protocol specified in the protocolType parameter.

" + "smithy.api#documentation": "

The configuration settings for the protocol specified in the protocolType parameter.

" } }, "authorizerType": { @@ -2455,7 +2468,7 @@ "authorizerConfiguration": { "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", "traits": { - "smithy.api#documentation": "

The authorizer configuration for the Gateway.

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

The authorizer configuration for the gateway.

", "smithy.api#required": {} } }, @@ -2468,7 +2481,13 @@ "exceptionLevel": { "target": "com.amazonaws.bedrockagentcorecontrol#ExceptionLevel", "traits": { - "smithy.api#documentation": "

The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

" + "smithy.api#documentation": "

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "

A map of key-value pairs to associate with the gateway as metadata tags.

" } } }, @@ -2568,7 +2587,7 @@ "authorizerConfiguration": { "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", "traits": { - "smithy.api#documentation": "

The authorizer configuration for the created Gateway.

" + "smithy.api#documentation": "

The authorizer configuration for the created gateway.

" } }, "kmsKeyArn": { @@ -2580,13 +2599,13 @@ "workloadIdentityDetails": { "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails", "traits": { - "smithy.api#documentation": "

The workload identity details for the created Gateway.

" + "smithy.api#documentation": "

The workload identity details for the created gateway.

" } }, "exceptionLevel": { "target": "com.amazonaws.bedrockagentcorecontrol#ExceptionLevel", "traits": { - "smithy.api#documentation": "

The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

" + "smithy.api#documentation": "

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

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

Creates a target for a gateway. A target defines an endpoint that the gateway can connect to.

To create a target, you must specify the gateway identifier and target configuration.

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

Creates a target for a gateway. A target defines an endpoint that the gateway can connect to.

", "smithy.api#http": { "code": 202, "method": "POST", @@ -2641,7 +2660,7 @@ "gatewayIdentifier": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the gateway to create a target for. This can be either the gateway ID or the gateway ARN.

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

The identifier of the gateway to create a target for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2662,7 +2681,7 @@ "clientToken": { "target": "com.amazonaws.bedrockagentcorecontrol#ClientToken", "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#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, the service ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

Creates a new memory.

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

Creates a new Amazon Bedrock AgentCore Memory resource.

", "smithy.api#http": { "method": "POST", "uri": "/memories/create" @@ -3477,7 +3496,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Amazon Secure Agent.

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

Deletes an Amazon Bedrock AgentCore Runtime.

", "smithy.api#http": { "code": 200, "method": "DELETE", @@ -3512,7 +3531,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Amazon Secure AgentEndpoint.

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

Deletes an AAgentCore Runtime endpoint.

", "smithy.api#http": { "code": 200, "method": "DELETE", @@ -3527,7 +3546,7 @@ "agentRuntimeId": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent runtime associated with the endpoint.

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

The unique identifier of the AgentCore Runtime associated with the endpoint.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3535,7 +3554,7 @@ "endpointName": { "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName", "traits": { - "smithy.api#documentation": "

The name of the agent runtime endpoint to delete.

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

The name of the AgentCore Runtime endpoint to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3557,9 +3576,9 @@ "type": "structure", "members": { "status": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpointStatus", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointStatus", "traits": { - "smithy.api#documentation": "

The current status of the agent runtime endpoint deletion.

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

The current status of the AgentCore Runtime endpoint deletion.

", "smithy.api#required": {} } } @@ -3574,7 +3593,7 @@ "agentRuntimeId": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent runtime to delete.

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

The unique identifier of the AgentCore Runtime to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3588,9 +3607,9 @@ "type": "structure", "members": { "status": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentStatus", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeStatus", "traits": { - "smithy.api#documentation": "

The current status of the agent runtime deletion.

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

The current status of the AgentCore Runtime deletion.

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

Deletes a Gateway.

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

Deletes a gateway.

", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -3891,7 +3910,7 @@ "gatewayIdentifier": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the gateway to delete. This can be either the gateway ID or the gateway ARN.

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

The identifier of the gateway to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3907,21 +3926,21 @@ "gatewayId": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayId", "traits": { - "smithy.api#documentation": "

The unique identifier of the deleted Gateway.

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

The unique identifier of the deleted gateway.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayStatus", "traits": { - "smithy.api#documentation": "

The current status of the Gateway deletion.

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

The current status of the gateway deletion.

", "smithy.api#required": {} } }, "statusReasons": { "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", "traits": { - "smithy.api#documentation": "

The reasons for the current status of the Gateway deletion.

" + "smithy.api#documentation": "

The reasons for the current status of the gateway deletion.

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

Deletes a Gateway Target.

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

Deletes a gateway target.

", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -3973,7 +3992,7 @@ "gatewayIdentifier": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the Gateway associated with the target.

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

The unique identifier of the gateway associated with the target.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3981,7 +4000,7 @@ "targetId": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Gateway Target to delete.

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

The unique identifier of the gateway target to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3997,28 +4016,28 @@ "gatewayArn": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Gateway.

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

The Amazon Resource Name (ARN) of the gateway.

", "smithy.api#required": {} } }, "targetId": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetId", "traits": { - "smithy.api#documentation": "

The unique identifier of the deleted Gateway Target.

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

The unique identifier of the deleted gateway target.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetStatus", "traits": { - "smithy.api#documentation": "

The current status of the Gateway Target deletion.

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

The current status of the gateway target deletion.

", "smithy.api#required": {} } }, "statusReasons": { "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", "traits": { - "smithy.api#documentation": "

The reasons for the current status of the Gateway Target deletion.

" + "smithy.api#documentation": "

The reasons for the current status of the gateway target deletion.

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

Deletes a memory.

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

Deletes an Amazon Bedrock AgentCore Memory resource.

", "smithy.api#http": { "method": "DELETE", "uri": "/memories/{memoryId}/delete" @@ -4093,14 +4112,14 @@ "memoryId": { "target": "com.amazonaws.bedrockagentcorecontrol#MemoryId", "traits": { - "smithy.api#documentation": "

The unique identifier of the deleted memory.

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

The unique identifier of the deleted AgentCore Memory resource.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagentcorecontrol#MemoryStatus", "traits": { - "smithy.api#documentation": "

The current status of the memory deletion.

" + "smithy.api#documentation": "

The current status of the AgentCore Memory resource deletion.

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

Gets an Amazon Secure Agent.

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

Gets an Amazon Bedrock AgentCore Runtime.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -4703,7 +4722,7 @@ "agentRuntimeId": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent runtime associated with the endpoint.

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

The unique identifier of the AgentCore Runtime associated with the endpoint.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4711,7 +4730,7 @@ "endpointName": { "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName", "traits": { - "smithy.api#documentation": "

The name of the agent runtime endpoint to retrieve.

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

The name of the AgentCore Runtime endpoint to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4727,73 +4746,73 @@ "liveVersion": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", "traits": { - "smithy.api#documentation": "

The currently deployed version of the agent runtime on the endpoint.

" + "smithy.api#documentation": "

The currently deployed version of the AgentCore Runtime on the endpoint.

" } }, "targetVersion": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", "traits": { - "smithy.api#documentation": "

The target version of the agent runtime for the endpoint.

" + "smithy.api#documentation": "

The target version of the AgentCore Runtime for the endpoint.

" } }, "agentRuntimeEndpointArn": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent runtime endpoint.

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

The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.

", "smithy.api#required": {} } }, "agentRuntimeArn": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent runtime.

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

The Amazon Resource Name (ARN) of the AgentCore Runtime.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpointDescription", "traits": { - "smithy.api#documentation": "

The description of the agent runtime endpoint.

" + "smithy.api#documentation": "

The description of the AgentCore Runtime endpoint.

" } }, "status": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpointStatus", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointStatus", "traits": { - "smithy.api#documentation": "

The current status of the agent runtime endpoint.

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

The current status of the AgentCore Runtime endpoint.

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the agent runtime endpoint was created.

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

The timestamp when the AgentCore Runtime endpoint was created.

", "smithy.api#required": {} } }, "lastUpdatedAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the agent runtime endpoint was last updated.

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

The timestamp when the AgentCore Runtime endpoint was last updated.

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

The reason for failure if the agent runtime endpoint is in a failed state.

" + "smithy.api#documentation": "

The reason for failure if the AgentCore Runtime endpoint is in a failed state.

" } }, "name": { "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName", "traits": { - "smithy.api#documentation": "

The name of the agent runtime endpoint.

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

The name of the AgentCore Runtime endpoint.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointId", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent runtime endpoint.

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

The unique identifier of the AgentCore Runtime endpoint.

", "smithy.api#required": {} } } @@ -4808,7 +4827,7 @@ "agentRuntimeId": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent runtime to retrieve.

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

The unique identifier of the AgentCore Runtime to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4816,7 +4835,7 @@ "agentRuntimeVersion": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", "traits": { - "smithy.api#documentation": "

The version of the agent runtime to retrieve.

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

The version of the AgentCore Runtime to retrieve.

", "smithy.api#httpQuery": "version" } } @@ -4831,74 +4850,74 @@ "agentRuntimeArn": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent runtime.

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

The Amazon Resource Name (ARN) of the AgentCore Runtime.

", "smithy.api#required": {} } }, "workloadIdentityDetails": { "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails", "traits": { - "smithy.api#documentation": "

The workload identity details for the agent runtime.

" + "smithy.api#documentation": "

The workload identity details for the AgentCore Runtime.

" } }, "agentRuntimeName": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeName", "traits": { - "smithy.api#documentation": "

The name of the agent runtime.

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

The name of the AgentCore Runtime.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentcorecontrol#Description", "traits": { - "smithy.api#documentation": "

The description of the agent runtime.

" + "smithy.api#documentation": "

The description of the AgentCore Runtime.

" } }, "agentRuntimeId": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent runtime.

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

The unique identifier of the AgentCore Runtime.

", "smithy.api#required": {} } }, "agentRuntimeVersion": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", "traits": { - "smithy.api#documentation": "

The version of the agent runtime.

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

The version of the AgentCore Runtime.

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the agent runtime was created.

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

The timestamp when the AgentCore Runtime was created.

", "smithy.api#required": {} } }, "lastUpdatedAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the agent runtime was last updated.

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

The timestamp when the AgentCore Runtime was last updated.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", "traits": { - "smithy.api#documentation": "

The IAM role ARN that provides permissions for the agent runtime.

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

The IAM role ARN that provides permissions for the AgentCore Runtime.

", "smithy.api#required": {} } }, "agentRuntimeArtifact": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentArtifact", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArtifact", "traits": { - "smithy.api#documentation": "

The artifact of the agent runtime.

" + "smithy.api#documentation": "

The artifact of the AgentCore Runtime.

" } }, "networkConfiguration": { "target": "com.amazonaws.bedrockagentcorecontrol#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

The network configuration for the agent runtime.

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

The network configuration for the AgentCore Runtime.

", "smithy.api#required": {} } }, @@ -4908,19 +4927,25 @@ "environmentVariables": { "target": "com.amazonaws.bedrockagentcorecontrol#EnvironmentVariablesMap", "traits": { - "smithy.api#documentation": "

Environment variables set in the agent runtime environment.

" + "smithy.api#documentation": "

Environment variables set in the AgentCore Runtime environment.

" } }, "authorizerConfiguration": { "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", "traits": { - "smithy.api#documentation": "

The authorizer configuration for the agent runtime.

" + "smithy.api#documentation": "

The authorizer configuration for the AgentCore Runtime.

" + } + }, + "requestHeaderConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#RequestHeaderConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for HTTP request headers that will be passed through to the runtime.

" } }, "status": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentStatus", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeStatus", "traits": { - "smithy.api#documentation": "

The current status of the agent runtime.

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

The current status of the AgentCore Runtime.

", "smithy.api#required": {} } } @@ -5132,6 +5157,12 @@ "smithy.api#required": {} } }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The reason for failure if the browser is in a failed state.

" + } + }, "createdAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { @@ -5251,6 +5282,12 @@ "smithy.api#required": {} } }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The reason for failure if the code interpreter is in a failed state.

" + } + }, "createdAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { @@ -5311,7 +5348,7 @@ "gatewayIdentifier": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the gateway to retrieve. This can be either the gateway ID or the gateway ARN.

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

The identifier of the gateway to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5327,73 +5364,73 @@ "gatewayArn": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Gateway.

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

The Amazon Resource Name (ARN) of the gateway.

", "smithy.api#required": {} } }, "gatewayId": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Gateway.

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

The unique identifier of the gateway.

", "smithy.api#required": {} } }, "gatewayUrl": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayUrl", "traits": { - "smithy.api#documentation": "

An endpoint for invoking Gateway.

" + "smithy.api#documentation": "

An endpoint for invoking gateway.

" } }, "createdAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the Gateway was created.

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

The timestamp when the gateway was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the Gateway was last updated.

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

The timestamp when the gateway was last updated.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayStatus", "traits": { - "smithy.api#documentation": "

The current status of the Gateway.

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

The current status of the gateway.

", "smithy.api#required": {} } }, "statusReasons": { "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", "traits": { - "smithy.api#documentation": "

The reasons for the current status of the Gateway.

" + "smithy.api#documentation": "

The reasons for the current status of the gateway.

" } }, "name": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayName", "traits": { - "smithy.api#documentation": "

The name of the Gateway.

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

The name of the gateway.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayDescription", "traits": { - "smithy.api#documentation": "

The description of the Gateway.

" + "smithy.api#documentation": "

The description of the gateway.

" } }, "roleArn": { "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", "traits": { - "smithy.api#documentation": "

The IAM role ARN that provides permissions for the Gateway.

" + "smithy.api#documentation": "

The IAM role ARN that provides permissions for the gateway.

" } }, "protocolType": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolType", "traits": { - "smithy.api#documentation": "

Protocol applied to a Gateway.

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

Protocol applied to a gateway.

", "smithy.api#required": {} } }, @@ -5410,25 +5447,25 @@ "authorizerConfiguration": { "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", "traits": { - "smithy.api#documentation": "

The authorizer configuration for the Gateway.

" + "smithy.api#documentation": "

The authorizer configuration for the gateway.

" } }, "kmsKeyArn": { "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The ARN of the KMS key used to encrypt the Gateway.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the gateway.

" } }, "workloadIdentityDetails": { "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails", "traits": { - "smithy.api#documentation": "

The workload identity details for the Gateway.

" + "smithy.api#documentation": "

The workload identity details for the gateway.

" } }, "exceptionLevel": { "target": "com.amazonaws.bedrockagentcorecontrol#ExceptionLevel", "traits": { - "smithy.api#documentation": "

The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

" + "smithy.api#documentation": "

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

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

Retrieves information about a specific Gateway Target.

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

Retrieves information about a specific gateway target.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -5477,7 +5514,7 @@ "gatewayIdentifier": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the gateway that contains the target. This can be either the gateway ID or the gateway ARN.

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

The identifier of the gateway that contains the target.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5501,55 +5538,55 @@ "gatewayArn": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Gateway.

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

The Amazon Resource Name (ARN) of the gateway.

", "smithy.api#required": {} } }, "targetId": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Gateway Target.

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

The unique identifier of the gateway target.

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the Gateway Target was created.

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

The timestamp when the gateway target was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the Gateway Target was last updated.

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

The timestamp when the gateway target was last updated.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetStatus", "traits": { - "smithy.api#documentation": "

The current status of the Gateway Target.

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

The current status of the gateway target.

", "smithy.api#required": {} } }, "statusReasons": { "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", "traits": { - "smithy.api#documentation": "

The reasons for the current status of the Gateway Target.

" + "smithy.api#documentation": "

The reasons for the current status of the gateway target.

" } }, "name": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetName", "traits": { - "smithy.api#documentation": "

The name of the Gateway Target.

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

The name of the gateway target.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetDescription", "traits": { - "smithy.api#documentation": "

The description of the Gateway Target.

" + "smithy.api#documentation": "

The description of the gateway target.

" } }, "targetConfiguration": { @@ -5561,7 +5598,7 @@ "credentialProviderConfigurations": { "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderConfigurations", "traits": { - "smithy.api#documentation": "

The credential provider configurations for the Gateway Target.

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

The credential provider configurations for the gateway target.

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

Retrieve an existing memory.

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

Retrieve an existing Amazon Bedrock AgentCore Memory resource.

", "smithy.api#http": { "method": "GET", "uri": "/memories/{memoryId}/details" @@ -5662,7 +5699,7 @@ "memory": { "target": "com.amazonaws.bedrockagentcorecontrol#Memory", "traits": { - "smithy.api#documentation": "

The retrieved memory details.

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

The retrieved AgentCore Memory resource details.

", "smithy.api#required": {} } } @@ -6036,6 +6073,16 @@ "smithy.api#documentation": "

Output configuration for a Google OAuth2 provider.

" } }, + "com.amazonaws.bedrockagentcorecontrol#HeaderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(Authorization|X-Amzn-Bedrock-AgentCore-Runtime-Custom-[a-zA-Z0-9_-]+)$" + } + }, "com.amazonaws.bedrockagentcorecontrol#InlinePayload": { "type": "string", "traits": { @@ -6160,7 +6207,7 @@ "agentRuntimeId": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent runtime to list endpoints for.

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

The unique identifier of the AgentCore Runtime to list endpoints for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6188,9 +6235,9 @@ "type": "structure", "members": { "runtimeEndpoints": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpoints", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpoints", "traits": { - "smithy.api#documentation": "

The list of agent runtime endpoints.

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

The list of AgentCore Runtime endpoints.

", "smithy.api#required": {} } }, @@ -6252,7 +6299,7 @@ "agentRuntimeId": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent runtime to list versions for.

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

The unique identifier of the AgentCore Runtime to list versions for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6280,9 +6327,9 @@ "type": "structure", "members": { "agentRuntimes": { - "target": "com.amazonaws.bedrockagentcorecontrol#Agents", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimes", "traits": { - "smithy.api#documentation": "

The list of agent runtime versions.

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

The list of AgentCore Runtime versions.

", "smithy.api#required": {} } }, @@ -6361,9 +6408,9 @@ "type": "structure", "members": { "agentRuntimes": { - "target": "com.amazonaws.bedrockagentcorecontrol#Agents", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimes", "traits": { - "smithy.api#documentation": "

The list of agent runtimes.

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

The list of AgentCore Runtime resources.

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

Lists all targets for a specific Gateway.

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

Lists all targets for a specific gateway.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -6684,7 +6731,7 @@ "gatewayIdentifier": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the gateway to list targets for. This can be either the gateway ID or the gateway ARN.

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

The identifier of the gateway to list targets for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6692,14 +6739,14 @@ "maxResults": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. The default value is 10. The maximum value is 50.

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

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetNextToken", "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", "smithy.api#httpQuery": "nextToken" } } @@ -6714,14 +6761,14 @@ "items": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetSummaries", "traits": { - "smithy.api#documentation": "

The list of Gateway Target summaries.

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

The list of gateway target summaries.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetNextToken", "traits": { - "smithy.api#documentation": "

Opaque continuation token for the next paginated response.

" + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

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

Lists all Gateways in the account.

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

Lists all gateways in the account.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -6773,14 +6820,14 @@ "maxResults": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. The default value is 10. The maximum value is 50.

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

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayNextToken", "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", "smithy.api#httpQuery": "nextToken" } } @@ -6795,14 +6842,14 @@ "items": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewaySummaries", "traits": { - "smithy.api#documentation": "

The list of Gateway summaries.

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

The list of gateway summaries.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayNextToken", "traits": { - "smithy.api#documentation": "

Opaque continuation token for the next paginated response.

" + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

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

Lists the memory present.

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

Lists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.

", "smithy.api#http": { "method": "POST", "uri": "/memories/" @@ -6881,7 +6928,7 @@ "memories": { "target": "com.amazonaws.bedrockagentcorecontrol#MemorySummaryList", "traits": { - "smithy.api#documentation": "

The list of memory summaries.

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

The list of AgentCore Memory resource summaries.

", "smithy.api#required": {} } }, @@ -6940,24 +6987,96 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.bedrockagentcorecontrol#ListOauth2CredentialProvidersRequest": { + "com.amazonaws.bedrockagentcorecontrol#ListOauth2CredentialProvidersRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Pagination token.

" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "

Maximum number of results to return.

", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListOauth2CredentialProvidersResponse": { + "type": "structure", + "members": { + "credentialProviders": { + "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2CredentialProviders", + "traits": { + "smithy.api#documentation": "

The list of OAuth2 credential providers.

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

Pagination token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags associated with the specified resource.

This feature is currently available only for AgentCore Runtime, Browser, Code Interpreter tool, and Gateway.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#ListTagsForResourceRequest": { "type": "structure", "members": { - "nextToken": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Pagination token.

" - } - }, - "maxResults": { - "target": "smithy.api#Integer", + "resourceArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#TaggableResourcesArn", "traits": { - "smithy.api#default": 10, - "smithy.api#documentation": "

Maximum number of results to return.

", - "smithy.api#range": { - "min": 1, - "max": 20 - } + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which you want to list tags.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, @@ -6965,20 +7084,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagentcorecontrol#ListOauth2CredentialProvidersResponse": { + "com.amazonaws.bedrockagentcorecontrol#ListTagsForResourceResponse": { "type": "structure", "members": { - "credentialProviders": { - "target": "com.amazonaws.bedrockagentcorecontrol#Oauth2CredentialProviders", - "traits": { - "smithy.api#documentation": "

The list of OAuth2 credential providers.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "smithy.api#String", + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", "traits": { - "smithy.api#documentation": "

Pagination token for the next page of results.

" + "smithy.api#documentation": "

The tags associated with the resource.

" } } }, @@ -7747,9 +7859,15 @@ "networkMode": { "target": "com.amazonaws.bedrockagentcorecontrol#NetworkMode", "traits": { - "smithy.api#documentation": "

The network mode for the agent runtime.

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

The network mode for the AgentCore Runtime.

", "smithy.api#required": {} } + }, + "networkModeConfig": { + "target": "com.amazonaws.bedrockagentcorecontrol#VpcConfig", + "traits": { + "smithy.api#documentation": "

The network mode configuration for the AgentCore Runtime.

" + } } }, "traits": { @@ -7764,6 +7882,12 @@ "traits": { "smithy.api#enumValue": "PUBLIC" } + }, + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC" + } } } }, @@ -8185,6 +8309,33 @@ "smithy.api#documentation": "

The recording configuration for a browser. This structure defines how browser sessions are recorded.

" } }, + "com.amazonaws.bedrockagentcorecontrol#RequestHeaderAllowlist": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#HeaderName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#RequestHeaderConfiguration": { + "type": "union", + "members": { + "requestHeaderAllowlist": { + "target": "com.amazonaws.bedrockagentcorecontrol#RequestHeaderAllowlist", + "traits": { + "smithy.api#documentation": "

A list of HTTP request headers that are allowed to be passed through to the runtime.

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

Configuration for HTTP request headers that will be passed through to the runtime.

" + } + }, "com.amazonaws.bedrockagentcorecontrol#RequiredProperties": { "type": "list", "member": { @@ -8276,7 +8427,7 @@ "min": 1, "max": 1024 }, - "smithy.api#pattern": "^\\d{12}\\.dkr\\.ecr\\.([a-z0-9-]+)\\.amazonaws\\.com/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)([:@]\\S+)$" + "smithy.api#pattern": "^([0-9]{12})\\.dkr\\.ecr\\.([a-z0-9-]+)\\.amazonaws\\.com/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(?::([^:@]{1,300}))?(?:@(.+))?$" } }, "com.amazonaws.bedrockagentcorecontrol#S3BucketUri": { @@ -8495,6 +8646,24 @@ "smithy.api#pattern": "^arn:(aws|aws-us-gov):secretsmanager:[A-Za-z0-9-]{1,64}:[0-9]{12}:secret:[a-zA-Z0-9-_/+=.@!]+$" } }, + "com.amazonaws.bedrockagentcorecontrol#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^sg-[0-9a-zA-Z]{8,17}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#SecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, "com.amazonaws.bedrockagentcorecontrol#SemanticConsolidationOverride": { "type": "structure", "members": { @@ -8846,6 +9015,24 @@ "smithy.api#documentation": "

Contains configuration information for a memory strategy.

" } }, + "com.amazonaws.bedrockagentcorecontrol#SubnetId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^subnet-[0-9a-zA-Z]{8,17}$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#Subnets": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, "com.amazonaws.bedrockagentcorecontrol#SummaryConsolidationOverride": { "type": "structure", "members": { @@ -8931,6 +9118,130 @@ "smithy.api#documentation": "

Input for summary override consolidation configuration in a memory strategy.

" } }, + "com.amazonaws.bedrockagentcorecontrol#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

This feature is currently available only for AgentCore Runtime, Browser, Code Interpreter tool, and Gateway.

", + "smithy.api#http": { + "code": 204, + "method": "POST", + "uri": "/tags/{resourceArn}" + } + } + }, + "com.amazonaws.bedrockagentcorecontrol#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to tag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagsMap", + "traits": { + "smithy.api#documentation": "

The tags to add to the resource. A tag is a key-value pair.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TaggableResourcesArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "^arn:(?:[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:([a-z-]+/[^/]+)(?:/[a-z-]+/[^/]+)*$" + } + }, + "com.amazonaws.bedrockagentcorecontrol#TagsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagKey" + }, + "value": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.bedrockagentcorecontrol#TargetConfiguration": { "type": "union", "members": { @@ -9197,6 +9508,72 @@ "smithy.api#httpError": 401 } }, + "com.amazonaws.bedrockagentcorecontrol#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentcorecontrol#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentcorecontrol#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentcorecontrol#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentcorecontrol#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the specified resource.

This feature is currently available only for AgentCore Runtime, Browser, Code Interpreter tool, and Gateway.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagentcorecontrol#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to untag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.bedrockagentcorecontrol#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys of the tags to remove from the resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentcorecontrol#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockagentcorecontrol#UpdateAgentRuntime": { "type": "operation", "input": { @@ -9270,7 +9647,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing Amazon Secure AgentEndpoint.

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

Updates an existing Amazon Bedrock AgentCore Runtime endpoint.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -9285,7 +9662,7 @@ "agentRuntimeId": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent runtime associated with the endpoint.

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

The unique identifier of the AgentCore Runtime associated with the endpoint.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9293,7 +9670,7 @@ "endpointName": { "target": "com.amazonaws.bedrockagentcorecontrol#EndpointName", "traits": { - "smithy.api#documentation": "

The name of the agent runtime endpoint to update.

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

The name of the AgentCore Runtime endpoint to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9301,13 +9678,13 @@ "agentRuntimeVersion": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", "traits": { - "smithy.api#documentation": "

The updated version of the agent runtime for the endpoint.

" + "smithy.api#documentation": "

The updated version of the AgentCore Runtime for the endpoint.

" } }, "description": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpointDescription", "traits": { - "smithy.api#documentation": "

The updated description of the agent runtime endpoint.

" + "smithy.api#documentation": "

The updated description of the AgentCore Runtime endpoint.

" } }, "clientToken": { @@ -9328,47 +9705,47 @@ "liveVersion": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", "traits": { - "smithy.api#documentation": "

The currently deployed version of the agent runtime on the endpoint.

" + "smithy.api#documentation": "

The currently deployed version of the AgentCore Runtime on the endpoint.

" } }, "targetVersion": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", "traits": { - "smithy.api#documentation": "

The target version of the agent runtime for the endpoint.

" + "smithy.api#documentation": "

The target version of the AgentCore Runtime for the endpoint.

" } }, "agentRuntimeEndpointArn": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent runtime endpoint.

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

The Amazon Resource Name (ARN) of the AgentCore Runtime endpoint.

", "smithy.api#required": {} } }, "agentRuntimeArn": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent runtime.

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

The Amazon Resource Name (ARN) of the AgentCore Runtime.

", "smithy.api#required": {} } }, "status": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentEndpointStatus", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeEndpointStatus", "traits": { - "smithy.api#documentation": "

The current status of the updated agent runtime endpoint.

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

The current status of the updated AgentCore Runtime endpoint.

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the agent runtime endpoint was created.

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

The timestamp when the AgentCore Runtime endpoint was created.

", "smithy.api#required": {} } }, "lastUpdatedAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the agent runtime endpoint was last updated.

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

The timestamp when the AgentCore Runtime endpoint was last updated.

", "smithy.api#required": {} } } @@ -9383,7 +9760,7 @@ "agentRuntimeId": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent runtime to update.

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

The unique identifier of the AgentCore Runtime to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9391,27 +9768,27 @@ "description": { "target": "com.amazonaws.bedrockagentcorecontrol#Description", "traits": { - "smithy.api#documentation": "

The updated description of the agent runtime.

" + "smithy.api#documentation": "

The updated description of the AgentCore Runtime.

" } }, "agentRuntimeArtifact": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentArtifact", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArtifact", "traits": { - "smithy.api#documentation": "

The updated artifact of the agent runtime.

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

The updated artifact of the AgentCore Runtime.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", "traits": { - "smithy.api#documentation": "

The updated IAM role ARN that provides permissions for the agent runtime.

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

The updated IAM role ARN that provides permissions for the AgentCore Runtime.

", "smithy.api#required": {} } }, "networkConfiguration": { "target": "com.amazonaws.bedrockagentcorecontrol#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

The updated network configuration for the agent runtime.

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

The updated network configuration for the AgentCore Runtime.

", "smithy.api#required": {} } }, @@ -9428,13 +9805,19 @@ "environmentVariables": { "target": "com.amazonaws.bedrockagentcorecontrol#EnvironmentVariablesMap", "traits": { - "smithy.api#documentation": "

Updated environment variables to set in the agent runtime environment.

" + "smithy.api#documentation": "

Updated environment variables to set in the AgentCore Runtime environment.

" } }, "authorizerConfiguration": { "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", "traits": { - "smithy.api#documentation": "

The updated authorizer configuration for the agent runtime.

" + "smithy.api#documentation": "

The updated authorizer configuration for the AgentCore Runtime.

" + } + }, + "requestHeaderConfiguration": { + "target": "com.amazonaws.bedrockagentcorecontrol#RequestHeaderConfiguration", + "traits": { + "smithy.api#documentation": "

The updated configuration for HTTP request headers that will be passed through to the runtime.

" } } }, @@ -9448,48 +9831,48 @@ "agentRuntimeArn": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated agent runtime.

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

The Amazon Resource Name (ARN) of the updated AgentCore Runtime.

", "smithy.api#required": {} } }, "agentRuntimeId": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeId", "traits": { - "smithy.api#documentation": "

The unique identifier of the updated agent runtime.

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

The unique identifier of the updated AgentCore Runtime.

", "smithy.api#required": {} } }, "workloadIdentityDetails": { "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails", "traits": { - "smithy.api#documentation": "

The workload identity details for the updated agent runtime.

" + "smithy.api#documentation": "

The workload identity details for the updated AgentCore Runtime.

" } }, "agentRuntimeVersion": { "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeVersion", "traits": { - "smithy.api#documentation": "

The version of the updated agent runtime.

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

The version of the updated AgentCore Runtime.

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the agent runtime was created.

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

The timestamp when the AgentCore Runtime was created.

", "smithy.api#required": {} } }, "lastUpdatedAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the agent runtime was last updated.

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

The timestamp when the AgentCore Runtime was last updated.

", "smithy.api#required": {} } }, "status": { - "target": "com.amazonaws.bedrockagentcorecontrol#AgentStatus", + "target": "com.amazonaws.bedrockagentcorecontrol#AgentRuntimeStatus", "traits": { - "smithy.api#documentation": "

The current status of the updated agent runtime.

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

The current status of the updated AgentCore Runtime.

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

Updates an existing Gateway.

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

Updates an existing gateway.

", "smithy.api#http": { "code": 202, "method": "PUT", @@ -9661,7 +10044,7 @@ "gatewayIdentifier": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the gateway to update. This can be either the gateway ID or the gateway ARN.

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

The identifier of the gateway to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9669,27 +10052,27 @@ "name": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayName", "traits": { - "smithy.api#documentation": "

The updated name for the Gateway.

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

The name of the gateway. This name must be the same as the one when the gateway was created.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayDescription", "traits": { - "smithy.api#documentation": "

The updated description for the Gateway.

" + "smithy.api#documentation": "

The updated description for the gateway.

" } }, "roleArn": { "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", "traits": { - "smithy.api#documentation": "

The updated IAM role ARN that provides permissions for the Gateway.

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

The updated IAM role ARN that provides permissions for the gateway.

", "smithy.api#required": {} } }, "protocolType": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolType", "traits": { - "smithy.api#documentation": "

The updated protocol type for the Gateway.

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

The updated protocol type for the gateway.

", "smithy.api#required": {} } }, @@ -9699,27 +10082,27 @@ "authorizerType": { "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerType", "traits": { - "smithy.api#documentation": "

The updated authorizer type for the Gateway.

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

The updated authorizer type for the gateway.

", "smithy.api#required": {} } }, "authorizerConfiguration": { "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", "traits": { - "smithy.api#documentation": "

The updated authorizer configuration for the Gateway.

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

The updated authorizer configuration for the gateway.

", "smithy.api#required": {} } }, "kmsKeyArn": { "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The updated ARN of the KMS key used to encrypt the Gateway.

" + "smithy.api#documentation": "

The updated ARN of the KMS key used to encrypt the gateway.

" } }, "exceptionLevel": { "target": "com.amazonaws.bedrockagentcorecontrol#ExceptionLevel", "traits": { - "smithy.api#documentation": "

The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

" + "smithy.api#documentation": "

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

" } } }, @@ -9733,73 +10116,73 @@ "gatewayArn": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated Gateway.

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

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

", "smithy.api#required": {} } }, "gatewayId": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayId", "traits": { - "smithy.api#documentation": "

The unique identifier of the updated Gateway.

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

The unique identifier of the updated gateway.

", "smithy.api#required": {} } }, "gatewayUrl": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayUrl", "traits": { - "smithy.api#documentation": "

An endpoint for invoking the updated Gateway.

" + "smithy.api#documentation": "

An endpoint for invoking the updated gateway.

" } }, "createdAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the Gateway was created.

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

The timestamp when the gateway was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the Gateway was last updated.

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

The timestamp when the gateway was last updated.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayStatus", "traits": { - "smithy.api#documentation": "

The current status of the updated Gateway.

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

The current status of the updated gateway.

", "smithy.api#required": {} } }, "statusReasons": { "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", "traits": { - "smithy.api#documentation": "

The reasons for the current status of the updated Gateway.

" + "smithy.api#documentation": "

The reasons for the current status of the updated gateway.

" } }, "name": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayName", "traits": { - "smithy.api#documentation": "

The updated name of the Gateway.

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

The name of the gateway.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayDescription", "traits": { - "smithy.api#documentation": "

The updated description of the Gateway.

" + "smithy.api#documentation": "

The updated description of the gateway.

" } }, "roleArn": { "target": "com.amazonaws.bedrockagentcorecontrol#RoleArn", "traits": { - "smithy.api#documentation": "

The updated IAM role ARN that provides permissions for the Gateway.

" + "smithy.api#documentation": "

The updated IAM role ARN that provides permissions for the gateway.

" } }, "protocolType": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayProtocolType", "traits": { - "smithy.api#documentation": "

The updated protocol type for the Gateway.

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

The updated protocol type for the gateway.

", "smithy.api#required": {} } }, @@ -9809,32 +10192,32 @@ "authorizerType": { "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerType", "traits": { - "smithy.api#documentation": "

The updated authorizer type for the Gateway.

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

The updated authorizer type for the gateway.

", "smithy.api#required": {} } }, "authorizerConfiguration": { "target": "com.amazonaws.bedrockagentcorecontrol#AuthorizerConfiguration", "traits": { - "smithy.api#documentation": "

The updated authorizer configuration for the Gateway.

" + "smithy.api#documentation": "

The updated authorizer configuration for the gateway.

" } }, "kmsKeyArn": { "target": "com.amazonaws.bedrockagentcorecontrol#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The updated ARN of the KMS key used to encrypt the Gateway.

" + "smithy.api#documentation": "

The updated ARN of the KMS key used to encrypt the gateway.

" } }, "workloadIdentityDetails": { "target": "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentityDetails", "traits": { - "smithy.api#documentation": "

The workload identity details for the updated Gateway.

" + "smithy.api#documentation": "

The workload identity details for the updated gateway.

" } }, "exceptionLevel": { "target": "com.amazonaws.bedrockagentcorecontrol#ExceptionLevel", "traits": { - "smithy.api#documentation": "

The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

" + "smithy.api#documentation": "

The level of detail in error messages returned when invoking the gateway.

  • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

  • If the value is omitted, a generic error message is returned to the end user.

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

Updates an existing Gateway Target.

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

Updates an existing gateway target.

", "smithy.api#http": { "code": 202, "method": "PUT", @@ -9889,7 +10272,7 @@ "gatewayIdentifier": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the Gateway associated with the target.

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

The unique identifier of the gateway associated with the target.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9897,7 +10280,7 @@ "targetId": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Gateway Target to update.

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

The unique identifier of the gateway target to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9905,14 +10288,14 @@ "name": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetName", "traits": { - "smithy.api#documentation": "

The updated name for the Gateway Target.

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

The updated name for the gateway target.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetDescription", "traits": { - "smithy.api#documentation": "

The updated description for the Gateway Target.

" + "smithy.api#documentation": "

The updated description for the gateway target.

" } }, "targetConfiguration": { @@ -9924,7 +10307,7 @@ "credentialProviderConfigurations": { "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderConfigurations", "traits": { - "smithy.api#documentation": "

The updated credential provider configurations for the Gateway Target.

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

The updated credential provider configurations for the gateway target.

", "smithy.api#required": {} } } @@ -9939,55 +10322,55 @@ "gatewayArn": { "target": "com.amazonaws.bedrockagentcorecontrol#GatewayArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Gateway.

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

The Amazon Resource Name (ARN) of the gateway.

", "smithy.api#required": {} } }, "targetId": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetId", "traits": { - "smithy.api#documentation": "

The unique identifier of the updated Gateway Target.

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

The unique identifier of the updated gateway target.

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the Gateway Target was created.

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

The timestamp when the gateway target was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagentcorecontrol#DateTimestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the Gateway Target was last updated.

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

The timestamp when the gateway target was last updated.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetStatus", "traits": { - "smithy.api#documentation": "

The current status of the updated Gateway Target.

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

The current status of the updated gateway target.

", "smithy.api#required": {} } }, "statusReasons": { "target": "com.amazonaws.bedrockagentcorecontrol#StatusReasons", "traits": { - "smithy.api#documentation": "

The reasons for the current status of the updated Gateway Target.

" + "smithy.api#documentation": "

The reasons for the current status of the updated gateway target.

" } }, "name": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetName", "traits": { - "smithy.api#documentation": "

The updated name of the Gateway Target.

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

The updated name of the gateway target.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentcorecontrol#TargetDescription", "traits": { - "smithy.api#documentation": "

The updated description of the Gateway Target.

" + "smithy.api#documentation": "

The updated description of the gateway target.

" } }, "targetConfiguration": { @@ -9999,7 +10382,7 @@ "credentialProviderConfigurations": { "target": "com.amazonaws.bedrockagentcorecontrol#CredentialProviderConfigurations", "traits": { - "smithy.api#documentation": "

The updated credential provider configurations for the Gateway Target.

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

The updated credential provider configurations for the gateway target.

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

Update memory.

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

Update an Amazon Bedrock AgentCore Memory resource memory.

", "smithy.api#http": { "method": "PUT", "uri": "/memories/{memoryId}/update" @@ -10072,7 +10455,7 @@ "description": { "target": "com.amazonaws.bedrockagentcorecontrol#Description", "traits": { - "smithy.api#documentation": "

The updated description of the memory.

" + "smithy.api#documentation": "

The updated description of the AgentCore Memory resource.

" } }, "eventExpiryDuration": { @@ -10088,7 +10471,7 @@ "memoryExecutionRoleArn": { "target": "com.amazonaws.bedrockagentcorecontrol#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that provides permissions for the memory.

" + "smithy.api#documentation": "

The ARN of the IAM role that provides permissions for the AgentCore Memory resource.

" } }, "memoryStrategies": { @@ -10108,7 +10491,7 @@ "memory": { "target": "com.amazonaws.bedrockagentcorecontrol#Memory", "traits": { - "smithy.api#documentation": "

The updated memory details.

" + "smithy.api#documentation": "

The updated AgentCore Memory resource details.

" } } }, @@ -10577,6 +10960,28 @@ } } }, + "com.amazonaws.bedrockagentcorecontrol#VpcConfig": { + "type": "structure", + "members": { + "securityGroups": { + "target": "com.amazonaws.bedrockagentcorecontrol#SecurityGroups", + "traits": { + "smithy.api#documentation": "

The security groups associated with the VPC configuration.

", + "smithy.api#required": {} + } + }, + "subnets": { + "target": "com.amazonaws.bedrockagentcorecontrol#Subnets", + "traits": { + "smithy.api#documentation": "

The subnets associated with the VPC configuration.

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

VpcConfig for the Agent.

" + } + }, "com.amazonaws.bedrockagentcorecontrol#WorkloadIdentity": { "type": "resource", "identifiers": { diff --git a/codegen/sdk/aws-models/bedrock-agentcore.json b/codegen/sdk/aws-models/bedrock-agentcore.json index a20b51180e2..f716791a1f0 100644 --- a/codegen/sdk/aws-models/bedrock-agentcore.json +++ b/codegen/sdk/aws-models/bedrock-agentcore.json @@ -627,17 +627,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -651,17 +640,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -675,17 +653,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -699,17 +666,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/bedrock-data-automation-runtime.json b/codegen/sdk/aws-models/bedrock-data-automation-runtime.json index 7a4b5c5c155..92d0cd2e5fc 100644 --- a/codegen/sdk/aws-models/bedrock-data-automation-runtime.json +++ b/codegen/sdk/aws-models/bedrock-data-automation-runtime.json @@ -554,17 +554,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -578,17 +567,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -602,17 +580,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -626,17 +593,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/bedrock-data-automation.json b/codegen/sdk/aws-models/bedrock-data-automation.json index d3eb753e353..0ae65195946 100644 --- a/codegen/sdk/aws-models/bedrock-data-automation.json +++ b/codegen/sdk/aws-models/bedrock-data-automation.json @@ -560,17 +560,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -584,17 +573,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -608,17 +586,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -632,17 +599,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -729,6 +685,9 @@ }, "types": { "target": "com.amazonaws.bedrockdataautomation#AudioExtractionCategoryTypes" + }, + "typeConfiguration": { + "target": "com.amazonaws.bedrockdataautomation#AudioExtractionCategoryTypeConfiguration" } }, "traits": { @@ -758,6 +717,17 @@ } } }, + "com.amazonaws.bedrockdataautomation#AudioExtractionCategoryTypeConfiguration": { + "type": "structure", + "members": { + "transcript": { + "target": "com.amazonaws.bedrockdataautomation#TranscriptConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Configuration for different audio extraction category types" + } + }, "com.amazonaws.bedrockdataautomation#AudioExtractionCategoryTypes": { "type": "list", "member": { @@ -1114,6 +1084,20 @@ "smithy.api#documentation": "List of Blueprints" } }, + "com.amazonaws.bedrockdataautomation#ChannelLabelingConfiguration": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Channel labeling configuration" + } + }, "com.amazonaws.bedrockdataautomation#ClientToken": { "type": "string", "traits": { @@ -2797,6 +2781,20 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.bedrockdataautomation#SpeakerLabelingConfiguration": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.bedrockdataautomation#State", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Speaker labeling configuration" + } + }, "com.amazonaws.bedrockdataautomation#SplitterConfiguration": { "type": "structure", "members": { @@ -3002,6 +3000,20 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.bedrockdataautomation#TranscriptConfiguration": { + "type": "structure", + "members": { + "speakerLabeling": { + "target": "com.amazonaws.bedrockdataautomation#SpeakerLabelingConfiguration" + }, + "channelLabeling": { + "target": "com.amazonaws.bedrockdataautomation#ChannelLabelingConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Configuration for transcript related features" + } + }, "com.amazonaws.bedrockdataautomation#Type": { "type": "enum", "members": { diff --git a/codegen/sdk/aws-models/bedrock-runtime.json b/codegen/sdk/aws-models/bedrock-runtime.json index 82b48461a18..50361095a4d 100644 --- a/codegen/sdk/aws-models/bedrock-runtime.json +++ b/codegen/sdk/aws-models/bedrock-runtime.json @@ -49,6 +49,9 @@ }, { "target": "com.amazonaws.bedrockruntime#InferenceResource" + }, + { + "target": "com.amazonaws.bedrockruntime#TokenizerResource" } ], "traits": { @@ -585,17 +588,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -609,17 +601,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -633,17 +614,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -657,17 +627,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -771,6 +730,9 @@ { "target": "com.amazonaws.bedrockruntime#ServiceQuotaExceededException" }, + { + "target": "com.amazonaws.bedrockruntime#ServiceUnavailableException" + }, { "target": "com.amazonaws.bedrockruntime#ThrottlingException" }, @@ -2039,6 +2001,26 @@ "smithy.api#documentation": "

The trace object in a response from ConverseStream. Currently, you can only trace guardrails.

" } }, + "com.amazonaws.bedrockruntime#ConverseTokensRequest": { + "type": "structure", + "members": { + "messages": { + "target": "com.amazonaws.bedrockruntime#Messages", + "traits": { + "smithy.api#documentation": "

An array of messages to count tokens for.

" + } + }, + "system": { + "target": "com.amazonaws.bedrockruntime#SystemContentBlocks", + "traits": { + "smithy.api#documentation": "

The system content blocks to count tokens for. System content provides instructions or context to the model about how it should behave or respond. The token count will include any system content provided.

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

The inputs from a Converse API request for token counting.

This structure mirrors the input format for the Converse operation, allowing you to count tokens for conversation-based inference requests.

" + } + }, "com.amazonaws.bedrockruntime#ConverseTrace": { "type": "structure", "members": { @@ -2059,6 +2041,102 @@ "smithy.api#documentation": "

The trace object in a response from Converse. Currently, you can only trace guardrails.

" } }, + "com.amazonaws.bedrockruntime#CountTokens": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockruntime#CountTokensRequest" + }, + "output": { + "target": "com.amazonaws.bedrockruntime#CountTokensResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockruntime#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.bedrockruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the token count for a given inference request. This operation helps you estimate token usage before sending requests to foundation models by returning the token count that would be used if the same input were sent to the model in an inference request.

Token counting is model-specific because different models use different tokenization strategies. The token count returned by this operation will match the token count that would be charged if the same input were sent to the model in an InvokeModel or Converse request.

You can use this operation to:

  • Estimate costs before sending inference requests.

  • Optimize prompts to fit within token limits.

  • Plan for token usage in your applications.

This operation accepts the same input formats as InvokeModel and Converse, allowing you to count tokens for both raw text inputs and structured conversation formats.

The following operations are related to CountTokens:

  • InvokeModel - Sends inference requests to foundation models

  • Converse - Sends conversation-based inference requests to foundation models

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/model/{modelId}/count-tokens" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockruntime#CountTokensInput": { + "type": "union", + "members": { + "invokeModel": { + "target": "com.amazonaws.bedrockruntime#InvokeModelTokensRequest", + "traits": { + "smithy.api#documentation": "

An InvokeModel request for which to count tokens. Use this field when you want to count tokens for a raw text input that would be sent to the InvokeModel operation.

" + } + }, + "converse": { + "target": "com.amazonaws.bedrockruntime#ConverseTokensRequest", + "traits": { + "smithy.api#documentation": "

A Converse request for which to count tokens. Use this field when you want to count tokens for a conversation-based input that would be sent to the Converse operation.

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

The input value for token counting. The value should be either an InvokeModel or Converse request body.

" + } + }, + "com.amazonaws.bedrockruntime#CountTokensRequest": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrockruntime#FoundationModelVersionIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier or ARN of the foundation model to use for token counting. Each model processes tokens differently, so the token count is specific to the model you specify.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "input": { + "target": "com.amazonaws.bedrockruntime#CountTokensInput", + "traits": { + "smithy.api#documentation": "

The input for which to count tokens. The structure of this parameter depends on whether you're counting tokens for an InvokeModel or Converse request:

  • For InvokeModel requests, provide the request body in the invokeModel field

  • For Converse requests, provide the messages and system content in the converse field

The input format must be compatible with the model specified in the modelId parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockruntime#CountTokensResponse": { + "type": "structure", + "members": { + "inputTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of tokens in the provided input according to the specified model's tokenization rules. This count represents the number of input tokens that would be processed if the same input were sent to the model in an inference request. Use this value to estimate costs and ensure your inputs stay within model token limits.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockruntime#DocumentBlock": { "type": "structure", "members": { @@ -2324,6 +2402,17 @@ "smithy.api#documentation": "

Contains the content of a document.

" } }, + "com.amazonaws.bedrockruntime#FoundationModelVersionIdentifier": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN or ID of a Bedrock model", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z_\\.\\-/0-9:]+$" + } + }, "com.amazonaws.bedrockruntime#GetAsyncInvoke": { "type": "operation", "input": { @@ -2545,25 +2634,46 @@ "type": "union", "members": { "valid": { - "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningValidFinding" + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningValidFinding", + "traits": { + "smithy.api#documentation": "

Contains the result when the automated reasoning evaluation determines that the claims in the input are logically valid and definitively true based on the provided premises and policy rules.

" + } }, "invalid": { - "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningInvalidFinding" + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningInvalidFinding", + "traits": { + "smithy.api#documentation": "

Contains the result when the automated reasoning evaluation determines that the claims in the input are logically invalid and contradict the established premises or policy rules.

" + } }, "satisfiable": { - "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningSatisfiableFinding" + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningSatisfiableFinding", + "traits": { + "smithy.api#documentation": "

Contains the result when the automated reasoning evaluation determines that the claims in the input could be either true or false depending on additional assumptions not provided in the input context.

" + } }, "impossible": { - "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningImpossibleFinding" + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningImpossibleFinding", + "traits": { + "smithy.api#documentation": "

Contains the result when the automated reasoning evaluation determines that no valid logical conclusions can be drawn due to contradictions in the premises or policy rules themselves.

" + } }, "translationAmbiguous": { - "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslationAmbiguousFinding" + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslationAmbiguousFinding", + "traits": { + "smithy.api#documentation": "

Contains the result when the automated reasoning evaluation detects that the input has multiple valid logical interpretations, requiring additional context or clarification to proceed with validation.

" + } }, "tooComplex": { - "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTooComplexFinding" + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTooComplexFinding", + "traits": { + "smithy.api#documentation": "

Contains the result when the automated reasoning evaluation cannot process the input due to its complexity or volume exceeding the system's processing capacity for logical analysis.

" + } }, "noTranslations": { - "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningNoTranslationsFinding" + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningNoTranslationsFinding", + "traits": { + "smithy.api#documentation": "

Contains the result when the automated reasoning evaluation cannot extract any relevant logical information from the input that can be validated against the policy rules.

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

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

", "smithy.api#length": { - "max": 4 + "max": 2500 } } } @@ -4775,6 +4885,21 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrockruntime#InvokeModelTokensRequest": { + "type": "structure", + "members": { + "body": { + "target": "com.amazonaws.bedrockruntime#Body", + "traits": { + "smithy.api#documentation": "

The request body to count tokens for, formatted according to the model's expected input format. To learn about the input format for different models, see Model inference parameters and responses.

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

The body of an InvokeModel API request for token counting. This structure mirrors the input format for the InvokeModel operation, allowing you to count tokens for raw text inference requests.

" + } + }, "com.amazonaws.bedrockruntime#InvokeModelWithBidirectionalStream": { "type": "operation", "input": { @@ -5926,6 +6051,12 @@ "traits": { "smithy.api#enumValue": "content_filtered" } + }, + "MODEL_CONTEXT_WINDOW_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "model_context_window_exceeded" + } } } }, @@ -6096,6 +6227,14 @@ "smithy.api#documentation": "

The tokens used in a message API inference call.

" } }, + "com.amazonaws.bedrockruntime#TokenizerResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockruntime#CountTokens" + } + ] + }, "com.amazonaws.bedrockruntime#Tool": { "type": "union", "members": { diff --git a/codegen/sdk/aws-models/bedrock.json b/codegen/sdk/aws-models/bedrock.json index 2d196839099..485fffced53 100644 --- a/codegen/sdk/aws-models/bedrock.json +++ b/codegen/sdk/aws-models/bedrock.json @@ -700,17 +700,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -724,17 +713,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -748,17 +726,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -772,17 +739,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1547,6 +1503,7 @@ "rule": { "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRule", "traits": { + "smithy.api#documentation": "

The rule definition that specifies the formal logical expression and metadata for the new rule being added to the policy.

", "smithy.api#required": {} } } @@ -1590,6 +1547,7 @@ "type": { "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionType", "traits": { + "smithy.api#documentation": "

The type definition that specifies the name, description, and possible values for the new custom type being added to the policy.

", "smithy.api#required": {} } } @@ -1654,6 +1612,7 @@ "variable": { "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariable", "traits": { + "smithy.api#documentation": "

The variable definition that specifies the name, type, and description for the new variable being added to the policy.

", "smithy.api#required": {} } } @@ -1823,6 +1782,16 @@ "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn" } }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000000 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentContentType": { "type": "enum", "members": { @@ -1958,7 +1927,10 @@ "type": "union", "members": { "policyDefinition": { - "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition" + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition", + "traits": { + "smithy.api#documentation": "

The complete policy definition generated by the build workflow, containing all rules, variables, and custom types extracted from the source documents.

" + } }, "qualityReport": { "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionQualityReport", @@ -2063,13 +2035,9 @@ "type": "structure", "members": { "document": { - "target": "smithy.api#Blob", + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentBlob", "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": {} } }, @@ -2138,7 +2106,10 @@ "type": "structure", "members": { "policyDefinition": { - "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition" + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition", + "traits": { + "smithy.api#documentation": "

An existing policy definition that serves as the starting point for the build workflow, typically used in policy repair or update scenarios.

" + } }, "workflowContent": { "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyWorkflowTypeContent", @@ -2343,13 +2314,22 @@ "type": "union", "members": { "policyDefinitionVariable": { - "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariable" + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariable", + "traits": { + "smithy.api#documentation": "

A variable element within the policy definition that represents a concept used in logical expressions and rules.

" + } }, "policyDefinitionType": { - "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionType" + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionType", + "traits": { + "smithy.api#documentation": "

A custom type element within the policy definition that defines a set of possible values for variables.

" + } }, "policyDefinitionRule": { - "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRule" + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRule", + "traits": { + "smithy.api#documentation": "

A rule element within the policy definition that contains a formal logical expression used for validation.

" + } } }, "traits": { @@ -3336,6 +3316,7 @@ "testCase": { "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCase", "traits": { + "smithy.api#documentation": "

The test case that was executed, including the input content, expected results, and configuration parameters used during validation.

", "smithy.api#required": {} } }, @@ -3549,6 +3530,7 @@ "rule": { "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRule", "traits": { + "smithy.api#documentation": "

The updated rule definition containing the modified formal logical expression and any changed metadata for the existing rule.

", "smithy.api#required": {} } } @@ -3597,6 +3579,7 @@ "type": { "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionType", "traits": { + "smithy.api#documentation": "

The updated type definition containing the modified name, description, or values for the existing custom type.

", "smithy.api#required": {} } } @@ -3665,6 +3648,7 @@ "variable": { "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariable", "traits": { + "smithy.api#documentation": "

The updated variable definition containing the modified name, type, or description for the existing variable.

", "smithy.api#required": {} } } @@ -4434,6 +4418,9 @@ { "target": "com.amazonaws.bedrock#ThrottlingException" }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, { "target": "com.amazonaws.bedrock#ValidationException" } @@ -6250,7 +6237,7 @@ "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}$" + "smithy.api#pattern": "^arn:aws(|-us-gov|-cn|-iso|-iso-b):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": { @@ -6625,6 +6612,9 @@ { "target": "com.amazonaws.bedrock#InternalServerException" }, + { + "target": "com.amazonaws.bedrock#ResourceInUseException" + }, { "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, @@ -10121,11 +10111,21 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrock#GetFoundationModelIdentifier": { + "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})|([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#GetFoundationModelRequest": { "type": "structure", "members": { "modelIdentifier": { - "target": "com.amazonaws.bedrock#ModelIdentifier", + "target": "com.amazonaws.bedrock#GetFoundationModelIdentifier", "traits": { "smithy.api#documentation": "

The model identifier.

", "smithy.api#httpLabel": {}, @@ -13821,7 +13821,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + "smithy.api#pattern": "^[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?$" } }, "com.amazonaws.bedrock#Identifier": { @@ -19027,7 +19027,6 @@ "com.amazonaws.bedrock#RoleArn": { "type": "string", "traits": { - "smithy.api#documentation": "ARN of a IAM role", "smithy.api#length": { "max": 2048 }, @@ -20550,12 +20549,6 @@ "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": { diff --git a/codegen/sdk/aws-models/billing.json b/codegen/sdk/aws-models/billing.json index 4e4f50ad2c8..9deca37e7b0 100644 --- a/codegen/sdk/aws-models/billing.json +++ b/codegen/sdk/aws-models/billing.json @@ -5,12 +5,18 @@ "type": "service", "version": "2023-09-07", "operations": [ + { + "target": "com.amazonaws.billing#AssociateSourceViews" + }, { "target": "com.amazonaws.billing#CreateBillingView" }, { "target": "com.amazonaws.billing#DeleteBillingView" }, + { + "target": "com.amazonaws.billing#DisassociateSourceViews" + }, { "target": "com.amazonaws.billing#GetBillingView" }, @@ -46,16 +52,36 @@ "aws.auth#sigv4": { "name": "billing" }, - "aws.endpoints#dualStackOnlyEndpoints": {}, "aws.endpoints#standardPartitionalEndpoints": { - "endpointPatternType": "service_region_dnsSuffix" + "endpointPatternType": "service_region_dnsSuffix", + "partitionEndpointSpecialCases": { + "aws": [ + { + "endpoint": "https://billing.us-east-1.api.aws", + "region": "us-east-1", + "dualStack": true + }, + { + "endpoint": "https://billing.us-east-1.api.aws", + "region": "us-east-1", + "dualStack": false + } + ] + } }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "

\n You can use the Billing API to programatically list the billing views available to you for a given time period. A billing view represents a set of billing data.\n

\n

The Billing API provides the following endpoint:

\n

\n https://billing.us-east-1.api.aws\n

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

You can use the Billing API to programatically list the billing views available to you for a given time period. A billing view represents a set of billing data.

The Billing API provides the following endpoint:

https://billing.us-east-1.api.aws

", "smithy.api#title": "AWS Billing", "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { + "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, @@ -106,14 +132,35 @@ }, { "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" } ], "type": "tree" @@ -148,23 +195,47 @@ "rules": [ { "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, true ] } ], "endpoint": { - "url": "https://billing-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", + "url": "https://billing.us-east-1.api.aws", "properties": { "authSchemes": [ { "name": "sigv4", - "signingRegion": "{PartitionResult#implicitGlobalRegion}" + "signingRegion": "us-east-1" } ] }, @@ -172,10 +243,279 @@ }, "type": "endpoint" }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://billing.us-east-1.api.aws", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://billing-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://billing-fips.{PartitionResult#implicitGlobalRegion}.{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://billing.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, { "conditions": [], "endpoint": { - "url": "https://billing.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", + "url": "https://billing.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { @@ -228,6 +568,17 @@ "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": true + } + }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { @@ -245,7 +596,29 @@ }, "params": { "Region": "us-east-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://billing-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { @@ -265,7 +638,29 @@ }, "params": { "Region": "us-east-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://billing.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -285,7 +680,29 @@ }, "params": { "Region": "cn-northwest-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1" + } + ] + }, + "url": "https://billing-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true, + "UseDualStack": false } }, { @@ -305,7 +722,29 @@ }, "params": { "Region": "cn-northwest-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1" + } + ] + }, + "url": "https://billing.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -325,7 +764,29 @@ }, "params": { "Region": "us-gov-west-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://billing-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false } }, { @@ -345,11 +806,33 @@ }, "params": { "Region": "us-gov-west-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://billing.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -365,11 +848,12 @@ }, "params": { "Region": "us-iso-east-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -385,11 +869,12 @@ }, "params": { "Region": "us-iso-east-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -405,11 +890,12 @@ }, "params": { "Region": "us-isob-east-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -425,11 +911,12 @@ }, "params": { "Region": "us-isob-east-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack enabled", + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -445,11 +932,12 @@ }, "params": { "Region": "eu-isoe-west-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -465,11 +953,12 @@ }, "params": { "Region": "eu-isoe-west-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -485,11 +974,12 @@ }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -505,7 +995,50 @@ }, "params": { "Region": "us-isof-south-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eusc-de-east-1" + } + ] + }, + "url": "https://billing-fips.eusc-de-east-1.amazonaws.eu" + } + }, + "params": { + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eusc-de-east-1" + } + ] + }, + "url": "https://billing.eusc-de-east-1.amazonaws.eu" + } + }, + "params": { + "Region": "eusc-de-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -519,58 +1052,149 @@ } } }, - "com.amazonaws.billing#AccessDeniedException": { + "com.amazonaws.billing#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.billing#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BillingAccessDenied", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

You don't have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.billing#AccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.billing#ActiveTimeRange": { + "type": "structure", + "members": { + "activeAfterInclusive": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The inclusive time range start date.

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

The inclusive time range end date.

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

A time range with a start and end time.

" + } + }, + "com.amazonaws.billing#AssociateSourceViews": { + "type": "operation", + "input": { + "target": "com.amazonaws.billing#AssociateSourceViewsRequest" + }, + "output": { + "target": "com.amazonaws.billing#AssociateSourceViewsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.billing#AccessDeniedException" + }, + { + "target": "com.amazonaws.billing#BillingViewHealthStatusException" + }, + { + "target": "com.amazonaws.billing#ConflictException" + }, + { + "target": "com.amazonaws.billing#InternalServerException" + }, + { + "target": "com.amazonaws.billing#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billing#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.billing#ThrottlingException" + }, + { + "target": "com.amazonaws.billing#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates one or more source billing views with an existing billing view. This allows creating aggregate billing views that combine data from multiple sources.

", + "smithy.api#examples": [ + { + "title": "Invoke AssociateSourceViews", + "input": { + "arn": "arn:aws:billing::123456789012:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899", + "sourceViews": [ + "arn:aws:billing::123456789012:billingview/primary", + "arn:aws:billing::123456789012:billingview/custom-d3f9c7e4-8b2f-4a6e-9d3b-2f7c8a1e5f6d" + ] + }, + "output": { + "arn": "arn:aws:billing::123456789012:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899" + } + } + ], + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billing#AssociateSourceViewsRequest": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.billing#ErrorMessage", + "arn": { + "target": "com.amazonaws.billing#BillingViewArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the billing view to associate source views with.

", + "smithy.api#required": {} + } + }, + "sourceViews": { + "target": "com.amazonaws.billing#BillingViewSourceViewsList", "traits": { + "smithy.api#documentation": "

A list of ARNs of the source billing views to associate.

", "smithy.api#required": {} } } }, "traits": { - "aws.protocols#awsQueryError": { - "code": "BillingAccessDenied", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

You don't have sufficient access to perform this action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.billing#AccountId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9]{12}$" + "smithy.api#input": {} } }, - "com.amazonaws.billing#ActiveTimeRange": { + "com.amazonaws.billing#AssociateSourceViewsResponse": { "type": "structure", "members": { - "activeAfterInclusive": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The inclusive time range start date.

", - "smithy.api#required": {} - } - }, - "activeBeforeInclusive": { - "target": "smithy.api#Timestamp", + "arn": { + "target": "com.amazonaws.billing#BillingViewArn", "traits": { - "smithy.api#documentation": "

\n The inclusive time range end date.\n

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

The ARN of the billing view that the source views were associated with.

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

A time range with a start and end time.

" + "smithy.api#output": {} } }, "com.amazonaws.billing#BillingViewArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws[a-z-]*:(billing)::[0-9]{12}:billingview/[a-zA-Z0-9/:_\\+=\\.\\-@]{0,59}[a-zA-Z0-9]$" + "smithy.api#pattern": "^arn:aws[a-z-]*:(billing)::[0-9]{12}:billingview/[a-zA-Z0-9/:_\\+=\\.\\-@]{0,75}[a-zA-Z0-9]$" } }, "com.amazonaws.billing#BillingViewArnList": { @@ -602,54 +1226,120 @@ "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

" } }, "name": { "target": "com.amazonaws.billing#BillingViewName", "traits": { - "smithy.api#documentation": "

\n A list of names of the billing view.\n

" + "smithy.api#documentation": "

The account name of the billing view.

" } }, "description": { "target": "com.amazonaws.billing#BillingViewDescription", "traits": { - "smithy.api#documentation": "

\n The description of the billing view.\n

" + "smithy.api#documentation": "

The description of the billing view.

" } }, "billingViewType": { "target": "com.amazonaws.billing#BillingViewType", "traits": { - "smithy.api#documentation": "

The type of billing group.\n

" + "smithy.api#documentation": "

The type of billing group.

" } }, "ownerAccountId": { "target": "com.amazonaws.billing#AccountId", "traits": { - "smithy.api#documentation": "

\n The list of owners of the billing view.\n

" + "smithy.api#documentation": "

The account owner of the billing view.

" + } + }, + "sourceAccountId": { + "target": "com.amazonaws.billing#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the source billing view, if this is a derived billing view.

" } }, "dataFilterExpression": { "target": "com.amazonaws.billing#Expression", "traits": { - "smithy.api#documentation": "

\n See Expression. Billing view only supports LINKED_ACCOUNT and Tags.\n

" + "smithy.api#documentation": "

See Expression. Billing view only supports LINKED_ACCOUNT and Tags.

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

The time when the billing view was created.\n

" + "smithy.api#documentation": "

The time when the billing view was created.

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

The time when the billing view was last updated.\n

" + "smithy.api#documentation": "

The time when the billing view was last updated.

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

The number of billing views that use this billing view as a source.

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

The number of source views associated with this billing view.

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

The timestamp of when the billing view definition was last updated.

" + } + }, + "healthStatus": { + "target": "com.amazonaws.billing#BillingViewHealthStatus", + "traits": { + "smithy.api#documentation": "

The current health status of the billing view.

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

The metadata associated to the billing view.

" + } + }, + "com.amazonaws.billing#BillingViewHealthStatus": { + "type": "structure", + "members": { + "statusCode": { + "target": "com.amazonaws.billing#BillingViewStatus", + "traits": { + "smithy.api#documentation": "

The current health status code of the billing view.

" + } + }, + "statusReasons": { + "target": "com.amazonaws.billing#BillingViewStatusReasons", + "traits": { + "smithy.api#documentation": "

A list of reasons explaining the current health status, if applicable.

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

Represents the health status of a billing view, including a status code and optional reasons for the status.

" + } + }, + "com.amazonaws.billing#BillingViewHealthStatusException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.billing#ErrorMessage", + "traits": { + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The metadata associated to the billing view.\n

" + "smithy.api#documentation": "

Exception thrown when a billing view's health status prevents an operation from being performed. This may occur if the billing view is in a state other than HEALTHY.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 } }, "com.amazonaws.billing#BillingViewList": { @@ -664,25 +1354,31 @@ "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

" } }, "name": { "target": "com.amazonaws.billing#BillingViewName", "traits": { - "smithy.api#documentation": "

\n A list of names of the Billing view.\n

" + "smithy.api#documentation": "

A list of names of the Billing view.

" } }, "description": { "target": "com.amazonaws.billing#BillingViewDescription", "traits": { - "smithy.api#documentation": "

\n The description of the billing view.\n

" + "smithy.api#documentation": "

The description of the billing view.

" } }, "ownerAccountId": { "target": "com.amazonaws.billing#AccountId", "traits": { - "smithy.api#documentation": "

\n The list of owners of the Billing view.\n

" + "smithy.api#documentation": "

The list of owners of the Billing view.

" + } + }, + "sourceAccountId": { + "target": "com.amazonaws.billing#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the source billing view, if this is a derived billing view.

" } }, "billingViewType": { @@ -690,6 +1386,12 @@ "traits": { "smithy.api#documentation": "

The type of billing view.

" } + }, + "healthStatus": { + "target": "com.amazonaws.billing#BillingViewHealthStatus", + "traits": { + "smithy.api#documentation": "

The current health status of the billing view.

" + } } }, "traits": { @@ -715,10 +1417,98 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 1 + "max": 10 + } + } + }, + "com.amazonaws.billing#BillingViewStatus": { + "type": "enum", + "members": { + "HEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTHY" + } + }, + "UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNHEALTHY" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.billing#BillingViewStatusReason": { + "type": "enum", + "members": { + "SOURCE_VIEW_UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_VIEW_UNHEALTHY" + } + }, + "SOURCE_VIEW_UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_VIEW_UPDATING" + } + }, + "SOURCE_VIEW_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_VIEW_ACCESS_DENIED" + } + }, + "SOURCE_VIEW_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_VIEW_NOT_FOUND" + } + }, + "CYCLIC_DEPENDENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CYCLIC_DEPENDENCY" + } + }, + "SOURCE_VIEW_DEPTH_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_VIEW_DEPTH_EXCEEDED" + } + }, + "AGGREGATE_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGGREGATE_SOURCE" + } + }, + "VIEW_OWNER_NOT_MANAGEMENT_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIEW_OWNER_NOT_MANAGEMENT_ACCOUNT" + } } } }, + "com.amazonaws.billing#BillingViewStatusReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.billing#BillingViewStatusReason" + } + }, "com.amazonaws.billing#BillingViewType": { "type": "enum", "members": { @@ -775,14 +1565,14 @@ "resourceId": { "target": "com.amazonaws.billing#ResourceId", "traits": { - "smithy.api#documentation": "

\n The identifier for the service resource associated with the request.\n

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

The identifier for the service resource associated with the request.

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

\n The type of resource associated with the request.\n

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

The type of resource associated with the request.

", "smithy.api#required": {} } } @@ -792,7 +1582,7 @@ "code": "BillingConflict", "httpResponseCode": 409 }, - "smithy.api#documentation": "

\n The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.\n

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

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -809,12 +1599,18 @@ { "target": "com.amazonaws.billing#AccessDeniedException" }, + { + "target": "com.amazonaws.billing#BillingViewHealthStatusException" + }, { "target": "com.amazonaws.billing#ConflictException" }, { "target": "com.amazonaws.billing#InternalServerException" }, + { + "target": "com.amazonaws.billing#ResourceNotFoundException" + }, { "target": "com.amazonaws.billing#ServiceQuotaExceededException" }, @@ -826,7 +1622,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nCreates a billing view with the specified billing view attributes.\n

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

Creates a billing view with the specified billing view attributes.

", "smithy.api#examples": [ { "title": "Invoke CreateBillingView", @@ -860,14 +1656,14 @@ "name": { "target": "com.amazonaws.billing#BillingViewName", "traits": { - "smithy.api#documentation": "

\n The name of the billing view.\n

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

The name of the billing view.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.billing#BillingViewDescription", "traits": { - "smithy.api#documentation": "

\n The description of the billing view.\n

" + "smithy.api#documentation": "

The description of the billing view.

" } }, "sourceViews": { @@ -880,13 +1676,13 @@ "dataFilterExpression": { "target": "com.amazonaws.billing#Expression", "traits": { - "smithy.api#documentation": "

\n See Expression. Billing view only supports LINKED_ACCOUNT and Tags.\n

" + "smithy.api#documentation": "

See Expression. Billing view only supports LINKED_ACCOUNT and Tags.

" } }, "clientToken": { "target": "com.amazonaws.billing#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. If the original request completes successfully, any subsequent retries complete successfully without performing any further actions with an idempotent request.\n

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

A unique, case-sensitive identifier you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. If the original request completes successfully, any subsequent retries complete successfully without performing any further actions with an idempotent request.

", "smithy.api#httpHeader": "X-Amzn-Client-Token", "smithy.api#idempotencyToken": {} } @@ -894,7 +1690,7 @@ "resourceTags": { "target": "com.amazonaws.billing#ResourceTagList", "traits": { - "smithy.api#documentation": "

A list of key value map specifying tags associated to the billing view being created.\n

" + "smithy.api#documentation": "

A list of key value map specifying tags associated to the billing view being created.

" } } }, @@ -908,14 +1704,14 @@ "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.\n

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

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

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

\n The time when the billing view was created.\n

" + "smithy.api#documentation": "

The time when the billing view was created.

" } } }, @@ -970,9 +1766,16 @@ "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.\n

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

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

", "smithy.api#required": {} } + }, + "force": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If set to true, forces deletion of the billing view even if it has derived resources (e.g. other billing views or budgets). Use with caution as this may break dependent resources.

" + } } }, "traits": { @@ -985,7 +1788,7 @@ "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.\n

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

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

", "smithy.api#required": {} } } @@ -1011,20 +1814,108 @@ "key": { "target": "com.amazonaws.billing#Dimension", "traits": { - "smithy.api#documentation": "

\n The names of the metadata types that you can use to filter and group your results. \n

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

The names of the metadata types that you can use to filter and group your results.

", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.billing#Values", "traits": { - "smithy.api#documentation": "

\n The metadata values that you can use to filter and group your results. \n

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

The metadata values that you can use to filter and group your results.

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

The metadata that you can use to filter and group your results.

" + } + }, + "com.amazonaws.billing#DisassociateSourceViews": { + "type": "operation", + "input": { + "target": "com.amazonaws.billing#DisassociateSourceViewsRequest" + }, + "output": { + "target": "com.amazonaws.billing#DisassociateSourceViewsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.billing#AccessDeniedException" + }, + { + "target": "com.amazonaws.billing#BillingViewHealthStatusException" + }, + { + "target": "com.amazonaws.billing#ConflictException" + }, + { + "target": "com.amazonaws.billing#InternalServerException" + }, + { + "target": "com.amazonaws.billing#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.billing#ThrottlingException" + }, + { + "target": "com.amazonaws.billing#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the association between one or more source billing views and an existing billing view. This allows modifying the composition of aggregate billing views.

", + "smithy.api#examples": [ + { + "title": "Invoke DisassociateSourceViews", + "input": { + "arn": "arn:aws:billing::123456789012:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899", + "sourceViews": [ + "arn:aws:billing::123456789012:billingview/primary", + "arn:aws:billing::123456789012:billingview/custom-d3f9c7e4-8b2f-4a6e-9d3b-2f7c8a1e5f6d" + ] + }, + "output": { + "arn": "arn:aws:billing::123456789012:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899" + } + } + ], + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.billing#DisassociateSourceViewsRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.billing#BillingViewArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the billing view to disassociate source views from.

", + "smithy.api#required": {} + } + }, + "sourceViews": { + "target": "com.amazonaws.billing#BillingViewSourceViewsList", + "traits": { + "smithy.api#documentation": "

A list of ARNs of the source billing views to disassociate.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.billing#DisassociateSourceViewsResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.billing#BillingViewArn", + "traits": { + "smithy.api#documentation": "

The ARN of the billing view that the source views were disassociated from.

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

\n The metadata that you can use to filter and group your results.\n

" + "smithy.api#output": {} } }, "com.amazonaws.billing#ErrorMessage": { @@ -1041,18 +1932,24 @@ "dimensions": { "target": "com.amazonaws.billing#DimensionValues", "traits": { - "smithy.api#documentation": "

\n The specific Dimension to use for Expression.\n

" + "smithy.api#documentation": "

The specific Dimension to use for Expression.

" } }, "tags": { "target": "com.amazonaws.billing#TagValues", "traits": { - "smithy.api#documentation": "

\n The specific Tag to use for Expression.\n

" + "smithy.api#documentation": "

The specific Tag to use for Expression.

" + } + }, + "timeRange": { + "target": "com.amazonaws.billing#TimeRange", + "traits": { + "smithy.api#documentation": "

Specifies a time range filter for the billing view data.

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

\n See Expression. Billing view only supports LINKED_ACCOUNT and Tags.\n

" + "smithy.api#documentation": "

See Expression. Billing view only supports LINKED_ACCOUNT and Tags.

" } }, "com.amazonaws.billing#FieldName": { @@ -1089,7 +1986,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the metadata associated to the specified billing view ARN.\n

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

Returns the metadata associated to the specified billing view ARN.

", "smithy.api#examples": [ { "title": "Invoke GetBillingView", @@ -1124,7 +2021,7 @@ "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.\n

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

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

", "smithy.api#required": {} } } @@ -1139,7 +2036,7 @@ "billingView": { "target": "com.amazonaws.billing#BillingViewElement", "traits": { - "smithy.api#documentation": "

The billing view element associated with the specified ARN.\n

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

The billing view element associated with the specified ARN.

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

Returns the resource-based policy document attached to the resource in JSON format.\n

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

Returns the resource-based policy document attached to the resource in JSON format.

", "smithy.api#examples": [ { "title": "Invoke GetResourcePolicy", @@ -1196,7 +2093,7 @@ "resourceArn": { "target": "com.amazonaws.billing#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.\n

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

The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.

", "smithy.api#required": {} } } @@ -1211,14 +2108,14 @@ "resourceArn": { "target": "com.amazonaws.billing#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.\n

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

The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.

", "smithy.api#required": {} } }, "policy": { "target": "com.amazonaws.billing#PolicyDocument", "traits": { - "smithy.api#documentation": "

The resource-based policy document attached to the resource in JSON format.\n

" + "smithy.api#documentation": "

The resource-based policy document attached to the resource in JSON format.

" } } }, @@ -1241,7 +2138,7 @@ "code": "BillingInternalServer", "httpResponseCode": 500 }, - "smithy.api#documentation": "

The request processing failed because of an unknown error, exception, or failure.\n

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

The request processing failed because of an unknown error, exception, or failure.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1269,7 +2166,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the billing views available for a given time period.\n

\n

Every Amazon Web Services account has a unique PRIMARY billing view that represents the billing data available by default. Accounts that use Billing Conductor also have BILLING_GROUP billing views representing pro forma costs associated with each created billing group.

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

Lists the billing views available for a given time period.

Every Amazon Web Services account has a unique PRIMARY billing view that represents the billing data available by default. Accounts that use Billing Conductor also have BILLING_GROUP billing views representing pro forma costs associated with each created billing group.

", "smithy.api#examples": [ { "title": "Invoke ListBillingViews", @@ -1346,13 +2243,13 @@ "activeTimeRange": { "target": "com.amazonaws.billing#ActiveTimeRange", "traits": { - "smithy.api#documentation": "

\n The time range for the billing views listed. PRIMARY billing view is always listed. BILLING_GROUP billing views are listed for time ranges when the associated billing group resource in Billing Conductor is active. The time range must be within one calendar month.\n

" + "smithy.api#documentation": "

The time range for the billing views listed. PRIMARY billing view is always listed. BILLING_GROUP billing views are listed for time ranges when the associated billing group resource in Billing Conductor is active. The time range must be within one calendar month.

" } }, "arns": { "target": "com.amazonaws.billing#BillingViewArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

" } }, "billingViewTypes": { @@ -1364,13 +2261,19 @@ "ownerAccountId": { "target": "com.amazonaws.billing#AccountId", "traits": { - "smithy.api#documentation": "

\n The list of owners of the billing view.\n

" + "smithy.api#documentation": "

The list of owners of the billing view.

" + } + }, + "sourceAccountId": { + "target": "com.amazonaws.billing#AccountId", + "traits": { + "smithy.api#documentation": "

Filters the results to include only billing views that use the specified account as a source.

" } }, "maxResults": { "target": "com.amazonaws.billing#BillingViewsMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of billing views to retrieve. Default is 100.\n

" + "smithy.api#documentation": "

The maximum number of billing views to retrieve. Default is 100.

" } }, "nextToken": { @@ -1397,7 +2300,7 @@ "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { - "smithy.api#documentation": "

The pagination token to use on subsequent calls to list billing views.\n

" + "smithy.api#documentation": "

The pagination token to use on subsequent calls to list billing views.

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

Lists the source views (managed Amazon Web Services billing views) associated with the billing view.\n

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

Lists the source views (managed Amazon Web Services billing views) associated with the billing view.

", "smithy.api#examples": [ { "title": "Invoke ListSourceViewsForBillingView", @@ -1460,20 +2363,20 @@ "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.\n

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

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.billing#BillingViewsMaxResults", "traits": { - "smithy.api#documentation": "

\n The number of entries a paginated response contains.\n

" + "smithy.api#documentation": "

The number of entries a paginated response contains.

" } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { - "smithy.api#documentation": "

\n The pagination token that is used on subsequent calls to list billing views.\n

" + "smithy.api#documentation": "

The pagination token that is used on subsequent calls to list billing views.

" } } }, @@ -1487,14 +2390,14 @@ "sourceViews": { "target": "com.amazonaws.billing#BillingViewSourceViewsList", "traits": { - "smithy.api#documentation": "

A list of billing views used as the data source for the custom billing view.\n

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

A list of billing views used as the data source for the custom billing view.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.billing#PageToken", "traits": { - "smithy.api#documentation": "

\n The pagination token that is used on subsequent calls to list billing views.\n

" + "smithy.api#documentation": "

The pagination token that is used on subsequent calls to list billing views.

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

Lists tags associated with the billing view resource.\n

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

Lists tags associated with the billing view resource.

", "smithy.api#examples": [ { "title": "Invoke ListTagsForResource", @@ -1554,7 +2457,7 @@ "resourceArn": { "target": "com.amazonaws.billing#ResourceArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the resource. \n

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

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#required": {} } } @@ -1569,7 +2472,7 @@ "resourceTags": { "target": "com.amazonaws.billing#ResourceTagList", "traits": { - "smithy.api#documentation": "

\n A list of tag key value pairs that are associated with the resource.\n

" + "smithy.api#documentation": "

A list of tag key value pairs that are associated with the resource.

" } } }, @@ -1625,14 +2528,14 @@ "resourceId": { "target": "com.amazonaws.billing#ResourceId", "traits": { - "smithy.api#documentation": "

\n Value is a list of resource IDs that were not found.\n

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

Value is a list of resource IDs that were not found.

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

\n Value is the type of resource that was not found.\n

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

Value is the type of resource that was not found.

", "smithy.api#required": {} } } @@ -1642,7 +2545,7 @@ "code": "BillingResourceNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "

\n The specified ARN in the request doesn't exist.\n

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

The specified ARN in the request doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1653,19 +2556,19 @@ "key": { "target": "com.amazonaws.billing#ResourceTagKey", "traits": { - "smithy.api#documentation": "

\n The key that's associated with the tag.\n

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

The key that's associated with the tag.

", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.billing#ResourceTagValue", "traits": { - "smithy.api#documentation": "

\n The value that's associated with the tag.\n

" + "smithy.api#documentation": "

The value that's associated with the tag.

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

\n The tag structure that contains a tag key and value.\n

" + "smithy.api#documentation": "

The tag structure that contains a tag key and value.

" } }, "com.amazonaws.billing#ResourceTagKey": { @@ -1740,28 +2643,28 @@ "resourceId": { "target": "com.amazonaws.billing#ResourceId", "traits": { - "smithy.api#documentation": "

\n The ID of the resource.\n

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

The ID of the resource.

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

\n The type of Amazon Web Services resource.\n

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

The type of Amazon Web Services resource.

", "smithy.api#required": {} } }, "serviceCode": { "target": "com.amazonaws.billing#ServiceCode", "traits": { - "smithy.api#documentation": "

\n The container for the serviceCode.\n

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

The container for the serviceCode.

", "smithy.api#required": {} } }, "quotaCode": { "target": "com.amazonaws.billing#QuotaCode", "traits": { - "smithy.api#documentation": "

\n The container for the quotaCode.\n

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

The container for the quotaCode.

", "smithy.api#required": {} } } @@ -1771,7 +2674,7 @@ "code": "BillingServiceQuotaExceeded", "httpResponseCode": 402 }, - "smithy.api#documentation": "

\n You've reached the limit of resources you can create, or exceeded the size of an individual resource.\n

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

You've reached the limit of resources you can create, or exceeded the size of an individual resource.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -1812,7 +2715,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n An API operation for adding one or more tags (key-value pairs) to a resource.\n

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

An API operation for adding one or more tags (key-value pairs) to a resource.

", "smithy.api#examples": [ { "title": "Invoke TagResource", @@ -1836,14 +2739,14 @@ "resourceArn": { "target": "com.amazonaws.billing#ResourceArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the resource.\n

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

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#required": {} } }, "resourceTags": { "target": "com.amazonaws.billing#ResourceTagList", "traits": { - "smithy.api#documentation": "

\n A list of tag key value pairs that are associated with the resource.\n

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

A list of tag key value pairs that are associated with the resource.

", "smithy.api#required": {} } } @@ -1865,20 +2768,20 @@ "key": { "target": "com.amazonaws.billing#TagKey", "traits": { - "smithy.api#documentation": "

\n The key for the tag.\n

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

The key for the tag.

", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.billing#Values", "traits": { - "smithy.api#documentation": "

\n The specific value of the tag.\n

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

The specific value of the tag.

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

\n The values that are available for a tag.\n

" + "smithy.api#documentation": "

The values that are available for a tag.

" } }, "com.amazonaws.billing#ThrottlingException": { @@ -1896,11 +2799,31 @@ "code": "BillingThrottling", "httpResponseCode": 429 }, - "smithy.api#documentation": "

The request was denied due to request throttling.\n

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

The request was denied due to request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, + "com.amazonaws.billing#TimeRange": { + "type": "structure", + "members": { + "beginDateInclusive": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The inclusive start date of the time range.

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

The inclusive end date of the time range.

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

Specifies a time range with inclusive begin and end dates.

" + } + }, "com.amazonaws.billing#UntagResource": { "type": "operation", "input": { @@ -1927,7 +2850,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.\n

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

Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.

", "smithy.api#examples": [ { "title": "Invoke UntagResource", @@ -1948,14 +2871,14 @@ "resourceArn": { "target": "com.amazonaws.billing#ResourceArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the resource.\n

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

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#required": {} } }, "resourceTagKeys": { "target": "com.amazonaws.billing#ResourceTagKeyList", "traits": { - "smithy.api#documentation": "

\n A list of tag key value pairs that are associated with the resource.\n

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

A list of tag key value pairs that are associated with the resource.

", "smithy.api#required": {} } } @@ -1983,6 +2906,9 @@ { "target": "com.amazonaws.billing#AccessDeniedException" }, + { + "target": "com.amazonaws.billing#BillingViewHealthStatusException" + }, { "target": "com.amazonaws.billing#ConflictException" }, @@ -2003,7 +2929,7 @@ } ], "traits": { - "smithy.api#documentation": "

An API to update the attributes of the billing view.\n

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

An API to update the attributes of the billing view.

", "smithy.api#examples": [ { "title": "Invoke UpdateBillingView", @@ -2035,26 +2961,26 @@ "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.\n

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

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.billing#BillingViewName", "traits": { - "smithy.api#documentation": "

\n The name of the billing view.\n

" + "smithy.api#documentation": "

The name of the billing view.

" } }, "description": { "target": "com.amazonaws.billing#BillingViewDescription", "traits": { - "smithy.api#documentation": "

\n The description of the billing view.\n

" + "smithy.api#documentation": "

The description of the billing view.

" } }, "dataFilterExpression": { "target": "com.amazonaws.billing#Expression", "traits": { - "smithy.api#documentation": "

See Expression. Billing view only supports LINKED_ACCOUNT and Tags.\n

" + "smithy.api#documentation": "

See Expression. Billing view only supports LINKED_ACCOUNT and Tags.

" } } }, @@ -2068,14 +2994,14 @@ "arn": { "target": "com.amazonaws.billing#BillingViewArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.\n

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

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

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

\n The time when the billing view was last updated.\n

" + "smithy.api#documentation": "

The time when the billing view was last updated.

" } } }, @@ -2111,7 +3037,7 @@ "code": "BillingValidation", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an Amazon Web Services service.\n

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

The input fails to satisfy the constraints specified by an Amazon Web Services service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2135,7 +3061,7 @@ } }, "traits": { - "smithy.api#documentation": "

The field's information of a request that resulted in an exception.\n

" + "smithy.api#documentation": "

The field's information of a request that resulted in an exception.

" } }, "com.amazonaws.billing#ValidationExceptionFieldList": { diff --git a/codegen/sdk/aws-models/billingconductor.json b/codegen/sdk/aws-models/billingconductor.json index 63486ce434d..2faab9e2137 100644 --- a/codegen/sdk/aws-models/billingconductor.json +++ b/codegen/sdk/aws-models/billingconductor.json @@ -625,17 +625,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -649,17 +638,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -673,17 +651,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -697,17 +664,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/braket.json b/codegen/sdk/aws-models/braket.json index a24b0d86564..29878ddd5ed 100644 --- a/codegen/sdk/aws-models/braket.json +++ b/codegen/sdk/aws-models/braket.json @@ -9,11 +9,38 @@ } }, "traits": { - "smithy.api#documentation": "

You do not have sufficient access to perform this action.

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

You do not have sufficient permissions to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, + "com.amazonaws.braket#ActionMetadata": { + "type": "structure", + "members": { + "actionType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of action associated with the quantum task.

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

The number of programs in a program set. This is only available for a Program Set.

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

The number of executables in a program set. This is only available for a Program Set.

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

Contains metadata about the quantum task action, including the action type and program statistics.

" + } + }, "com.amazonaws.braket#AlgorithmSpecification": { "type": "structure", "members": { @@ -26,12 +53,12 @@ "containerImage": { "target": "com.amazonaws.braket#ContainerImage", "traits": { - "smithy.api#documentation": "

The container image used to create an Amazon Braket job.

" + "smithy.api#documentation": "

The container image used to create an Amazon Braket hybrid job.

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

Defines the Amazon Braket job to be created. Specifies the container image the job uses\n and the paths to the Python scripts used for entry and training.

" + "smithy.api#documentation": "

Defines the Amazon Braket hybrid job to be created. Specifies the container image the job uses and the paths to the Python scripts used for entry and training.

" } }, "com.amazonaws.braket#Association": { @@ -126,7 +153,7 @@ "date" ] }, - "smithy.api#documentation": "

The Amazon Braket API Reference provides information about the operations and structures\n supported in Amazon Braket.

\n

Additional Resources:

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

The Amazon Braket API Reference provides information about the operations and structures supported by Amazon Braket.

To learn about the permissions required to call an Amazon Braket API action, see Actions, resources, and condition keys for Amazon Braket. Amazon Braket Python SDK and the AWS Command Line Interface can be used to make discovery and creation of API calls easier. For more information about Amazon Braket features, see What is Amazon Braket? and important terms and concepts in the Amazon Braket Developer Guide.

In this guide:

Available languages for AWS SDK:

Code examples from the Amazon Braket Tutorials GitHub repository:

", "smithy.api#title": "Braket", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -639,17 +666,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -663,17 +679,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -687,17 +692,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -711,17 +705,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -832,7 +815,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels an Amazon Braket job.

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

Cancels an Amazon Braket hybrid job.

", "smithy.api#http": { "uri": "/job/{jobArn}/cancel", "method": "PUT" @@ -846,7 +829,7 @@ "jobArn": { "target": "com.amazonaws.braket#JobArn", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Braket job to cancel.

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

The ARN of the Amazon Braket hybrid job to cancel.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -866,7 +849,7 @@ "cancellationStatus": { "target": "com.amazonaws.braket#CancellationStatus", "traits": { - "smithy.api#documentation": "

The status of the job cancellation request.

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

The status of the hybrid job.

", "smithy.api#required": {} } } @@ -915,7 +898,7 @@ "quantumTaskArn": { "target": "com.amazonaws.braket#QuantumTaskArn", "traits": { - "smithy.api#documentation": "

The ARN of the task to cancel.

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

The ARN of the quantum task to cancel.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -923,7 +906,7 @@ "clientToken": { "target": "com.amazonaws.braket#String64", "traits": { - "smithy.api#documentation": "

The client token associated with the request.

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

The client token associated with the cancellation request.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -936,14 +919,14 @@ "quantumTaskArn": { "target": "com.amazonaws.braket#QuantumTaskArn", "traits": { - "smithy.api#documentation": "

The ARN of the task.

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

The ARN of the quantum task.

", "smithy.api#required": {} } }, "cancellationStatus": { "target": "com.amazonaws.braket#CancellationStatus", "traits": { - "smithy.api#documentation": "

The status of the cancellation request.

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

The status of the quantum task.

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

The container image used to create an Amazon Braket job.

" + "smithy.api#documentation": "

The container image used to create an Amazon Braket hybrid job.

" } }, "com.amazonaws.braket#CreateJob": { @@ -1042,7 +1025,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Braket job.

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

Creates an Amazon Braket hybrid job.

", "smithy.api#http": { "uri": "/job", "method": "POST", @@ -1056,7 +1039,7 @@ "clientToken": { "target": "com.amazonaws.braket#String64", "traits": { - "smithy.api#documentation": "

A unique token that guarantees that the call to this API is idempotent.

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

The client token associated with this request that guarantees that the request is idempotent.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -1064,14 +1047,14 @@ "algorithmSpecification": { "target": "com.amazonaws.braket#AlgorithmSpecification", "traits": { - "smithy.api#documentation": "

Definition of the Amazon Braket job to be created. Specifies the container image the job\n uses and information about the Python scripts used for entry and training.

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

Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.

", "smithy.api#required": {} } }, "inputDataConfig": { "target": "com.amazonaws.braket#InputConfigList", "traits": { - "smithy.api#documentation": "

A list of parameters that specify the name and type of input data and where it is\n located.

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

A list of parameters that specify the name and type of input data and where it is located.

", "smithy.api#length": { "min": 0, "max": 20 @@ -1081,20 +1064,20 @@ "outputDataConfig": { "target": "com.amazonaws.braket#JobOutputDataConfig", "traits": { - "smithy.api#documentation": "

The path to the S3 location where you want to store job artifacts and the encryption key\n used to store them.

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

The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.

", "smithy.api#required": {} } }, "checkpointConfig": { "target": "com.amazonaws.braket#JobCheckpointConfig", "traits": { - "smithy.api#documentation": "

Information about the output locations for job checkpoint data.

" + "smithy.api#documentation": "

Information about the output locations for hybrid job checkpoint data.

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

The name of the Amazon Braket job.

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

The name of the Amazon Braket hybrid job.

", "smithy.api#length": { "min": 1, "max": 50 @@ -1106,40 +1089,40 @@ "roleArn": { "target": "com.amazonaws.braket#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform\n tasks on behalf of a user. It can access user resources, run an Amazon Braket job container\n on behalf of user, and output resources to the users' s3 buckets.

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

The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output results and hybrid job details to the users' s3 buckets.

", "smithy.api#required": {} } }, "stoppingCondition": { "target": "com.amazonaws.braket#JobStoppingCondition", "traits": { - "smithy.api#documentation": "

The user-defined criteria that specifies when a job stops running.

" + "smithy.api#documentation": "

The user-defined criteria that specifies when a hybrid job stops running.

" } }, "instanceConfig": { "target": "com.amazonaws.braket#InstanceConfig", "traits": { - "smithy.api#documentation": "

Configuration of the resource instances to use while running the hybrid job on Amazon\n Braket.

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

Configuration of the resource instances to use while running the hybrid job on Amazon Braket.

", "smithy.api#required": {} } }, "hyperParameters": { "target": "com.amazonaws.braket#HyperParameters", "traits": { - "smithy.api#documentation": "

Algorithm-specific parameters used by an Amazon Braket job that influence the quality of\n the training job. The values are set with a string of JSON key:value pairs, where the key\n is the name of the hyperparameter and the value is the value of th hyperparameter.

" + "smithy.api#documentation": "

Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of the hyperparameter.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.

" } }, "deviceConfig": { "target": "com.amazonaws.braket#DeviceConfig", "traits": { - "smithy.api#documentation": "

The quantum processing unit (QPU) or simulator used to create an Amazon Braket\n job.

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

The quantum processing unit (QPU) or simulator used to create an Amazon Braket hybrid job.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.braket#TagsMap", "traits": { - "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata for\n Amazon Braket resources.

" + "smithy.api#documentation": "

Tags to be added to the hybrid job you're creating.

" } }, "associations": { @@ -1160,7 +1143,7 @@ "jobArn": { "target": "com.amazonaws.braket#JobArn", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Braket job created.

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

The ARN of the Amazon Braket hybrid job created.

", "smithy.api#required": {} } } @@ -1220,14 +1203,14 @@ "deviceArn": { "target": "com.amazonaws.braket#DeviceArn", "traits": { - "smithy.api#documentation": "

The ARN of the device to run the task on.

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

The ARN of the device to run the quantum task on.

", "smithy.api#required": {} } }, "deviceParameters": { "target": "com.amazonaws.braket#JsonValue", "traits": { - "smithy.api#documentation": "

The parameters for the device to run the task on.

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

The parameters for the device to run the quantum task on.

", "smithy.api#length": { "min": 1, "max": 48000 @@ -1237,7 +1220,7 @@ "shots": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

The number of shots to use for the task.

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

The number of shots to use for the quantum task.

", "smithy.api#range": { "min": 0 }, @@ -1247,7 +1230,7 @@ "outputS3Bucket": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The S3 bucket to store task result files in.

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

The S3 bucket to store quantum task result files in.

", "smithy.api#length": { "min": 3, "max": 63 @@ -1258,7 +1241,7 @@ "outputS3KeyPrefix": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The key prefix for the location in the S3 bucket to store task results in.

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

The key prefix for the location in the S3 bucket to store quantum task results in.

", "smithy.api#length": { "min": 1, "max": 1024 @@ -1269,7 +1252,7 @@ "action": { "target": "com.amazonaws.braket#JsonValue", "traits": { - "smithy.api#documentation": "

The action associated with the task.

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

The action associated with the quantum task.

", "smithy.api#required": {} } }, @@ -1282,7 +1265,7 @@ "jobToken": { "target": "com.amazonaws.braket#JobToken", "traits": { - "smithy.api#documentation": "

The token for an Amazon Braket job that associates it with the quantum task.

" + "smithy.api#documentation": "

The token for an Amazon Braket hybrid job that associates it with the quantum task.

" } }, "associations": { @@ -1303,7 +1286,7 @@ "quantumTaskArn": { "target": "com.amazonaws.braket#QuantumTaskArn", "traits": { - "smithy.api#documentation": "

The ARN of the task created by the request.

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

The ARN of the quantum task created by the request.

", "smithy.api#required": {} } } @@ -1315,13 +1298,13 @@ "s3DataSource": { "target": "com.amazonaws.braket#S3DataSource", "traits": { - "smithy.api#documentation": "

Information about the data stored in Amazon S3 used by the Amazon Braket job.

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

Amazon S3 path of the input data used by the hybrid job.

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

Information about the source of the data used by the Amazon Braket job.

" + "smithy.api#documentation": "

Information about the source of the input data used by the Amazon Braket hybrid job.

" } }, "com.amazonaws.braket#DeviceArn": { @@ -1343,13 +1326,13 @@ "device": { "target": "com.amazonaws.braket#String256", "traits": { - "smithy.api#documentation": "

The primary quantum processing unit (QPU) or simulator used to create and run an Amazon\n Braket job.

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

The primary device ARN used to create and run an Amazon Braket hybrid job.

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

Configures the quantum processing units (QPUs) or simulator used to create and run an\n Amazon Braket job.

" + "smithy.api#documentation": "

Configures the primary device used to create and run an Amazon Braket hybrid job.

" } }, "com.amazonaws.braket#DeviceOfflineException": { @@ -1378,19 +1361,19 @@ "queueSize": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The number of jobs or tasks in the queue for a given device.

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

The number of hybrid jobs or quantum tasks in the queue for a given device.

", "smithy.api#required": {} } }, "queuePriority": { "target": "com.amazonaws.braket#QueuePriority", "traits": { - "smithy.api#documentation": "

Optional. Specifies the priority of the queue. Tasks in a priority queue\n are processed before the tasks in a normal queue.

" + "smithy.api#documentation": "

Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the quantum tasks in a normal queue.

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

Information about tasks and jobs queued on a device.

" + "smithy.api#documentation": "

Information about quantum tasks and hybrid jobs queued on a device.

" } }, "com.amazonaws.braket#DeviceQueueInfoList": { @@ -1541,7 +1524,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the devices available in Amazon Braket.

\n \n

For backwards compatibility with older versions of BraketSchemas, OpenQASM\n information is omitted from GetDevice API calls. To get this information the user-agent\n needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK\n automatically reports this for you. If you do not see OpenQASM results in the GetDevice\n response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment\n variable to configure user-agent. See the code examples provided below for how to do\n this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.

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

Retrieves the devices available in Amazon Braket.

For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.

", "smithy.api#http": { "uri": "/device/{deviceArn}", "method": "GET" @@ -1610,7 +1593,7 @@ "deviceQueueInfo": { "target": "com.amazonaws.braket#DeviceQueueInfoList", "traits": { - "smithy.api#documentation": "

List of information about tasks and jobs queued on a device.

" + "smithy.api#documentation": "

The number of quantum tasks and hybrid jobs currently queued on the device.

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

Retrieves the specified Amazon Braket job.

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

Retrieves the specified Amazon Braket hybrid job.

", "smithy.api#http": { "uri": "/job/{jobArn}", "method": "GET" @@ -1655,7 +1638,7 @@ "jobArn": { "target": "com.amazonaws.braket#JobArn", "traits": { - "smithy.api#documentation": "

The ARN of the job to retrieve.

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

The ARN of the hybrid job to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1663,7 +1646,7 @@ "additionalAttributeNames": { "target": "com.amazonaws.braket#HybridJobAdditionalAttributeNamesList", "traits": { - "smithy.api#documentation": "

A list of attributes to return information for.

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

A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.

", "smithy.api#httpQuery": "additionalAttributeNames" } } @@ -1675,34 +1658,34 @@ "status": { "target": "com.amazonaws.braket#JobPrimaryStatus", "traits": { - "smithy.api#documentation": "

The status of the Amazon Braket job.

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

The status of the Amazon Braket hybrid job.

", "smithy.api#required": {} } }, "jobArn": { "target": "com.amazonaws.braket#JobArn", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Braket job.

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

The ARN of the Amazon Braket hybrid job.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.braket#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform\n tasks on behalf of a user. It can access user resources, run an Amazon Braket job container\n on behalf of user, and output resources to the s3 buckets of a user.

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

The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output results and other hybrid job details to the s3 buckets of a user.

", "smithy.api#required": {} } }, "failureReason": { "target": "com.amazonaws.braket#String1024", "traits": { - "smithy.api#documentation": "

A description of the reason why an Amazon Braket job failed, if it failed.

" + "smithy.api#documentation": "

A description of the reason why an Amazon Braket hybrid job failed, if it failed.

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

The name of the Amazon Braket job.

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

The name of the Amazon Braket hybrid job.

", "smithy.api#length": { "min": 1, "max": 50 @@ -1714,38 +1697,38 @@ "hyperParameters": { "target": "com.amazonaws.braket#HyperParameters", "traits": { - "smithy.api#documentation": "

Algorithm-specific parameters used by an Amazon Braket job that influence the quality of\n the traiing job. The values are set with a string of JSON key:value pairs, where the key is\n the name of the hyperparameter and the value is the value of th hyperparameter.

" + "smithy.api#documentation": "

Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the traiing job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.

" } }, "inputDataConfig": { "target": "com.amazonaws.braket#InputConfigList", "traits": { - "smithy.api#documentation": "

A list of parameters that specify the name and type of input data and where it is\n located.

" + "smithy.api#documentation": "

A list of parameters that specify the name and type of input data and where it is located.

" } }, "outputDataConfig": { "target": "com.amazonaws.braket#JobOutputDataConfig", "traits": { - "smithy.api#documentation": "

The path to the S3 location where job artifacts are stored and the encryption key used\n to store them there.

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

The path to the S3 location where hybrid job artifacts are stored and the encryption key used to store them there.

", "smithy.api#required": {} } }, "stoppingCondition": { "target": "com.amazonaws.braket#JobStoppingCondition", "traits": { - "smithy.api#documentation": "

The user-defined criteria that specifies when to stop a job running.

" + "smithy.api#documentation": "

The user-defined criteria that specifies when to stop a running hybrid job.

" } }, "checkpointConfig": { "target": "com.amazonaws.braket#JobCheckpointConfig", "traits": { - "smithy.api#documentation": "

Information about the output locations for job checkpoint data.

" + "smithy.api#documentation": "

Information about the output locations for hybrid job checkpoint data.

" } }, "algorithmSpecification": { "target": "com.amazonaws.braket#AlgorithmSpecification", "traits": { - "smithy.api#documentation": "

Definition of the Amazon Braket job created. Specifies the container image the job uses,\n information about the Python scripts used for entry and training, and the user-defined\n metrics used to evaluation the job.

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

Definition of the Amazon Braket hybrid job created. Provides information about the container image used, and the Python scripts used for training.

", "smithy.api#required": {} } }, @@ -1759,7 +1742,7 @@ "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the Amazon Braket job was created.

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

The time at which the Amazon Braket hybrid job was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } @@ -1767,45 +1750,45 @@ "startedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the Amazon Braket job was started.

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

The time at which the Amazon Braket hybrid job was started.

", "smithy.api#timestampFormat": "date-time" } }, "endedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the Amazon Braket job ended.

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

The time at which the Amazon Braket hybrid job ended.

", "smithy.api#timestampFormat": "date-time" } }, "billableDuration": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The billable time the Amazon Braket job used to complete.

" + "smithy.api#documentation": "

The billable time for which the Amazon Braket hybrid job used to complete.

" } }, "deviceConfig": { "target": "com.amazonaws.braket#DeviceConfig", "traits": { - "smithy.api#documentation": "

The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.

" + "smithy.api#documentation": "

The primary device used by the Amazon Braket hybrid job.

" } }, "events": { "target": "com.amazonaws.braket#JobEvents", "traits": { - "smithy.api#documentation": "

Details about the type and time events occurred related to the Amazon Braket job.

" + "smithy.api#documentation": "

Details about the time and type of events occurred related to the Amazon Braket hybrid job.

" } }, "tags": { "target": "com.amazonaws.braket#TagsMap", "traits": { - "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata for\n Amazon Braket resources.

" + "smithy.api#documentation": "

The tags associated with this hybrid job.

" } }, "queueInfo": { "target": "com.amazonaws.braket#HybridJobQueueInfo", "traits": { - "smithy.api#documentation": "

Queue information for the requested job. Only returned if \n QueueInfo is specified in the additionalAttributeNames\"\n field in the GetJob API request.

" + "smithy.api#documentation": "

Queue information for the requested hybrid job. Only returned if QueueInfo is specified in the additionalAttributeNames\" field in the GetJob API request.

" } }, "associations": { @@ -1856,7 +1839,7 @@ "quantumTaskArn": { "target": "com.amazonaws.braket#QuantumTaskArn", "traits": { - "smithy.api#documentation": "

The ARN of the task to retrieve.

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

The ARN of the quantum task to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1864,7 +1847,7 @@ "additionalAttributeNames": { "target": "com.amazonaws.braket#QuantumTaskAdditionalAttributeNamesList", "traits": { - "smithy.api#documentation": "

A list of attributes to return information for.

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

A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.

", "smithy.api#httpQuery": "additionalAttributeNames" } } @@ -1876,62 +1859,62 @@ "quantumTaskArn": { "target": "com.amazonaws.braket#QuantumTaskArn", "traits": { - "smithy.api#documentation": "

The ARN of the task.

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

The ARN of the quantum task.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.braket#QuantumTaskStatus", "traits": { - "smithy.api#documentation": "

The status of the task.

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

The status of the quantum task.

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

The reason that a task failed.

" + "smithy.api#documentation": "

The reason that a quantum task failed.

" } }, "deviceArn": { "target": "com.amazonaws.braket#DeviceArn", "traits": { - "smithy.api#documentation": "

The ARN of the device the task was run on.

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

The ARN of the device the quantum task was run on.

", "smithy.api#required": {} } }, "deviceParameters": { "target": "com.amazonaws.braket#JsonValue", "traits": { - "smithy.api#documentation": "

The parameters for the device on which the task ran.

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

The parameters for the device on which the quantum task ran.

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

The number of shots used in the task.

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

The number of shots used in the quantum task.

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

The S3 bucket where task results are stored.

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

The S3 bucket where quantum task results are stored.

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

The folder in the S3 bucket where task results are stored.

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

The folder in the S3 bucket where quantum task results are stored.

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

The time at which the task was created.

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

The time at which the quantum task was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } @@ -1939,14 +1922,14 @@ "endedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time at which the task ended.

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

The time at which the quantum task ended.

", "smithy.api#timestampFormat": "date-time" } }, "tags": { "target": "com.amazonaws.braket#TagsMap", "traits": { - "smithy.api#documentation": "

The tags that belong to this task.

" + "smithy.api#documentation": "

The tags that belong to this quantum task.

" } }, "jobArn": { @@ -1958,7 +1941,7 @@ "queueInfo": { "target": "com.amazonaws.braket#QuantumTaskQueueInfo", "traits": { - "smithy.api#documentation": "

Queue information for the requested quantum task. Only returned if \n QueueInfo is specified in the additionalAttributeNames\"\n field in the GetQuantumTask API request.

" + "smithy.api#documentation": "

Queue information for the requested quantum task. Only returned if QueueInfo is specified in the additionalAttributeNames\" field in the GetQuantumTask API request.

" } }, "associations": { @@ -1966,6 +1949,18 @@ "traits": { "smithy.api#documentation": "

The list of Amazon Braket resources associated with the quantum task.

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

The number of successful shots for the quantum task. This is available after a successfully completed quantum task.

" + } + }, + "actionMetadata": { + "target": "com.amazonaws.braket#ActionMetadata", + "traits": { + "smithy.api#documentation": "

Metadata about the action performed by the quantum task, including information about the type of action and program counts.

" + } } } }, @@ -1999,19 +1994,19 @@ "position": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Current position of the job in the jobs queue.

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

Current position of the hybrid job in the jobs queue.

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

Optional. Provides more information about the queue position. For example,\n if the job is complete and no longer in the queue, the message field contains\n that information.

" + "smithy.api#documentation": "

Optional. Provides more information about the queue position. For example, if the hybrid job is complete and no longer in the queue, the message field contains that information.

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

Information about the queue for a specified job.

" + "smithy.api#documentation": "

Information about the queue for a specified hybrid job.

" } }, "com.amazonaws.braket#HyperParameters": { @@ -2048,7 +2043,7 @@ "channelName": { "target": "com.amazonaws.braket#String64", "traits": { - "smithy.api#documentation": "

A named input source that an Amazon Braket job can consume.

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

A named input source that an Amazon Braket hybrid job can consume.

", "smithy.api#pattern": "^[A-Za-z0-9\\.\\-_]+$", "smithy.api#required": {} } @@ -2062,13 +2057,13 @@ "dataSource": { "target": "com.amazonaws.braket#DataSource", "traits": { - "smithy.api#documentation": "

The location of the channel data.

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

The location of the input data.

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

A list of parameters that specify the input channels, type of input data, and where it\n is located.

" + "smithy.api#documentation": "

A list of parameters that specify the input channels, type of input data, and where it is located.

" } }, "com.amazonaws.braket#InstanceConfig": { @@ -2077,14 +2072,14 @@ "instanceType": { "target": "com.amazonaws.braket#InstanceType", "traits": { - "smithy.api#documentation": "

Configures the type resource instances to use while running an Amazon Braket hybrid\n job.

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

Configures the type of resource instances to use while running an Amazon Braket hybrid job.

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

The size of the storage volume, in GB, that user wants to provision.

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

The size of the storage volume, in GB, to provision.

", "smithy.api#range": { "min": 1 }, @@ -2094,7 +2089,7 @@ "instanceCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Configures the number of resource instances to use while running an Amazon Braket job on\n Amazon Braket. The default value is 1.

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

Configures the number of resource instances to use while running an Amazon Braket hybrid job on Amazon Braket. The default value is 1.

", "smithy.api#range": { "min": 1 } @@ -2102,7 +2097,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configures the resource instances to use while running the Amazon Braket hybrid job on\n Amazon Braket.

" + "smithy.api#documentation": "

Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon Braket.

" } }, "com.amazonaws.braket#InstanceType": { @@ -2276,7 +2271,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception, or\n failure.

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

The request failed because of an unknown error.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -2297,19 +2292,19 @@ "localPath": { "target": "com.amazonaws.braket#String4096", "traits": { - "smithy.api#documentation": "

(Optional) The local directory where checkpoints are written. The default directory is\n /opt/braket/checkpoints/.

" + "smithy.api#documentation": "

(Optional) The local directory where checkpoint data is stored. The default directory is /opt/braket/checkpoints/.

" } }, "s3Uri": { "target": "com.amazonaws.braket#S3Path", "traits": { - "smithy.api#documentation": "

Identifies the S3 path where you want Amazon Braket to store checkpoints. For example,\n s3://bucket-name/key-name-prefix.

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

Identifies the S3 path where you want Amazon Braket to store checkpoint data. For example, s3://bucket-name/key-name-prefix.

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

Contains information about the output locations for job checkpoint data.

" + "smithy.api#documentation": "

Contains information about the output locations for hybrid job checkpoint data.

" } }, "com.amazonaws.braket#JobEventDetails": { @@ -2318,20 +2313,20 @@ "eventType": { "target": "com.amazonaws.braket#JobEventType", "traits": { - "smithy.api#documentation": "

The type of event that occurred related to the Amazon Braket job.

" + "smithy.api#documentation": "

The type of event that occurred related to the Amazon Braket hybrid job.

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

The type of event that occurred related to the Amazon Braket job.

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

The time of the event that occurred related to the Amazon Braket hybrid job.

", "smithy.api#timestampFormat": "date-time" } }, "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A message describing the event that occurred related to the Amazon Braket job.

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

A message describing the event that occurred related to the Amazon Braket hybrid job.

", "smithy.api#length": { "min": 0, "max": 2500 @@ -2340,7 +2335,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about the type and time events occurred related to the Amazon Braket job.

" + "smithy.api#documentation": "

Details about the type and time events that occurred related to the Amazon Braket hybrid job.

" } }, "com.amazonaws.braket#JobEventType": { @@ -2412,19 +2407,19 @@ "kmsKeyId": { "target": "com.amazonaws.braket#String2048", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the job\n training artifacts at rest using Amazon S3 server-side encryption.

" + "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the hybrid job training artifacts at rest using Amazon S3 server-side encryption.

" } }, "s3Path": { "target": "com.amazonaws.braket#S3Path", "traits": { - "smithy.api#documentation": "

Identifies the S3 path where you want Amazon Braket to store the job training artifacts.\n For example, s3://bucket-name/key-name-prefix.

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

Identifies the S3 path where you want Amazon Braket to store the hybrid job training artifacts. For example, s3://bucket-name/key-name-prefix.

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

Specifies the path to the S3 location where you want to store job artifacts and the\n encryption key used to store them.

" + "smithy.api#documentation": "

Specifies the path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.

" } }, "com.amazonaws.braket#JobPrimaryStatus": { @@ -2492,7 +2487,7 @@ "maxRuntimeInSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum length of time, in seconds, that an Amazon Braket job can run.

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

The maximum length of time, in seconds, that an Amazon Braket hybrid job can run.

", "smithy.api#range": { "min": 1, "max": 432000 @@ -2501,7 +2496,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies limits for how long an Amazon Braket job can run.

" + "smithy.api#documentation": "

Specifies limits for how long an Amazon Braket hybrid job can run.

" } }, "com.amazonaws.braket#JobSummary": { @@ -2510,35 +2505,35 @@ "status": { "target": "com.amazonaws.braket#JobPrimaryStatus", "traits": { - "smithy.api#documentation": "

The status of the Amazon Braket job.

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

The status of the Amazon Braket hybrid job.

", "smithy.api#required": {} } }, "jobArn": { "target": "com.amazonaws.braket#JobArn", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Braket job.

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

The ARN of the Amazon Braket hybrid job.

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

The name of the Amazon Braket job.

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

The name of the Amazon Braket hybrid job.

", "smithy.api#required": {} } }, "device": { "target": "com.amazonaws.braket#String256", "traits": { - "smithy.api#documentation": "

Provides summary information about the primary device used by an Amazon Braket\n job.

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

The primary device used by an Amazon Braket hybrid job.

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

The date and time that the Amazon Braket job was created.

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

The time at which the Amazon Braket hybrid job was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } @@ -2546,26 +2541,26 @@ "startedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the Amazon Braket job was started.

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

The time at which the Amazon Braket hybrid job was started.

", "smithy.api#timestampFormat": "date-time" } }, "endedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the Amazon Braket job ended.

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

The time at which the Amazon Braket hybrid job ended.

", "smithy.api#timestampFormat": "date-time" } }, "tags": { "target": "com.amazonaws.braket#TagsMap", "traits": { - "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata for\n Amazon Braket resources.

" + "smithy.api#documentation": "

Displays the key, value pairs of tags associated with this hybrid job.

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

Provides summary information about an Amazon Braket job.

" + "smithy.api#documentation": "

Provides summary information about an Amazon Braket hybrid job.

" } }, "com.amazonaws.braket#JobSummaryList": { @@ -2641,6 +2636,45 @@ } } }, + "com.amazonaws.braket#ProgramSetValidationFailure": { + "type": "structure", + "members": { + "programIndex": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The index of the program within the program set that failed validation.

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

The index of the input within the program set that failed validation.

" + } + }, + "errors": { + "target": "com.amazonaws.braket#ProgramValidationFailuresList", + "traits": { + "smithy.api#documentation": "

A list of error messages describing the validation failures that occurred.

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

Contains information about validation failures that occurred during the processing of a program set in a quantum task.

" + } + }, + "com.amazonaws.braket#ProgramSetValidationFailuresList": { + "type": "list", + "member": { + "target": "com.amazonaws.braket#ProgramSetValidationFailure" + } + }, + "com.amazonaws.braket#ProgramValidationFailuresList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, "com.amazonaws.braket#QuantumTaskAdditionalAttributeName": { "type": "string", "traits": { @@ -2684,25 +2718,25 @@ "position": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Current position of the task in the quantum tasks queue.

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

Current position of the quantum task in the quantum tasks queue.

", "smithy.api#required": {} } }, "queuePriority": { "target": "com.amazonaws.braket#QueuePriority", "traits": { - "smithy.api#documentation": "

Optional. Specifies the priority of the queue. Quantum tasks in a priority queue\n are processed before the tasks in a normal queue.

" + "smithy.api#documentation": "

Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the quantum tasks in a normal queue.

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

Optional. Provides more information about the queue position. For example,\n if the task is complete and no longer in the queue, the message field contains\n that information.

" + "smithy.api#documentation": "

Optional. Provides more information about the queue position. For example, if the quantum task is complete and no longer in the queue, the message field contains that information.

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

Information about the queue for the specified quantum task.

" + "smithy.api#documentation": "

The queue information for the specified quantum task.

" } }, "com.amazonaws.braket#QuantumTaskResource": { @@ -2772,49 +2806,49 @@ "quantumTaskArn": { "target": "com.amazonaws.braket#QuantumTaskArn", "traits": { - "smithy.api#documentation": "

The ARN of the task.

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

The ARN of the quantum task.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.braket#QuantumTaskStatus", "traits": { - "smithy.api#documentation": "

The status of the task.

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

The status of the quantum task.

", "smithy.api#required": {} } }, "deviceArn": { "target": "com.amazonaws.braket#DeviceArn", "traits": { - "smithy.api#documentation": "

The ARN of the device the task ran on.

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

The ARN of the device the quantum task ran on.

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

The shots used for the task.

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

The shots used for the quantum task.

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

The S3 bucket where the task result file is stored..

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

The S3 bucket where the quantum task result file is stored.

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

The folder in the S3 bucket where the task result file is stored.

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

The folder in the S3 bucket where the quantum task result file is stored.

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

The time at which the task was created.

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

The time at which the quantum task was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } @@ -2822,7 +2856,7 @@ "endedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time at which the task finished.

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

The time at which the quantum task finished.

", "smithy.api#timestampFormat": "date-time" } }, @@ -2898,13 +2932,13 @@ "s3Uri": { "target": "com.amazonaws.braket#S3Path", "traits": { - "smithy.api#documentation": "

Depending on the value specified for the S3DataType, identifies either a\n key name prefix or a manifest that locates the S3 data source.

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

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest that locates the S3 data source.

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

Information about the data stored in Amazon S3 used by the Amazon Braket job.

" + "smithy.api#documentation": "

Information about the Amazon S3 storage used by the Amazon Braket hybrid job.

" } }, "com.amazonaws.braket#S3Path": { @@ -2922,26 +2956,26 @@ "entryPoint": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The path to the Python script that serves as the entry point for an Amazon Braket\n job.

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

The entry point in the algorithm scripts from where the execution begins in the hybrid job.

", "smithy.api#required": {} } }, "s3Uri": { "target": "com.amazonaws.braket#S3Path", "traits": { - "smithy.api#documentation": "

The URI that specifies the S3 path to the Python script module that contains the\n training script used by an Amazon Braket job.

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

The URI that specifies the S3 path to the algorithm scripts used by an Amazon Braket hybrid job.

", "smithy.api#required": {} } }, "compressionType": { "target": "com.amazonaws.braket#CompressionType", "traits": { - "smithy.api#documentation": "

The type of compression used by the Python scripts for an Amazon Braket job.

" + "smithy.api#documentation": "

The type of compression used to store the algorithm scripts in Amazon S3 storage.

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

Contains information about the Python scripts used for entry and by an Amazon Braket\n job.

" + "smithy.api#documentation": "

Contains information about algorithm scripts used for the Amazon Braket hybrid job.

" } }, "com.amazonaws.braket#SearchDevices": { @@ -2987,7 +3021,7 @@ "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name to use to filter results.

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

The name of the device parameter to filter based on. Only deviceArn filter name is currently supported.

", "smithy.api#length": { "min": 1, "max": 64 @@ -2998,7 +3032,7 @@ "values": { "target": "com.amazonaws.braket#String256List", "traits": { - "smithy.api#documentation": "

The values to use to filter results.

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

The values used to filter devices based on the filter name.

", "smithy.api#length": { "min": 1, "max": 10 @@ -3008,7 +3042,7 @@ } }, "traits": { - "smithy.api#documentation": "

The filter to use for searching devices.

" + "smithy.api#documentation": "

The filter used to search for devices.

" } }, "com.amazonaws.braket#SearchDevicesFilterList": { @@ -3023,7 +3057,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token used for pagination of results returned in the response. Use the token returned\n from the previous request continue results where the previous request ended.

" + "smithy.api#documentation": "

A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.

" } }, "maxResults": { @@ -3039,7 +3073,7 @@ "filters": { "target": "com.amazonaws.braket#SearchDevicesFilterList", "traits": { - "smithy.api#documentation": "

The filter values to use to search for a device.

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

Array of SearchDevicesFilter objects to use when searching for devices.

", "smithy.api#length": { "min": 0, "max": 10 @@ -3055,14 +3089,14 @@ "devices": { "target": "com.amazonaws.braket#DeviceSummaryList", "traits": { - "smithy.api#documentation": "

An array of DeviceSummary objects for devices that match the specified\n filter values.

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

An array of DeviceSummary objects for devices that match the specified filter values.

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

A token used for pagination of results, or null if there are no additional results. Use\n the token value in a subsequent request to continue results where the previous request\n ended.

" + "smithy.api#documentation": "

A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue search where the previous request ended.

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

Searches for Amazon Braket jobs that match the specified filter values.

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

Searches for Amazon Braket hybrid jobs that match the specified filter values.

", "smithy.api#http": { "uri": "/jobs", "method": "POST" @@ -3109,14 +3143,14 @@ "name": { "target": "com.amazonaws.braket#String64", "traits": { - "smithy.api#documentation": "

The name to use for the jobs filter.

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

The name of the hybrid job parameter to filter based on. Filter name can be either jobArn or createdAt.

", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.braket#String256List", "traits": { - "smithy.api#documentation": "

The values to use for the jobs filter.

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

The values used to filter hybrid jobs based on the filter name and operator.

", "smithy.api#length": { "min": 1, "max": 10 @@ -3127,13 +3161,13 @@ "operator": { "target": "com.amazonaws.braket#SearchJobsFilterOperator", "traits": { - "smithy.api#documentation": "

An operator to use for the jobs filter.

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

An operator to use for the filter.

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

A filter used to search for Amazon Braket jobs.

" + "smithy.api#documentation": "

A filter used to search for Amazon Braket hybrid jobs.

" } }, "com.amazonaws.braket#SearchJobsFilterList": { @@ -3183,7 +3217,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token used for pagination of results returned in the response. Use the token returned\n from the previous request to continue results where the previous request ended.

" + "smithy.api#documentation": "

A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.

" } }, "maxResults": { @@ -3199,7 +3233,7 @@ "filters": { "target": "com.amazonaws.braket#SearchJobsFilterList", "traits": { - "smithy.api#documentation": "

The filter values to use when searching for a job.

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

Array of SearchJobsFilter objects to use when searching for hybrid jobs.

", "smithy.api#length": { "min": 0, "max": 10 @@ -3215,14 +3249,14 @@ "jobs": { "target": "com.amazonaws.braket#JobSummaryList", "traits": { - "smithy.api#documentation": "

An array of JobSummary objects for devices that match the specified filter\n values.

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

An array of JobSummary objects for devices that match the specified filter values.

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

A token used for pagination of results, or null if there are no additional\n results. Use the token value in a subsequent request to continue results where the previous\n request ended.

" + "smithy.api#documentation": "

A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue search where the previous request ended.

" } } } @@ -3270,14 +3304,14 @@ "name": { "target": "com.amazonaws.braket#String64", "traits": { - "smithy.api#documentation": "

The name of the device used for the task.

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

The name of the quantum task parameter to filter based on. Filter name can be either quantumTaskArn, deviceArn, jobArn, status or createdAt.

", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.braket#String256List", "traits": { - "smithy.api#documentation": "

The values to use for the filter.

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

The values used to filter quantum tasks based on the filter name and operator.

", "smithy.api#length": { "min": 1, "max": 10 @@ -3288,13 +3322,13 @@ "operator": { "target": "com.amazonaws.braket#SearchQuantumTasksFilterOperator", "traits": { - "smithy.api#documentation": "

An operator to use in the filter.

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

An operator to use for the filter.

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

A filter to use to search for tasks.

" + "smithy.api#documentation": "

A filter used to search for quantum tasks.

" } }, "com.amazonaws.braket#SearchQuantumTasksFilterList": { @@ -3340,7 +3374,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token used for pagination of results returned in the response. Use the token returned\n from the previous request continue results where the previous request ended.

" + "smithy.api#documentation": "

A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.

" } }, "maxResults": { @@ -3356,7 +3390,7 @@ "filters": { "target": "com.amazonaws.braket#SearchQuantumTasksFilterList", "traits": { - "smithy.api#documentation": "

Array of SearchQuantumTasksFilter objects.

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

Array of SearchQuantumTasksFilter objects to use when searching for quantum tasks.

", "smithy.api#length": { "min": 0, "max": 10 @@ -3372,14 +3406,14 @@ "quantumTasks": { "target": "com.amazonaws.braket#QuantumTaskSummaryList", "traits": { - "smithy.api#documentation": "

An array of QuantumTaskSummary objects for tasks that match the specified\n filters.

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

An array of QuantumTaskSummary objects for quantum tasks that match the specified filters.

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

A token used for pagination of results, or null if there are no additional results. Use\n the token value in a subsequent request to continue results where the previous request\n ended.

" + "smithy.api#documentation": "

A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue search where the previous request ended.

" } } } @@ -3487,7 +3521,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specify the resourceArn of the resource to which a tag will be\n added.

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

Specify the resourceArn of the resource to which a tag will be added.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3495,7 +3529,7 @@ "tags": { "target": "com.amazonaws.braket#TagsMap", "traits": { - "smithy.api#documentation": "

Specify the tags to add to the resource.

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

Specify the tags to add to the resource. Tags can be specified as a key-value map.

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

The throttling rate limit is met.

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

The API throttling rate limit is exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -3561,7 +3595,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specify the resourceArn for the resource from which to remove the\n tags.

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

Specify the resourceArn for the resource from which to remove the tags.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3587,7 +3621,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "\\d{10,14}\\.dkr\\.ecr.[a-z0-9-]+\\.amazonaws\\.com\\/.+(@sha256)?:.+" + "smithy.api#pattern": "^\\d{10,14}\\.dkr\\.ecr.[a-z0-9-]+\\.amazonaws\\.com\\/.+(@sha256)?:.+$" } }, "com.amazonaws.braket#ValidationException": { @@ -3595,13 +3629,36 @@ "members": { "message": { "target": "smithy.api#String" + }, + "reason": { + "target": "com.amazonaws.braket#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

The reason for validation failure.

" + } + }, + "programSetValidationFailures": { + "target": "com.amazonaws.braket#ProgramSetValidationFailuresList", + "traits": { + "smithy.api#documentation": "

The validation failures in the program set submitted in the request.

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

The input fails to satisfy the constraints specified by an AWS service.

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

The input request failed to satisfy constraints expected by Amazon Braket.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } + }, + "com.amazonaws.braket#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ProgramSetValidationFailed", + "name": "PROGRAM_SET_VALIDATION_FAILED" + } + ] + } } } } \ No newline at end of file diff --git a/codegen/sdk/aws-models/budgets.json b/codegen/sdk/aws-models/budgets.json index a2d37a9abd0..e24b4c12394 100644 --- a/codegen/sdk/aws-models/budgets.json +++ b/codegen/sdk/aws-models/budgets.json @@ -985,17 +985,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1017,17 +1006,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1049,17 +1027,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1081,17 +1048,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1113,17 +1069,6 @@ "UseDualStack": false } }, - { - "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": { @@ -1145,17 +1090,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1178,18 +1112,28 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://budgets-fips.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -1200,43 +1144,53 @@ } ] }, - "url": "https://budgets-fips.csp.hci.ic.gov" + "url": "https://budgets.global.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eusc-de-east-1" + } + ] + }, + "url": "https://budgets-fips.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingRegion": "us-isof-south-1" + "signingRegion": "eusc-de-east-1" } ] }, - "url": "https://budgets.global.csp.hci.ic.gov" + "url": "https://budgets.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } @@ -1646,6 +1600,29 @@ } } }, + "com.amazonaws.budgets#BillingViewArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z-]*:(billing)::[0-9]{12}:billingview/[a-zA-Z0-9/:_\\+=\\.\\-@]{0,75}[a-zA-Z0-9]$" + } + }, + "com.amazonaws.budgets#BillingViewHealthStatusException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.budgets#errorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\n The billing view status must be HEALTHY to perform this action. Try again when the status is HEALTHY.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.budgets#Budget": { "type": "structure", "members": { @@ -1698,7 +1675,7 @@ "TimePeriod": { "target": "com.amazonaws.budgets#TimePeriod", "traits": { - "smithy.api#documentation": "

The period of time that's covered by a budget. You set the start date and end date. The\n\t\t\tstart date must come before the end date. The end date must come before 06/15/87\n\t\t\t\t00:00 UTC.

\n

If you create your budget and don't specify a start date, Amazon Web Services defaults\n\t\t\tto the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For\n\t\t\texample, if you created your budget on January 24, 2018, chose DAILY, and\n\t\t\tdidn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00\n\t\t\t\tUTC. If you chose MONTHLY, Amazon Web Services set your start\n\t\t\tdate to 01/01/18 00:00 UTC. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are\n\t\t\tthe same for the Billing and Cost Management console and the API.

\n

You can change either date with the UpdateBudget operation.

\n

After the end date, Amazon Web Services deletes the budget and all the associated\n\t\t\tnotifications and subscribers.

" + "smithy.api#documentation": "

The period of time that's covered by a budget. You set the start date and end date. The\n\t\t\tstart date must come before the end date. The end date must come before 06/15/87\n\t\t\t\t00:00 UTC.

\n

If you create your budget and don't specify a start date, Amazon Web Services defaults\n\t\t\tto the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, ANNUALLY, or CUSTOM). For\n\t\t\texample, if you created your budget on January 24, 2018, chose DAILY, and\n\t\t\tdidn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00\n\t\t\t\tUTC. If you chose MONTHLY, Amazon Web Services set your start\n\t\t\tdate to 01/01/18 00:00 UTC. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are\n\t\t\tthe same for the Billing and Cost Management console and the API.

\n

You can change either date with the UpdateBudget operation.

\n

After the end date, Amazon Web Services deletes the budget and all the associated\n\t\t\tnotifications and subscribers.

" } }, "CalculatedSpend": { @@ -1737,6 +1714,18 @@ "traits": { "smithy.api#documentation": "

The definition for how the budget data is aggregated.

" } + }, + "BillingViewArn": { + "target": "com.amazonaws.budgets#BillingViewArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is\n\t\t\tused to specify which particular billing view you want to interact with or retrieve\n\t\t\tinformation from when making API calls related to Amazon Web Services Billing and Cost\n\t\t\tManagement features. The BillingViewArn can be retrieved by calling the ListBillingViews\n\t\t\tAPI.

" + } + }, + "HealthStatus": { + "target": "com.amazonaws.budgets#HealthStatus", + "traits": { + "smithy.api#documentation": "

The current operational state of a Billing View derived resource.

" + } } }, "traits": { @@ -1804,6 +1793,12 @@ "TimeUnit": { "target": "com.amazonaws.budgets#TimeUnit" }, + "BillingViewArn": { + "target": "com.amazonaws.budgets#BillingViewArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is\n\t\t\tused to specify which particular billing view you want to interact with or retrieve\n\t\t\tinformation from when making API calls related to Amazon Web Services Billing and Cost\n\t\t\tManagement features. The BillingViewArn can be retrieved by calling the ListBillingViews\n\t\t\tAPI.

" + } + }, "BudgetedAndActualAmountsList": { "target": "com.amazonaws.budgets#BudgetedAndActualAmountsList", "traits": { @@ -2074,6 +2069,9 @@ { "target": "com.amazonaws.budgets#AccessDeniedException" }, + { + "target": "com.amazonaws.budgets#BillingViewHealthStatusException" + }, { "target": "com.amazonaws.budgets#CreationLimitExceededException" }, @@ -2086,6 +2084,9 @@ { "target": "com.amazonaws.budgets#InvalidParameterException" }, + { + "target": "com.amazonaws.budgets#NotFoundException" + }, { "target": "com.amazonaws.budgets#ServiceQuotaExceededException" }, @@ -4157,6 +4158,75 @@ } } }, + "com.amazonaws.budgets#HealthStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.budgets#HealthStatusValue", + "traits": { + "smithy.api#documentation": "

The current status of the billing view resource.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.budgets#HealthStatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the current status.

\n
    \n
  • \n

    \n BILLING_VIEW_NO_ACCESS: The billing view resource does not grant\n\t\t\t\t\t\tbilling:GetBillingViewData permission to this account.

    \n
  • \n
  • \n

    \n BILLING_VIEW_UNHEALTHY: The billing view associated with the\n\t\t\t\t\tbudget is unhealthy.

    \n
  • \n
  • \n

    \n FILTER_INVALID: The filter contains reference to an account you\n\t\t\t\t\tdo not have access to.

    \n
  • \n
  • \n

    \n MULTI_YEAR_HISTORICAL_DATA_DISABLED: The budget is not being updated. Enable multi-year historical data in your Cost Management preferences.

    \n
  • \n
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.budgets#GenericTimestamp" + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the current operational state of a billing view resource,\n\t\t\tincluding its ability to access and update based on its associated billing view.

" + } + }, + "com.amazonaws.budgets#HealthStatusReason": { + "type": "enum", + "members": { + "BILLING_VIEW_NO_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BILLING_VIEW_NO_ACCESS" + } + }, + "BILLING_VIEW_UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BILLING_VIEW_UNHEALTHY" + } + }, + "FILTER_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILTER_INVALID" + } + }, + "MULTI_YEAR_HISTORICAL_DATA_DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_YEAR_HISTORICAL_DATA_DISABLED" + } + } + } + }, + "com.amazonaws.budgets#HealthStatusValue": { + "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.budgets#HistoricalOptions": { "type": "structure", "members": { @@ -5102,7 +5172,7 @@ "Start": { "target": "com.amazonaws.budgets#GenericTimestamp", "traits": { - "smithy.api#documentation": "

The start date for a budget. If you created your budget and didn't specify a start\n\t\t\tdate, Amazon Web Services defaults to the start of your chosen time period (DAILY,\n\t\t\tMONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24,\n\t\t\t2018, chose DAILY, and didn't set a start date, Amazon Web Services set your\n\t\t\tstart date to 01/24/18 00:00 UTC. If you chose MONTHLY,\n\t\t\t\tAmazon Web Services set your start date to 01/01/18 00:00 UTC. The\n\t\t\tdefaults are the same for the Billing and Cost Management console and the API.

\n

You can change your start date with the UpdateBudget operation.

" + "smithy.api#documentation": "

The start date for a budget. If you created your budget and didn't specify a start\n\t\t\tdate, Amazon Web Services defaults to the start of your chosen time period (DAILY,\n\t\t\tMONTHLY, QUARTERLY, ANNUALLY, or CUSTOM). For example, if you created your budget on January 24,\n\t\t\t2018, chose DAILY, and didn't set a start date, Amazon Web Services set your\n\t\t\tstart date to 01/24/18 00:00 UTC. If you chose MONTHLY,\n\t\t\t\tAmazon Web Services set your start date to 01/01/18 00:00 UTC. The\n\t\t\tdefaults are the same for the Billing and Cost Management console and the API.

\n

You can change your start date with the UpdateBudget operation.

" } }, "End": { @@ -5142,6 +5212,12 @@ "traits": { "smithy.api#enumValue": "ANNUALLY" } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } } }, "traits": { @@ -5229,6 +5305,9 @@ { "target": "com.amazonaws.budgets#AccessDeniedException" }, + { + "target": "com.amazonaws.budgets#BillingViewHealthStatusException" + }, { "target": "com.amazonaws.budgets#InternalErrorException" }, diff --git a/codegen/sdk/aws-models/chatbot.json b/codegen/sdk/aws-models/chatbot.json index ab9d3deb099..c88c0df4729 100644 --- a/codegen/sdk/aws-models/chatbot.json +++ b/codegen/sdk/aws-models/chatbot.json @@ -5031,17 +5031,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5055,17 +5044,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5079,17 +5057,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5103,17 +5070,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/chime-sdk-identity.json b/codegen/sdk/aws-models/chime-sdk-identity.json index 0147f606500..f533f48356a 100644 --- a/codegen/sdk/aws-models/chime-sdk-identity.json +++ b/codegen/sdk/aws-models/chime-sdk-identity.json @@ -1103,17 +1103,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1127,17 +1116,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1151,17 +1129,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1175,17 +1142,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/chime-sdk-media-pipelines.json b/codegen/sdk/aws-models/chime-sdk-media-pipelines.json index 6a06e6e303c..574aaefa98f 100644 --- a/codegen/sdk/aws-models/chime-sdk-media-pipelines.json +++ b/codegen/sdk/aws-models/chime-sdk-media-pipelines.json @@ -1393,17 +1393,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1417,17 +1406,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1441,17 +1419,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1465,17 +1432,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/chime-sdk-meetings.json b/codegen/sdk/aws-models/chime-sdk-meetings.json index 261f0cbae16..6945e63abcb 100644 --- a/codegen/sdk/aws-models/chime-sdk-meetings.json +++ b/codegen/sdk/aws-models/chime-sdk-meetings.json @@ -74,7 +74,7 @@ "Capabilities": { "target": "com.amazonaws.chimesdkmeetings#AttendeeCapabilities", "traits": { - "smithy.api#documentation": "

The capabilities assigned to an attendee: audio, video, or content.

\n \n

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see \n .

\n
\n

When using capabilities, be aware of these corner cases:

\n
    \n
  • \n

    If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests \n that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or \n Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability \n to receive and you set your content capability to not receive.

    \n
  • \n
  • \n

    When you change an audio capability from None or Receive to Send or SendReceive , \n and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

    \n
  • \n
  • \n

    When you change a video or content capability from None or Receive to Send or SendReceive , \n and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

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

The capabilities assigned to an attendee: audio, video, or content.

\n \n

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see \n .

\n
\n

When using capabilities, be aware of these corner cases:

\n
    \n
  • \n

    If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests \n that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or \n Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability \n to receive and you set your content capability to not receive.

    \n
  • \n
  • \n

    If meeting features is defined as Video:MaxResolution:None but\n Content:MaxResolution is defined as something other than\n None and attendee capabilities are not defined in the API\n request, then the default attendee video capability is set to\n Receive and attendee content capability is set to\n SendReceive. This is because content SendReceive\n requires video to be at least Receive.

    \n
  • \n
  • \n

    When you change an audio capability from None or Receive to Send or SendReceive , \n and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

    \n
  • \n
  • \n

    When you change a video or content capability from None or Receive to Send or SendReceive , \n and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

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

The media capabilities of an attendee: audio, video, or content.

\n \n

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information, refer to \n and .

\n
\n

When using capabilities, be aware of these corner cases:

\n
    \n
  • \n

    If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests \n that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or \n Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your \n video capability to receive and you set your content capability to not receive.

    \n
  • \n
  • \n

    When you change an audio capability from None or Receive to Send or SendReceive , \n and an attendee unmutes their microphone, audio flows from the attendee to the other meeting participants.

    \n
  • \n
  • \n

    When you change a video or content capability from None or Receive to Send or SendReceive , \n and the attendee turns on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

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

The media capabilities of an attendee: audio, video, or content.

\n \n

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information, refer to \n and .

\n
\n

When using capabilities, be aware of these corner cases:

\n
    \n
  • \n

    If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests \n that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or \n Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your \n video capability to receive and you set your content capability to not receive.

    \n
  • \n
  • \n

    If meeting features is defined as Video:MaxResolution:None but\n Content:MaxResolution is defined as something other than\n None and attendee capabilities are not defined in the API\n request, then the default attendee video capability is set to\n Receive and attendee content capability is set to\n SendReceive. This is because content SendReceive\n requires video to be at least Receive.

    \n
  • \n
  • \n

    When you change an audio capability from None or Receive to Send or SendReceive , \n and an attendee unmutes their microphone, audio flows from the attendee to the other meeting participants.

    \n
  • \n
  • \n

    When you change a video or content capability from None or Receive to Send or SendReceive , \n and the attendee turns on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

    \n
  • \n
" } }, "com.amazonaws.chimesdkmeetings#AttendeeFeatures": { @@ -241,7 +241,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

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

Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/meetings/{MeetingId}/attendees?operation=batch-create", @@ -333,7 +333,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

\n \n

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see \n .

\n
\n

When using capabilities, be aware of these corner cases:

\n
    \n
  • \n

    If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests \n that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or \n Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability \n to receive and you set your content capability to not receive.

    \n
  • \n
  • \n

    When you change an audio capability from None or Receive to Send or SendReceive , \n and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

    \n
  • \n
  • \n

    When you change a video or content capability from None or Receive to Send or SendReceive , \n and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

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

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

\n \n

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see \n .

\n
\n

When using capabilities, be aware of these corner cases:

\n
    \n
  • \n

    If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests \n that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or \n Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability \n to receive and you set your content capability to not receive.

    \n
  • \n
  • \n

    If meeting features is defined as Video:MaxResolution:None but\n Content:MaxResolution is defined as something other than\n None and attendee capabilities are not defined in the API\n request, then the default attendee video capability is set to\n Receive and attendee content capability is set to\n SendReceive. This is because content SendReceive\n requires video to be at least Receive.

    \n
  • \n
  • \n

    When you change an audio capability from None or Receive to Send or SendReceive , \n and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

    \n
  • \n
  • \n

    When you change a video or content capability from None or Receive to Send or SendReceive , \n and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

    \n
  • \n
", "smithy.api#http": { "method": "PUT", "uri": "/meetings/{MeetingId}/attendees/capabilities?operation=batch-update-except", @@ -442,7 +442,7 @@ "name": "chime" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the Amazon Web Services Regions for meetings, create and manage users, and send and \n receive meeting notifications. For more information about the meeting APIs, see \n Amazon Chime SDK meetings.

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

The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the Amazon Web Services Regions for meetings, create and manage users, and send and \n receive meeting notifications. For more information about the meeting APIs, see \n Amazon Chime SDK meetings.

", "smithy.api#title": "Amazon Chime SDK Meetings", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -994,17 +994,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1018,17 +1007,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1042,17 +1020,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1066,17 +1033,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1260,7 +1216,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the \n Amazon Chime Developer Guide.\n

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

\n Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the \n Amazon Chime Developer Guide.\n

", "smithy.api#http": { "method": "POST", "uri": "/meetings/{MeetingId}/attendees", @@ -1315,7 +1271,7 @@ "Capabilities": { "target": "com.amazonaws.chimesdkmeetings#AttendeeCapabilities", "traits": { - "smithy.api#documentation": "

The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on \n all media channels by default.

\n \n

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see \n .

\n
\n

When using capabilities, be aware of these corner cases:

\n
    \n
  • \n

    If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests \n that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or \n Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability \n to receive and you set your content capability to not receive.

    \n
  • \n
  • \n

    When you change an audio capability from None or Receive to Send or SendReceive , \n and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

    \n
  • \n
  • \n

    When you change a video or content capability from None or Receive to Send or SendReceive , \n and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

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

The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on \n all media channels by default.

\n \n

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see \n .

\n
\n

When using capabilities, be aware of these corner cases:

\n
    \n
  • \n

    If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests \n that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or \n Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability \n to receive and you set your content capability to not receive.

    \n
  • \n
  • \n

    If meeting features is defined as Video:MaxResolution:None but\n Content:MaxResolution is defined as something other than\n None and attendee capabilities are not defined in the API\n request, then the default attendee video capability is set to\n Receive and attendee content capability is set to\n SendReceive. This is because content SendReceive\n requires video to be at least Receive.

    \n
  • \n
  • \n

    When you change an audio capability from None or Receive to Send or SendReceive , \n and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

    \n
  • \n
  • \n

    When you change a video or content capability from None or Receive to Send or SendReceive , \n and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

    \n
  • \n
" } } }, @@ -1405,7 +1361,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see \n Amazon Chime SDK Media Regions\n in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the \n Amazon Chime Developer Guide.\n

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

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see \n Available Regions and \n Using meeting Regions, both \n in the Amazon Chime SDK Developer Guide. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the \n Amazon Chime SDK Developer Guide.\n

\n \n

If you use this API in conjuction with the and APIs, and you don't specify the \n MeetingFeatures.Content.MaxResolution or MeetingFeatures.Video.MaxResolution parameters, the following defaults are used:

\n
    \n
  • \n

    Content.MaxResolution: FHD

    \n
  • \n
  • \n

    Video.MaxResolution: HD

    \n
  • \n
\n
", "smithy.api#http": { "method": "POST", "uri": "/meetings", @@ -1473,6 +1429,12 @@ "traits": { "smithy.api#documentation": "

Applies one or more tags to an Amazon Chime SDK meeting. Note the following:

\n
    \n
  • \n

    Not all resources have tags. For a list of services with resources that support tagging using this operation, see \n Services that support the Resource Groups Tagging API. If the resource \n doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service.

    \n
  • \n
  • \n

    Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the \n AWS General Reference.

    \n
  • \n
  • \n

    You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account.

    \n
  • \n
  • \n

    To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the \n documentation for each service.

    \n
  • \n
\n \n

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be \n used for private or sensitive data.

\n
\n

\n Minimum permissions\n

\n

In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, \n to tag a ChimeSDKMeetings instance using the TagResources operation, you must have both of the following permissions:

\n

\n tag:TagResources\n

\n

\n ChimeSDKMeetings:CreateTags\n

\n \n

Some services might have specific requirements for tagging some resources. For example, to tag an Amazon S3 bucket, you must also have the s3:GetBucketTagging permission. \n If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information.

\n
" } + }, + "MediaPlacementNetworkType": { + "target": "com.amazonaws.chimesdkmeetings#MediaPlacementNetworkType", + "traits": { + "smithy.api#documentation": "

The type of network for the media placement. Either IPv4 only or dual-stack (IPv4 and IPv6).

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

\n Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see \n Amazon Chime SDK Media Regions\n in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.\n

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

\n Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see \n Available Regions and \n Using meeting Regions, both \n in the Amazon Chime SDK Developer Guide. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the \n Amazon Chime SDK Developer Guide.\n

\n \n

If you use this API in conjuction with the and APIs, and you don't specify the \n MeetingFeatures.Content.MaxResolution or MeetingFeatures.Video.MaxResolution parameters, the following defaults are used:

\n
    \n
  • \n

    Content.MaxResolution: FHD

    \n
  • \n
  • \n

    Video.MaxResolution: HD

    \n
  • \n
\n
", "smithy.api#http": { "method": "POST", "uri": "/meetings?operation=create-attendees", @@ -1603,6 +1565,12 @@ "traits": { "smithy.api#documentation": "

The tags in the request.

" } + }, + "MediaPlacementNetworkType": { + "target": "com.amazonaws.chimesdkmeetings#MediaPlacementNetworkType", + "traits": { + "smithy.api#documentation": "

The type of network for the media placement. Either IPv4 only or dual-stack (IPv4 and IPv6).

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

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their \n JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.

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

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their \n JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.

", "smithy.api#http": { "method": "DELETE", "uri": "/meetings/{MeetingId}/attendees/{AttendeeId}", @@ -1743,7 +1711,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from \n joining the meeting. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK in the \n Amazon Chime Developer Guide.

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

Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from \n joining the meeting. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK in the \n Amazon Chime Developer Guide.

", "smithy.api#http": { "method": "DELETE", "uri": "/meetings/{MeetingId}", @@ -1994,7 +1962,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.\n

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

\n Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.\n

", "smithy.api#http": { "method": "GET", "uri": "/meetings/{MeetingId}/attendees/{AttendeeId}", @@ -2072,7 +2040,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.

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

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.

", "smithy.api#http": { "method": "GET", "uri": "/meetings/{MeetingId}", @@ -2180,7 +2148,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.\n

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

\n Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.\n

", "smithy.api#http": { "method": "GET", "uri": "/meetings/{MeetingId}/attendees", @@ -2401,6 +2369,23 @@ "smithy.api#documentation": "

A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.

" } }, + "com.amazonaws.chimesdkmeetings#MediaPlacementNetworkType": { + "type": "enum", + "members": { + "IPV4_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ipv4Only" + } + }, + "DUAL_STACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DualStack" + } + } + } + }, "com.amazonaws.chimesdkmeetings#MediaRegion": { "type": "string", "traits": { @@ -3597,7 +3582,7 @@ } ], "traits": { - "smithy.api#documentation": "

The capabilities that you want to update.

\n \n

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see \n .

\n
\n

When using capabilities, be aware of these corner cases:

\n
    \n
  • \n

    If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests \n that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or \n Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability \n to receive and you set your content capability to not receive.

    \n
  • \n
  • \n

    When you change an audio capability from None or Receive to Send or SendReceive , \n and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

    \n
  • \n
  • \n

    When you change a video or content capability from None or Receive to Send or SendReceive , \n and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

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

The capabilities that you want to update.

\n \n

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see \n .

\n
\n

When using capabilities, be aware of these corner cases:

\n
    \n
  • \n

    If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests \n that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or \n Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

    \n
  • \n
  • \n

    You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability \n to receive and you set your content capability to not receive.

    \n
  • \n
  • \n

    If meeting features is defined as Video:MaxResolution:None but\n Content:MaxResolution is defined as something other than\n None and attendee capabilities are not defined in the API\n request, then the default attendee video capability is set to\n Receive and attendee content capability is set to\n SendReceive. This is because content SendReceive\n requires video to be at least Receive.

    \n
  • \n
  • \n

    When you change an audio capability from None or Receive to Send or SendReceive , \n and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

    \n
  • \n
  • \n

    When you change a video or content capability from None or Receive to Send or SendReceive , \n and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

    \n
  • \n
", "smithy.api#http": { "method": "PUT", "uri": "/meetings/{MeetingId}/attendees/{AttendeeId}/capabilities", diff --git a/codegen/sdk/aws-models/chime-sdk-messaging.json b/codegen/sdk/aws-models/chime-sdk-messaging.json index 0992810018e..9b0a2a92ad1 100644 --- a/codegen/sdk/aws-models/chime-sdk-messaging.json +++ b/codegen/sdk/aws-models/chime-sdk-messaging.json @@ -1536,7 +1536,7 @@ "name": "chime" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The Amazon Chime SDK messaging APIs in this section allow software developers to send\n and receive messages in custom messaging applications. These APIs depend on the frameworks\n provided by the Amazon Chime SDK identity APIs. For more information about the messaging\n APIs, see Amazon Chime SDK messaging.

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

The Amazon Chime SDK messaging APIs in this section allow software developers to send\n and receive messages in custom messaging applications. These APIs depend on the frameworks\n provided by the Amazon Chime SDK identity APIs. For more information about the messaging\n APIs, see Amazon Chime SDK messaging.

", "smithy.api#title": "Amazon Chime SDK Messaging", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -2023,17 +2023,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2047,17 +2036,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2071,17 +2049,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2095,17 +2062,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2402,7 +2358,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a channel flow, a container for processors. Processors are AWS Lambda functions\n that perform actions on chat messages, such as stripping out profanity. You can associate\n channel flows with channels, and the processors in the channel flow then take action on all\n messages sent to that channel. This is a developer API.

\n

Channel flows process the following items:

\n
    \n
  1. \n

    New and updated messages

    \n
  2. \n
  3. \n

    Persistent and non-persistent messages

    \n
  4. \n
  5. \n

    The Standard message type

    \n
  6. \n
\n \n

Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to \n Message types in the Amazon Chime developer guide.

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

Creates a channel flow, a container for processors. Processors are AWS Lambda functions\n that perform actions on chat messages, such as stripping out profanity. You can associate\n channel flows with channels, and the processors in the channel flow then take action on all\n messages sent to that channel. This is a developer API.

\n

Channel flows process the following items:

\n
    \n
  1. \n

    New and updated messages

    \n
  2. \n
  3. \n

    Persistent and non-persistent messages

    \n
  4. \n
  5. \n

    The Standard message type

    \n
  6. \n
\n \n

Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to \n Message types in the Amazon Chime developer guide.

\n
", "smithy.api#http": { "method": "POST", "uri": "/channel-flows", @@ -2737,7 +2693,7 @@ "ChannelId": { "target": "com.amazonaws.chimesdkmessaging#ChannelId", "traits": { - "smithy.api#documentation": "

The ID of the channel in the request.

" + "smithy.api#documentation": "

An ID for the channel being created. If you do not specify an ID, a UUID will be created for the channel.

" } }, "MemberArns": { @@ -4426,7 +4382,15 @@ }, "com.amazonaws.chimesdkmessaging#GetMessagingSessionEndpointRequest": { "type": "structure", - "members": {}, + "members": { + "NetworkType": { + "target": "com.amazonaws.chimesdkmessaging#NetworkType", + "traits": { + "smithy.api#documentation": "

The type of network for the messaging session endpoint. Either IPv4 only or dual-stack (IPv4 and IPv6).

", + "smithy.api#httpQuery": "network-type" + } + } + }, "traits": { "smithy.api#input": {} } @@ -4805,7 +4769,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all channel memberships in a channel.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in\n the header.

\n
\n

If you want to list the channels to which a specific app instance user belongs, see the \n ListChannelMembershipsForAppInstanceUser API.

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

Lists all channel memberships in a channel.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in\n the header.

\n
\n

If you want to list the channels to which a specific app instance user belongs, see the \n ListChannelMembershipsForAppInstanceUser API.

", "smithy.api#http": { "method": "GET", "uri": "/channels/{ChannelArn}/memberships", @@ -5862,6 +5826,23 @@ } } }, + "com.amazonaws.chimesdkmessaging#NetworkType": { + "type": "enum", + "members": { + "IPV4_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4_ONLY" + } + }, + "DUAL_STACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUAL_STACK" + } + } + } + }, "com.amazonaws.chimesdkmessaging#NextToken": { "type": "string", "traits": { @@ -6371,7 +6352,7 @@ } ], "traits": { - "smithy.api#documentation": "

Redacts message content, but not metadata. The message exists in the back end, but the\n action returns null content, and the state shows as redacted.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in\n the header.

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

Redacts message content and metadata. The message exists in the back end, but the\n action returns null content, and the state shows as redacted.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in\n the header.

\n
", "smithy.api#http": { "method": "POST", "uri": "/channels/{ChannelArn}/messages/{MessageId}?operation=redact", @@ -6499,7 +6480,7 @@ } ], "traits": { - "smithy.api#documentation": "

Allows the ChimeBearer to search channels by channel members. Users or bots can search \n across the channels that they belong to. Users in the AppInstanceAdmin role can search across \n all channels.

\n

The x-amz-chime-bearer request header is mandatory. Use the\n ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in\n the header.

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

Allows the ChimeBearer to search channels by channel members. Users or bots can search \n across the channels that they belong to. Users in the AppInstanceAdmin role can search across \n all channels.

\n

The x-amz-chime-bearer request header is mandatory. Use the\n ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in\n the header.

\n \n

This operation isn't supported for AppInstanceUsers with a large number of memberships.

\n
", "smithy.api#http": { "method": "POST", "uri": "/channels?operation=search", @@ -6581,7 +6562,7 @@ "Values": { "target": "com.amazonaws.chimesdkmessaging#SearchFieldValues", "traits": { - "smithy.api#documentation": "

The values that you want to search for, a list of strings. The values must be AppInstanceUserArns specified as a list of strings.

\n \n

This operation isn't supported for AppInstanceUsers with large number of memberships.

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

The values that you want to search for, a list of strings. The values must be AppInstanceUserArns specified as a list of strings.

\n \n

This operation isn't supported for AppInstanceUsers with a large number of memberships.

\n
", "smithy.api#required": {} } }, @@ -6594,7 +6575,7 @@ } }, "traits": { - "smithy.api#documentation": "

A Field of the channel that you want to search.

" + "smithy.api#documentation": "

A Field of the channel that you want to search.

\n \n

This operation isn't supported for AppInstanceUsers with a large number of memberships.

\n
" } }, "com.amazonaws.chimesdkmessaging#SearchFieldKey": { diff --git a/codegen/sdk/aws-models/chime-sdk-voice.json b/codegen/sdk/aws-models/chime-sdk-voice.json index e4213865f69..2d4f1a4efb0 100644 --- a/codegen/sdk/aws-models/chime-sdk-voice.json +++ b/codegen/sdk/aws-models/chime-sdk-voice.json @@ -1490,17 +1490,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1514,17 +1503,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1538,17 +1516,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1562,17 +1529,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2390,6 +2346,12 @@ "traits": { "smithy.api#documentation": "

The connectors for use with Amazon Connect.

\n

The following options are available:

\n
    \n
  • \n

    \n CONNECT_CALL_TRANSFER_CONNECTOR - Enables enterprises to integrate\n Amazon Connect with other voice systems to directly transfer voice calls and\n metadata without using the public telephone network. They can use Amazon Connect\n telephony and Interactive Voice Response (IVR) with their existing voice systems to\n modernize the IVR experience of their existing contact center and their enterprise\n and branch voice systems. Additionally, enterprises migrating their contact center to\n Amazon Connect can start with Connect telephony and IVR for immediate\n modernization ahead of agent migration.

    \n
  • \n
  • \n

    \n CONNECT_ANALYTICS_CONNECTOR - Enables enterprises to integrate\n Amazon Connect with other voice systems for real-time and post-call analytics.\n They can use Amazon Connect Contact Lens with their existing voice systems to\n provides call recordings, conversational analytics (including contact transcript,\n sensitive data redaction, content categorization, theme detection, sentiment\n analysis, real-time alerts, and post-contact summary), and agent performance\n evaluations (including evaluation forms, automated evaluation, supervisor review)\n with a rich user experience to display, search and filter customer interactions, and\n programmatic access to data streams and the data lake. Additionally, enterprises\n migrating their contact center to Amazon Connect can start with Contact Lens\n analytics and performance insights ahead of agent migration.

    \n
  • \n
" } + }, + "NetworkType": { + "target": "com.amazonaws.chimesdkvoice#NetworkType", + "traits": { + "smithy.api#documentation": "

The type of network for the Voice Connector. Either IPv4 only or dual-stack (IPv4 and IPv6).

" + } } }, "traits": { @@ -6706,6 +6668,23 @@ "smithy.api#documentation": "

The configuration for a call analytics task.

" } }, + "com.amazonaws.chimesdkvoice#NetworkType": { + "type": "enum", + "members": { + "IPV4_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4_ONLY" + } + }, + "DUAL_STACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUAL_STACK" + } + } + } + }, "com.amazonaws.chimesdkvoice#NextTokenString": { "type": "string", "traits": { @@ -11135,6 +11114,12 @@ "traits": { "smithy.api#documentation": "

The connectors for use with Amazon Connect.

" } + }, + "NetworkType": { + "target": "com.amazonaws.chimesdkvoice#NetworkType", + "traits": { + "smithy.api#documentation": "

The type of network of the Voice Connector. Either IPv4 only or dual-stack (IPv4 and IPv6).

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/chime.json b/codegen/sdk/aws-models/chime.json index f525747cf01..f80b518bc03 100644 --- a/codegen/sdk/aws-models/chime.json +++ b/codegen/sdk/aws-models/chime.json @@ -6606,17 +6606,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6630,17 +6619,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -6654,17 +6632,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6678,17 +6645,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/cleanrooms.json b/codegen/sdk/aws-models/cleanrooms.json index 06c4af86e0c..d1066883a1e 100644 --- a/codegen/sdk/aws-models/cleanrooms.json +++ b/codegen/sdk/aws-models/cleanrooms.json @@ -591,17 +591,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -615,17 +604,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -639,17 +617,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -663,17 +630,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -749,6 +705,183 @@ } } }, + "com.amazonaws.cleanrooms#AccessBudget": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cleanrooms#BudgetedResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the access budget resource.

", + "smithy.api#required": {} + } + }, + "details": { + "target": "com.amazonaws.cleanrooms#AccessBudgetDetailsList", + "traits": { + "smithy.api#documentation": "

Detailed budget information including time bounds, remaining budget, and refresh settings.

", + "smithy.api#required": {} + } + }, + "aggregateRemainingBudget": { + "target": "com.amazonaws.cleanrooms#RemainingBudget", + "traits": { + "smithy.api#documentation": "

The total remaining budget across all budget parameters, showing the lower value between the per-period budget and lifetime budget for this access budget. For individual parameter budgets, see remainingBudget.

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

Controls and tracks usage limits for associated configured tables within a collaboration across queries and job. Supports both period-based budgets that can renew (daily, weekly, or monthly) and fixed lifetime budgets. Contains the resource ARN, remaining budget information, and up to two budget configurations (period-based and lifetime). By default, table usage is unlimited unless a budget is configured.

" + } + }, + "com.amazonaws.cleanrooms#AccessBudgetDetails": { + "type": "structure", + "members": { + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time for the access budget period.

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

The end time for the access budget period.

" + } + }, + "remainingBudget": { + "target": "com.amazonaws.cleanrooms#RemainingBudget", + "traits": { + "smithy.api#documentation": "

The remaining budget amount available for use within this access budget.

", + "smithy.api#required": {} + } + }, + "budget": { + "target": "com.amazonaws.cleanrooms#Budget", + "traits": { + "smithy.api#documentation": "

The total budget allocation amount for this access budget.

", + "smithy.api#required": {} + } + }, + "budgetType": { + "target": "com.amazonaws.cleanrooms#AccessBudgetType", + "traits": { + "smithy.api#documentation": "

Specifies the time period for limiting table usage in queries and jobs. For calendar-based periods, the budget can renew if auto refresh is enabled. For lifetime budgets, the limit applies to the total usage throughout the collaboration. Valid values are:

CALENDAR_DAY - Limit table usage per day.

CALENDAR_WEEK - Limit table usage per week.

CALENDAR_MONTH - Limit table usage per month.

LIFETIME - Limit total table usage for the collaboration duration.

", + "smithy.api#required": {} + } + }, + "autoRefresh": { + "target": "com.amazonaws.cleanrooms#AutoRefreshMode", + "traits": { + "smithy.api#documentation": "

Indicates whether the budget automatically refreshes for each time period specified in budgetType. Valid values are:

ENABLED - The budget refreshes automatically at the start of each period.

DISABLED - The budget must be refreshed manually.

NULL - The value is null when budgetType is set to LIFETIME.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Detailed information about an access budget including time bounds, budget allocation, and configuration settings.

" + } + }, + "com.amazonaws.cleanrooms#AccessBudgetDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AccessBudgetDetails" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.cleanrooms#AccessBudgetType": { + "type": "enum", + "members": { + "CALENDAR_DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALENDAR_DAY" + } + }, + "CALENDAR_MONTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALENDAR_MONTH" + } + }, + "CALENDAR_WEEK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALENDAR_WEEK" + } + }, + "LIFETIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIFETIME" + } + } + } + }, + "com.amazonaws.cleanrooms#AccessBudgetsPrivacyTemplateParametersInput": { + "type": "structure", + "members": { + "budgetParameters": { + "target": "com.amazonaws.cleanrooms#BudgetParameters", + "traits": { + "smithy.api#documentation": "

An array of budget parameters that define the access budget configuration for the privacy template.

", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.cleanrooms#BudgetedResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource associated with this privacy budget template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input parameters for privacy budget templates that support access budgets functionality, enabling enhanced budget management capabilities.

" + } + }, + "com.amazonaws.cleanrooms#AccessBudgetsPrivacyTemplateParametersOutput": { + "type": "structure", + "members": { + "budgetParameters": { + "target": "com.amazonaws.cleanrooms#BudgetParameters", + "traits": { + "smithy.api#documentation": "

An array of budget parameters returned from the access budget configuration.

", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.cleanrooms#BudgetedResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource associated with this privacy budget template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Output parameters for privacy budget templates with access budgets support, containing the configured budget information.

" + } + }, + "com.amazonaws.cleanrooms#AccessBudgetsPrivacyTemplateUpdateParameters": { + "type": "structure", + "members": { + "budgetParameters": { + "target": "com.amazonaws.cleanrooms#BudgetParameters", + "traits": { + "smithy.api#documentation": "

Updated array of budget parameters for the access budget configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Update parameters for privacy budget templates with access budgets functionality, allowing modification of existing budget configurations.

" + } + }, "com.amazonaws.cleanrooms#AccessDeniedException": { "type": "structure", "members": { @@ -1555,6 +1688,12 @@ "traits": { "smithy.api#documentation": "

Information about the validations performed on the analysis template.

" } + }, + "errorMessageConfiguration": { + "target": "com.amazonaws.cleanrooms#ErrorMessageConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to DETAILED, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.

" + } } }, "traits": { @@ -2002,6 +2141,43 @@ "smithy.api#pattern": "^([a-zA-Z0-9._-])*$" } }, + "com.amazonaws.cleanrooms#AutoApprovedChangeType": { + "type": "enum", + "members": { + "ADD_MEMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD_MEMBER" + } + } + } + }, + "com.amazonaws.cleanrooms#AutoApprovedChangeTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AutoApprovedChangeType" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.cleanrooms#AutoRefreshMode": { + "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.cleanrooms#BatchGetCollaborationAnalysisTemplate": { "type": "operation", "input": { @@ -2393,6 +2569,224 @@ "smithy.api#documentation": "

Information related to the utilization of resources that have been billed or charged for in a given context, such as a protected query.

" } }, + "com.amazonaws.cleanrooms#Budget": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1000000 + } + } + }, + "com.amazonaws.cleanrooms#BudgetParameter": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cleanrooms#AccessBudgetType", + "traits": { + "smithy.api#documentation": "

The type of budget parameter being configured.

", + "smithy.api#required": {} + } + }, + "budget": { + "target": "com.amazonaws.cleanrooms#Budget", + "traits": { + "smithy.api#documentation": "

The budget allocation amount for this specific parameter.

", + "smithy.api#required": {} + } + }, + "autoRefresh": { + "target": "com.amazonaws.cleanrooms#AutoRefreshMode", + "traits": { + "smithy.api#documentation": "

Whether this individual budget parameter automatically refreshes when the budget period resets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Individual budget parameter configuration that defines specific budget allocation settings for access budgets.

" + } + }, + "com.amazonaws.cleanrooms#BudgetParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#BudgetParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.cleanrooms#BudgetedResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 200 + }, + "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/configuredtableassociation/[\\d\\w-]+$" + } + }, + "com.amazonaws.cleanrooms#Change": { + "type": "structure", + "members": { + "specificationType": { + "target": "com.amazonaws.cleanrooms#ChangeSpecificationType", + "traits": { + "smithy.api#documentation": "

The type of specification for this change.

", + "smithy.api#required": {} + } + }, + "specification": { + "target": "com.amazonaws.cleanrooms#ChangeSpecification", + "traits": { + "smithy.api#documentation": "

The specification details for this change.

", + "smithy.api#required": {} + } + }, + "types": { + "target": "com.amazonaws.cleanrooms#ChangeTypeList", + "traits": { + "smithy.api#documentation": "

The list of change types that were applied.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a single change within a collaboration change request, containing the change identifier and specification.

" + } + }, + "com.amazonaws.cleanrooms#ChangeInput": { + "type": "structure", + "members": { + "specificationType": { + "target": "com.amazonaws.cleanrooms#ChangeSpecificationType", + "traits": { + "smithy.api#documentation": "

The type of specification for the change. Currently supports MEMBER for member-related changes.

", + "smithy.api#required": {} + } + }, + "specification": { + "target": "com.amazonaws.cleanrooms#ChangeSpecification", + "traits": { + "smithy.api#documentation": "

The specification details for the change. The structure depends on the specification type.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a change to apply to a collaboration.

" + } + }, + "com.amazonaws.cleanrooms#ChangeInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#ChangeInput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.cleanrooms#ChangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#Change" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.cleanrooms#ChangeRequestStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPROVED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENIED" + } + }, + "COMMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMMITTED" + } + } + } + }, + "com.amazonaws.cleanrooms#ChangeSpecification": { + "type": "union", + "members": { + "member": { + "target": "com.amazonaws.cleanrooms#MemberChangeSpecification", + "traits": { + "smithy.api#documentation": "

The member change specification when the change type is MEMBER.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A union that contains the specification details for different types of changes.

" + } + }, + "com.amazonaws.cleanrooms#ChangeSpecificationType": { + "type": "enum", + "members": { + "MEMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEMBER" + } + } + } + }, + "com.amazonaws.cleanrooms#ChangeType": { + "type": "enum", + "members": { + "ADD_MEMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD_MEMBER" + } + } + } + }, + "com.amazonaws.cleanrooms#ChangeTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#ChangeType" + }, + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.cleanrooms#CleanroomsArn": { "type": "string", "traits": { @@ -2504,6 +2898,12 @@ "traits": { "smithy.api#documentation": "

The analytics engine for the collaboration.

After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

" } + }, + "autoApprovedChangeTypes": { + "target": "com.amazonaws.cleanrooms#AutoApprovedChangeTypeList", + "traits": { + "smithy.api#documentation": "

The types of change requests that are automatically approved for this collaboration.

" + } } }, "traits": { @@ -2583,136 +2983,274 @@ "smithy.api#required": {} } }, - "format": { - "target": "com.amazonaws.cleanrooms#AnalysisFormat", + "format": { + "target": "com.amazonaws.cleanrooms#AnalysisFormat", + "traits": { + "smithy.api#documentation": "

The format of the analysis template in the collaboration.

", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.cleanrooms#AnalysisSource", + "traits": { + "smithy.api#documentation": "

The source of the analysis template within a collaboration.

" + } + }, + "sourceMetadata": { + "target": "com.amazonaws.cleanrooms#AnalysisSourceMetadata", + "traits": { + "smithy.api#documentation": "

The source metadata for the collaboration analysis template.

" + } + }, + "analysisParameters": { + "target": "com.amazonaws.cleanrooms#AnalysisParameterList", + "traits": { + "smithy.api#documentation": "

The analysis parameters that have been specified in the analysis template.

" + } + }, + "validations": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateValidationStatusDetailList", + "traits": { + "smithy.api#documentation": "

The validations that were performed.

" + } + }, + "errorMessageConfiguration": { + "target": "com.amazonaws.cleanrooms#ErrorMessageConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to DETAILED, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The analysis template within a collaboration.

" + } + }, + "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis template.

", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the summary of the analysis template in a collaboration was created.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the analysis template.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#ResourceAlias", + "traits": { + "smithy.api#documentation": "

The name of the analysis template.

", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the summary of the analysis template in the collaboration was last updated.

", + "smithy.api#required": {} + } + }, + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "

The unique ARN for the analysis template’s associated collaboration.

", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#required": {} + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the analysis template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata of the analysis template within a collaboration.

" + } + }, + "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummary" + } + }, + "com.amazonaws.cleanrooms#CollaborationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 100 + }, + "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:collaboration/[\\d\\w-]+$" + } + }, + "com.amazonaws.cleanrooms#CollaborationChangeRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

The unique identifier for the change request.

", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

The unique identifier for the collaboration being modified.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The format of the analysis template in the collaboration.

", + "smithy.api#documentation": "

The time when the change request was created.

", "smithy.api#required": {} } }, - "source": { - "target": "com.amazonaws.cleanrooms#AnalysisSource", + "updateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The source of the analysis template within a collaboration.

" + "smithy.api#documentation": "

The time when the change request was last updated.

", + "smithy.api#required": {} } }, - "sourceMetadata": { - "target": "com.amazonaws.cleanrooms#AnalysisSourceMetadata", + "status": { + "target": "com.amazonaws.cleanrooms#ChangeRequestStatus", "traits": { - "smithy.api#documentation": "

The source metadata for the collaboration analysis template.

" + "smithy.api#documentation": "

The current status of the change request. Valid values are PENDING, APPROVED, DENIED, COMMITTED, and CANCELLED.

", + "smithy.api#required": {} } }, - "analysisParameters": { - "target": "com.amazonaws.cleanrooms#AnalysisParameterList", + "isAutoApproved": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

The analysis parameters that have been specified in the analysis template.

" + "smithy.api#documentation": "

Whether the change request was automatically approved based on the collaboration's auto-approval settings.

", + "smithy.api#required": {} } }, - "validations": { - "target": "com.amazonaws.cleanrooms#AnalysisTemplateValidationStatusDetailList", + "changes": { + "target": "com.amazonaws.cleanrooms#ChangeList", "traits": { - "smithy.api#documentation": "

The validations that were performed.

" + "smithy.api#documentation": "

The list of changes specified in this change request.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The analysis template within a collaboration.

" + "smithy.api#documentation": "

Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created.

" } }, - "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate" - }, + "com.amazonaws.cleanrooms#CollaborationChangeRequestIdentifier": { + "type": "string", "traits": { "smithy.api#length": { - "max": 10 - } + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, - "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummary": { + "com.amazonaws.cleanrooms#CollaborationChangeRequestSummary": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis template.

", - "smithy.api#required": {} - } - }, - "createTime": { - "target": "smithy.api#Timestamp", + "id": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The time that the summary of the analysis template in a collaboration was created.

", + "smithy.api#documentation": "

The unique identifier for the change request.

", "smithy.api#required": {} } }, - "id": { - "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The identifier of the analysis template.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The unique identifier for the collaboration.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" } }, - "name": { - "target": "com.amazonaws.cleanrooms#ResourceAlias", + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the analysis template.

", + "smithy.api#documentation": "

The time when the change request was created.

", "smithy.api#required": {} } }, "updateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time that the summary of the analysis template in the collaboration was last updated.

", + "smithy.api#documentation": "

The time when the change request was last updated.

", "smithy.api#required": {} } }, - "collaborationArn": { - "target": "com.amazonaws.cleanrooms#CollaborationArn", + "status": { + "target": "com.amazonaws.cleanrooms#ChangeRequestStatus", "traits": { - "smithy.api#documentation": "

The unique ARN for the analysis template’s associated collaboration.

", + "smithy.api#documentation": "

The current status of the change request.

", "smithy.api#required": {} } }, - "collaborationId": { - "target": "com.amazonaws.cleanrooms#UUID", + "isAutoApproved": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#documentation": "

Whether the change request was automatically approved.

", "smithy.api#required": {} } }, - "creatorAccountId": { - "target": "com.amazonaws.cleanrooms#AccountId", + "changes": { + "target": "com.amazonaws.cleanrooms#ChangeList", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

Summary of the changes in this change request.

", "smithy.api#required": {} } - }, - "description": { - "target": "com.amazonaws.cleanrooms#ResourceDescription", - "traits": { - "smithy.api#documentation": "

The description of the analysis template.

" - } } }, "traits": { - "smithy.api#documentation": "

The metadata of the analysis template within a collaboration.

" + "smithy.api#documentation": "

Summary information about a collaboration change request.

" } }, - "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummaryList": { + "com.amazonaws.cleanrooms#CollaborationChangeRequestSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummary" - } - }, - "com.amazonaws.cleanrooms#CollaborationArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 100 - }, - "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:collaboration/[\\d\\w-]+$" + "target": "com.amazonaws.cleanrooms#CollaborationChangeRequestSummary" } }, "com.amazonaws.cleanrooms#CollaborationConfiguredAudienceModelAssociation": { @@ -3375,12 +3913,18 @@ { "target": "com.amazonaws.cleanrooms#BatchGetSchemaAnalysisRule" }, + { + "target": "com.amazonaws.cleanrooms#CreateCollaborationChangeRequest" + }, { "target": "com.amazonaws.cleanrooms#DeleteMember" }, { "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplate" }, + { + "target": "com.amazonaws.cleanrooms#GetCollaborationChangeRequest" + }, { "target": "com.amazonaws.cleanrooms#GetCollaborationConfiguredAudienceModelAssociation" }, @@ -3399,6 +3943,9 @@ { "target": "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplates" }, + { + "target": "com.amazonaws.cleanrooms#ListCollaborationChangeRequests" + }, { "target": "com.amazonaws.cleanrooms#ListCollaborationConfiguredAudienceModelAssociations" }, @@ -4982,6 +5529,12 @@ }, "schema": { "target": "com.amazonaws.cleanrooms#AnalysisSchema" + }, + "errorMessageConfiguration": { + "target": "com.amazonaws.cleanrooms#ErrorMessageConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to DETAILED, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.

" + } } } }, @@ -5032,6 +5585,84 @@ } } }, + "com.amazonaws.cleanrooms#CreateCollaborationChangeRequest": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreateCollaborationChangeRequestInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreateCollaborationChangeRequestOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new change request to modify an existing collaboration. This enables post-creation modifications to collaborations through a structured API-driven approach.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/collaborations/{collaborationIdentifier}/changeRequests" + } + } + }, + "com.amazonaws.cleanrooms#CreateCollaborationChangeRequestInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the collaboration that the change request is made against.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "changes": { + "target": "com.amazonaws.cleanrooms#ChangeInputList", + "traits": { + "smithy.api#documentation": "

The list of changes to apply to the collaboration. Each change specifies the type of modification and the details of what should be changed.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#CreateCollaborationChangeRequestOutput": { + "type": "structure", + "members": { + "collaborationChangeRequest": { + "target": "com.amazonaws.cleanrooms#CollaborationChangeRequest", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cleanrooms#CreateCollaborationInput": { "type": "structure", "members": { @@ -5112,6 +5743,12 @@ "traits": { "smithy.api#documentation": "

The analytics engine.

After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

" } + }, + "autoApprovedChangeRequestTypes": { + "target": "com.amazonaws.cleanrooms#AutoApprovedChangeTypeList", + "traits": { + "smithy.api#documentation": "

The types of change requests that are automatically approved for this collaboration.

" + } } } }, @@ -5952,6 +6589,9 @@ { "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" }, + { + "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.cleanrooms#ThrottlingException" }, @@ -5984,8 +6624,7 @@ "autoRefresh": { "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateAutoRefresh", "traits": { - "smithy.api#documentation": "

How often the privacy budget refreshes.

If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

", - "smithy.api#required": {} + "smithy.api#documentation": "

How often the privacy budget refreshes.

If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

" } }, "privacyBudgetType": { @@ -7259,6 +7898,32 @@ } } }, + "com.amazonaws.cleanrooms#ErrorMessageConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cleanrooms#ErrorMessageType", + "traits": { + "smithy.api#documentation": "

The level of detail for error messages returned by the PySpark job. When set to DETAILED, error messages include more information to help troubleshoot issues with your PySpark job.

Because this setting may expose sensitive data, it is recommended for development and testing environments.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that defines the level of detail included in error messages returned by PySpark jobs. This configuration allows you to control the verbosity of error messages to help with troubleshooting PySpark jobs while maintaining appropriate security controls.

" + } + }, + "com.amazonaws.cleanrooms#ErrorMessageType": { + "type": "enum", + "members": { + "DETAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DETAILED" + } + } + } + }, "com.amazonaws.cleanrooms#FilterableMemberStatus": { "type": "string", "traits": { @@ -7388,13 +8053,84 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplate": { + "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get an analysis template within a collaboration", + "smithy.api#documentation": "

Retrieves an analysis template within a collaboration.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/analysistemplates/{analysisTemplateArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "analysisTemplateArn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateArn" + } + } + } + }, + "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateOutput": { + "type": "structure", + "members": { + "collaborationAnalysisTemplate": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate", + "traits": { + "smithy.api#documentation": "

The analysis template within a collaboration.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#GetCollaborationChangeRequest": { "type": "operation", "input": { - "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateInput" + "target": "com.amazonaws.cleanrooms#GetCollaborationChangeRequestInput" }, "output": { - "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateOutput" + "target": "com.amazonaws.cleanrooms#GetCollaborationChangeRequestOutput" }, "errors": [ { @@ -7414,49 +8150,53 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to get an analysis template within a collaboration", - "smithy.api#documentation": "

Retrieves an analysis template within a collaboration.

", + "smithy.api#documentation": "

Retrieves detailed information about a specific collaboration change request.

", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/collaborations/{collaborationIdentifier}/analysistemplates/{analysisTemplateArn}" + "uri": "/collaborations/{collaborationIdentifier}/changeRequests/{changeRequestIdentifier}" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateInput": { + "com.amazonaws.cleanrooms#GetCollaborationChangeRequestInput": { "type": "structure", "members": { "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#documentation": "

The identifier of the collaboration that the change request is made against.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" } }, - "analysisTemplateArn": { - "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "changeRequestIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationChangeRequestIdentifier", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

", + "smithy.api#documentation": "

A unique identifier for the change request to retrieve.

", "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "AnalysisTemplateArn" + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateOutput": { + "com.amazonaws.cleanrooms#GetCollaborationChangeRequestOutput": { "type": "structure", "members": { - "collaborationAnalysisTemplate": { - "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate", + "collaborationChangeRequest": { + "target": "com.amazonaws.cleanrooms#CollaborationChangeRequest", "traits": { - "smithy.api#documentation": "

The analysis template within a collaboration.

", + "smithy.api#documentation": "

The collaboration change request that was requested.

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cleanrooms#GetCollaborationConfiguredAudienceModelAssociation": { @@ -9457,6 +10197,29 @@ "smithy.api#documentation": "

An object representing the collaboration member's payment responsibilities set by the collaboration creator for query and job compute costs.

" } }, + "com.amazonaws.cleanrooms#JobType": { + "type": "enum", + "members": { + "BATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BATCH" + } + }, + "INCREMENTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREMENTAL" + } + }, + "DELETE_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_ONLY" + } + } + } + }, "com.amazonaws.cleanrooms#JoinOperator": { "type": "string", "traits": { @@ -9683,6 +10446,106 @@ } } }, + "com.amazonaws.cleanrooms#ListCollaborationChangeRequests": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#ListCollaborationChangeRequestsInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#ListCollaborationChangeRequestsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all change requests for a collaboration with pagination support. Returns change requests sorted by creation time.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/changeRequests" + }, + "smithy.api#paginated": { + "items": "collaborationChangeRequestSummaries", + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#ListCollaborationChangeRequestsInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the collaboration that the change request is made against.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "status": { + "target": "com.amazonaws.cleanrooms#ChangeRequestStatus", + "traits": { + "smithy.api#documentation": "

A filter to only return change requests with the specified status.

", + "smithy.api#httpQuery": "status" + } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results that are returned for an API request call.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanrooms#ListCollaborationChangeRequestsOutput": { + "type": "structure", + "members": { + "collaborationChangeRequestSummaries": { + "target": "com.amazonaws.cleanrooms#CollaborationChangeRequestSummaryList", + "traits": { + "smithy.api#documentation": "

The list of collaboration change request summaries.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cleanrooms#ListCollaborationConfiguredAudienceModelAssociations": { "type": "operation", "input": { @@ -10040,6 +10903,13 @@ "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } + }, + "accessBudgetResourceArn": { + "target": "com.amazonaws.cleanrooms#BudgetedResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Configured Table Association (ConfiguredTableAssociation) used to filter privacy budgets.

", + "smithy.api#httpQuery": "accessBudgetResourceArn" + } } }, "traits": { @@ -10916,6 +11786,13 @@ "smithy.api#documentation": "

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

", "smithy.api#httpQuery": "maxResults" } + }, + "accessBudgetResourceArn": { + "target": "com.amazonaws.cleanrooms#BudgetedResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the access budget resource to filter privacy budgets by.

", + "smithy.api#httpQuery": "accessBudgetResourceArn" + } } }, "traits": { @@ -11364,6 +12241,34 @@ } } }, + "com.amazonaws.cleanrooms#MemberChangeSpecification": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the member to add to the collaboration.

", + "smithy.api#required": {} + } + }, + "memberAbilities": { + "target": "com.amazonaws.cleanrooms#MemberAbilities", + "traits": { + "smithy.api#documentation": "

The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.

The following values are currently not supported: CAN_QUERY, CAN_RECEIVE_RESULTS, and CAN_RUN_JOB.

Set the value of memberAbilities to [] to allow a member to contribute data.

", + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.cleanrooms#DisplayName", + "traits": { + "smithy.api#documentation": "

Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies changes to collaboration membership, including adding new members with their abilities and display names.

" + } + }, "com.amazonaws.cleanrooms#MemberList": { "type": "list", "member": { @@ -12390,6 +13295,12 @@ "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" } + }, + "jobType": { + "target": "com.amazonaws.cleanrooms#JobType", + "traits": { + "smithy.api#documentation": "

The job type of the rule-based ID mapping job. Valid values include:

INCREMENTAL: Processes only new or changed data since the last job run. This is the default job type if the ID mapping workflow was created in Entity Resolution with incrementalRunConfig specified.

BATCH: Processes all data from the input source, regardless of previous job runs. This is the default job type if the ID mapping workflow was created in Entity Resolution but incrementalRunConfig wasn't specified.

DELETE_ONLY: Processes only deletion requests from BatchDeleteUniqueId, which is set in Entity Resolution.

For more information about incrementalRunConfig and BatchDeleteUniqueId, see the Entity Resolution API Reference.

" + } } }, "traits": { @@ -12507,6 +13418,12 @@ "traits": { "smithy.api#documentation": "

An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.

" } + }, + "accessBudget": { + "target": "com.amazonaws.cleanrooms#AccessBudget", + "traits": { + "smithy.api#documentation": "

Access budget information associated with this privacy budget.

" + } } }, "traits": { @@ -12733,6 +13650,12 @@ "traits": { "smithy.api#documentation": "

An object that specifies the epsilon and noise parameters.

" } + }, + "accessBudget": { + "target": "com.amazonaws.cleanrooms#AccessBudgetsPrivacyTemplateParametersInput", + "traits": { + "smithy.api#documentation": "

Access budget configuration for the privacy budget template input, enabling integration with access budget functionality.

" + } } }, "traits": { @@ -12747,6 +13670,12 @@ "traits": { "smithy.api#documentation": "

The epsilon and noise parameters.

" } + }, + "accessBudget": { + "target": "com.amazonaws.cleanrooms#AccessBudgetsPrivacyTemplateParametersOutput", + "traits": { + "smithy.api#documentation": "

Access budget configuration returned from the privacy budget template, containing the configured access budget settings.

" + } } }, "traits": { @@ -12874,6 +13803,12 @@ "traits": { "smithy.api#documentation": "

An object that specifies the new values for the epsilon and noise parameters.

" } + }, + "accessBudget": { + "target": "com.amazonaws.cleanrooms#AccessBudgetsPrivacyTemplateUpdateParameters", + "traits": { + "smithy.api#documentation": "

The new access budget configuration that completely replaces the existing access budget settings in the privacy budget template.

" + } } }, "traits": { @@ -12888,6 +13823,12 @@ "traits": { "smithy.api#enumValue": "DIFFERENTIAL_PRIVACY" } + }, + "ACCESS_BUDGET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_BUDGET" + } } } }, @@ -12973,6 +13914,12 @@ "traits": { "smithy.api#documentation": "

The error from the protected job.

" } + }, + "computeConfiguration": { + "target": "com.amazonaws.cleanrooms#ProtectedJobComputeConfiguration", + "traits": { + "smithy.api#documentation": "

The compute configuration for the protected job.

" + } } }, "traits": { @@ -12990,6 +13937,20 @@ } } }, + "com.amazonaws.cleanrooms#ProtectedJobComputeConfiguration": { + "type": "union", + "members": { + "worker": { + "target": "com.amazonaws.cleanrooms#ProtectedJobWorkerComputeConfiguration", + "traits": { + "smithy.api#documentation": "

The worker configuration for the compute environment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the compute resources for a PySpark job.

" + } + }, "com.amazonaws.cleanrooms#ProtectedJobConfigurationDetails": { "type": "union", "members": { @@ -13444,6 +14405,49 @@ } } }, + "com.amazonaws.cleanrooms#ProtectedJobWorkerComputeConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cleanrooms#ProtectedJobWorkerComputeType", + "traits": { + "smithy.api#documentation": "

The worker compute configuration type.

", + "smithy.api#required": {} + } + }, + "number": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of workers for a PySpark job.

", + "smithy.api#range": { + "min": 4, + "max": 128 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the compute resources for a PySpark job.

" + } + }, + "com.amazonaws.cleanrooms#ProtectedJobWorkerComputeType": { + "type": "enum", + "members": { + "CR1X": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CR.1X" + } + }, + "CR4X": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CR.4X" + } + } + } + }, "com.amazonaws.cleanrooms#ProtectedQuery": { "type": "structure", "members": { @@ -14036,6 +15040,14 @@ "target": "com.amazonaws.cleanrooms#ReceiverConfiguration" } }, + "com.amazonaws.cleanrooms#RemainingBudget": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.cleanrooms#ResourceAlias": { "type": "string", "traits": { @@ -14369,6 +15381,12 @@ "smithy.api#required": {} } }, + "resourceArn": { + "target": "com.amazonaws.cleanrooms#SchemaResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the schema resource.

" + } + }, "schemaTypeProperties": { "target": "com.amazonaws.cleanrooms#SchemaTypeProperties", "traits": { @@ -14453,6 +15471,15 @@ } } }, + "com.amazonaws.cleanrooms#SchemaResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 200 + }, + "smithy.api#pattern": "^arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership\\/[\\d\\w-]+\\/(configuredtableassociation|idmappingtable)\\/[\\d\\w-]+$" + } + }, "com.amazonaws.cleanrooms#SchemaStatus": { "type": "enum", "members": { @@ -14682,6 +15709,12 @@ "smithy.api#documentation": "

The analysis method for the associated schema.

DIRECT_QUERY allows SQL queries to be run directly on this table.

DIRECT_JOB allows PySpark jobs to be run directly on this table.

MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

" } }, + "resourceArn": { + "target": "com.amazonaws.cleanrooms#SchemaResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the schema summary resource.

" + } + }, "selectedAnalysisMethods": { "target": "com.amazonaws.cleanrooms#SelectedAnalysisMethods", "traits": { @@ -15001,6 +16034,12 @@ "traits": { "smithy.api#documentation": "

The details needed to write the job results.

" } + }, + "computeConfiguration": { + "target": "com.amazonaws.cleanrooms#ProtectedJobComputeConfiguration", + "traits": { + "smithy.api#documentation": "

The compute configuration for the protected job.

" + } } }, "traits": { @@ -16600,7 +17639,7 @@ "number": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of workers.

", + "smithy.api#documentation": "

The number of workers.

SQL queries support a minimum value of 2 and a maximum value of 400.

PySpark jobs support a minimum value of 4 and a maximum value of 128.

", "smithy.api#range": { "min": 2, "max": 400 diff --git a/codegen/sdk/aws-models/cleanroomsml.json b/codegen/sdk/aws-models/cleanroomsml.json index 0c2e62ef2b9..822bd343e45 100644 --- a/codegen/sdk/aws-models/cleanroomsml.json +++ b/codegen/sdk/aws-models/cleanroomsml.json @@ -97,7 +97,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "

Welcome to the Amazon Web Services Clean Rooms ML API Reference.

Amazon Web Services Clean Rooms ML provides a privacy-enhancing method for two parties to identify similar users in their data without the need to share their data with each other. The first party brings the training data to Clean Rooms so that they can create and configure an audience model (lookalike model) and associate it with a collaboration. The second party then brings their seed data to Clean Rooms and generates an audience (lookalike segment) that resembles the training data.

To learn more about Amazon Web Services Clean Rooms ML concepts, procedures, and best practices, see the Clean Rooms User Guide.

To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the Clean Rooms SQL Reference.

", + "smithy.api#documentation": "

Welcome to the Amazon Web Services Clean Rooms ML API Reference.

Amazon Web Services Clean Rooms ML provides a privacy-enhancing method for two parties to identify similar users in their data without the need to share their data with each other. The first party brings the training data to Clean Rooms so that they can create and configure an audience model (lookalike model) and associate it with a collaboration. The second party then brings their seed data to Clean Rooms and generates an audience (lookalike segment) that resembles the training data.

To learn more about Amazon Web Services Clean Rooms ML concepts, procedures, and best practices, see the Clean Rooms User Guide.

To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the Clean Rooms SQL Reference.

", "smithy.api#title": "AWS Clean Rooms ML", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -607,17 +607,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -631,17 +620,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -655,17 +633,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -679,17 +646,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -765,6 +721,138 @@ } } }, + "com.amazonaws.cleanroomsml#AccessBudget": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cleanroomsml#BudgetedResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that this access budget applies to.

", + "smithy.api#required": {} + } + }, + "details": { + "target": "com.amazonaws.cleanroomsml#AccessBudgetDetailsList", + "traits": { + "smithy.api#documentation": "

A list of budget details for this resource. Contains active budget periods that apply to the resource.

", + "smithy.api#required": {} + } + }, + "aggregateRemainingBudget": { + "target": "com.amazonaws.cleanroomsml#Budget", + "traits": { + "smithy.api#documentation": "

The total remaining budget across all active budget periods for this resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An access budget that defines consumption limits for a specific resource within defined time periods.

" + } + }, + "com.amazonaws.cleanroomsml#AccessBudgetDetails": { + "type": "structure", + "members": { + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of this budget period.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time of this budget period. If not specified, the budget period continues indefinitely.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "remainingBudget": { + "target": "com.amazonaws.cleanroomsml#Budget", + "traits": { + "smithy.api#documentation": "

The amount of budget remaining in this period.

", + "smithy.api#required": {} + } + }, + "budget": { + "target": "com.amazonaws.cleanroomsml#Budget", + "traits": { + "smithy.api#documentation": "

The total budget amount allocated for this period.

", + "smithy.api#required": {} + } + }, + "budgetType": { + "target": "com.amazonaws.cleanroomsml#AccessBudgetType", + "traits": { + "smithy.api#documentation": "

The type of budget period. Calendar-based types reset automatically at regular intervals, while LIFETIME budgets never reset.

", + "smithy.api#required": {} + } + }, + "autoRefresh": { + "target": "com.amazonaws.cleanroomsml#AutoRefreshMode", + "traits": { + "smithy.api#documentation": "

Specifies whether this budget automatically refreshes when the current period ends.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The detailed information for a specific budget period, including time boundaries and budget amounts.

" + } + }, + "com.amazonaws.cleanroomsml#AccessBudgetDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#AccessBudgetDetails" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.cleanroomsml#AccessBudgetType": { + "type": "enum", + "members": { + "CALENDAR_DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALENDAR_DAY" + } + }, + "CALENDAR_MONTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALENDAR_MONTH" + } + }, + "CALENDAR_WEEK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALENDAR_WEEK" + } + }, + "LIFETIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIFETIME" + } + } + } + }, + "com.amazonaws.cleanroomsml#AccessBudgets": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#AccessBudget" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.cleanroomsml#AccessDeniedException": { "type": "structure", "members": { @@ -1425,6 +1513,40 @@ } } }, + "com.amazonaws.cleanroomsml#AutoRefreshMode": { + "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.cleanroomsml#Budget": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cleanroomsml#BudgetedResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 200 + }, + "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/configuredtableassociation/[\\d\\w-]+$" + } + }, "com.amazonaws.cleanroomsml#CancelTrainedModel": { "type": "operation", "input": { @@ -3390,6 +3512,44 @@ "smithy.api#output": {} } }, + "com.amazonaws.cleanroomsml#CustomDataIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\_\\#\\=\\@/\\;\\,\\-\\ \\^\\$\\?\\[\\]\\{\\}\\|\\\\\\*\\+\\.\\(\\)]+$" + } + }, + "com.amazonaws.cleanroomsml#CustomDataIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#CustomDataIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.cleanroomsml#CustomEntityConfig": { + "type": "structure", + "members": { + "customDataIdentifiers": { + "target": "com.amazonaws.cleanroomsml#CustomDataIdentifierList", + "traits": { + "smithy.api#documentation": "

Defines data identifiers for the custom entity configuration. Provide this only if CUSTOM redaction is configured.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for defining custom patterns to be redacted from logs and error messages. This is for the CUSTOM config under entitiesToRedact. Both CustomEntityConfig and entitiesToRedact need to be present or not present.

" + } + }, "com.amazonaws.cleanroomsml#DataSource": { "type": "structure", "members": { @@ -4006,6 +4166,41 @@ "smithy.api#documentation": "

The Amazon S3 location where the exported model artifacts are stored.

" } }, + "com.amazonaws.cleanroomsml#EntityType": { + "type": "enum", + "members": { + "ALL_PERSONALLY_IDENTIFIABLE_INFORMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_PERSONALLY_IDENTIFIABLE_INFORMATION" + } + }, + "NUMBERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMBERS" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.cleanroomsml#EntityTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#EntityType" + }, + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.cleanroomsml#Environment": { "type": "map", "key": { @@ -4511,29 +4706,6 @@ "com.amazonaws.cleanroomsml#GetCollaborationMLInputChannelResponse": { "type": "structure", "members": { - "createTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the ML input channel was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "updateTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The most recent time at which the ML input channel was updated.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "creatorAccountId": { - "target": "com.amazonaws.cleanroomsml#AccountId", - "traits": { - "smithy.api#documentation": "

The account ID of the member who created the ML input channel.

", - "smithy.api#required": {} - } - }, "membershipIdentifier": { "target": "com.amazonaws.cleanroomsml#UUID", "traits": { @@ -4604,11 +4776,40 @@ } } }, + "privacyBudgets": { + "target": "com.amazonaws.cleanroomsml#PrivacyBudgets", + "traits": { + "smithy.api#documentation": "

Returns the privacy budgets that control access to this Clean Rooms ML input channel. Use these budgets to monitor and limit resource consumption over specified time periods.

" + } + }, "description": { "target": "com.amazonaws.cleanroomsml#ResourceDescription", "traits": { "smithy.api#documentation": "

The description of the ML input channel.

" } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the ML input channel was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The most recent time at which the ML input channel was updated.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanroomsml#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the member who created the ML input channel.

", + "smithy.api#required": {} + } } }, "traits": { @@ -5433,22 +5634,6 @@ "com.amazonaws.cleanroomsml#GetMLInputChannelResponse": { "type": "structure", "members": { - "createTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the ML input channel was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "updateTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The most recent time at which the ML input channel was updated.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, "membershipIdentifier": { "target": "com.amazonaws.cleanroomsml#UUID", "traits": { @@ -5463,19 +5648,6 @@ "smithy.api#required": {} } }, - "inputChannel": { - "target": "com.amazonaws.cleanroomsml#InputChannel", - "traits": { - "smithy.api#documentation": "

The input channel that was used to create the ML input channel.

", - "smithy.api#required": {} - } - }, - "protectedQueryIdentifier": { - "target": "com.amazonaws.cleanroomsml#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the protected query that was used to create the ML input channel.

" - } - }, "mlInputChannelArn": { "target": "com.amazonaws.cleanroomsml#MLInputChannelArn", "traits": { @@ -5532,6 +5704,47 @@ } } }, + "privacyBudgets": { + "target": "com.amazonaws.cleanroomsml#PrivacyBudgets", + "traits": { + "smithy.api#documentation": "

Returns the privacy budgets that control access to this Clean Rooms ML input channel. Use these budgets to monitor and limit resource consumption over specified time periods.

" + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the ML input channel.

" + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the ML input channel was created.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The most recent time at which the ML input channel was updated.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "inputChannel": { + "target": "com.amazonaws.cleanroomsml#InputChannel", + "traits": { + "smithy.api#documentation": "

The input channel that was used to create the ML input channel.

", + "smithy.api#required": {} + } + }, + "protectedQueryIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the protected query that was used to create the ML input channel.

" + } + }, "numberOfFiles": { "target": "smithy.api#Double", "traits": { @@ -5552,12 +5765,6 @@ } } }, - "description": { - "target": "com.amazonaws.cleanroomsml#ResourceDescription", - "traits": { - "smithy.api#documentation": "

The description of the ML input channel.

" - } - }, "kmsKeyArn": { "target": "com.amazonaws.cleanroomsml#KmsKeyArn", "traits": { @@ -6484,12 +6691,6 @@ "smithy.api#enumValue": "ml.m5.large" } }, - "ML_P3_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.16xlarge" - } - }, "ML_M7I_48XLARGE": { "target": "smithy.api#Unit", "traits": { @@ -6772,12 +6973,6 @@ "smithy.api#enumValue": "ml.m7i.4xlarge" } }, - "ML_P3_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.2xlarge" - } - }, "ML_R6I_32XLARGE": { "target": "smithy.api#Unit", "traits": { @@ -6928,16 +7123,40 @@ "smithy.api#enumValue": "ml.m6i.32xlarge" } }, - "ML_P3_8XLARGE": { + "ML_M4_4XLARGE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ml.p3.8xlarge" + "smithy.api#enumValue": "ml.m4.4xlarge" } }, - "ML_M4_4XLARGE": { + "ML_P3_16XLARGE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ml.m4.4xlarge" + "smithy.api#deprecated": { + "message": "P3 instance types are deprecated. Use P4 or newer instance types for better performance and cost efficiency.", + "since": "2025-09-02" + }, + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#deprecated": { + "message": "P3 instance types are deprecated. Use P4 or newer instance types for better performance and cost efficiency.", + "since": "2025-09-02" + }, + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#deprecated": { + "message": "P3 instance types are deprecated. Use P4 or newer instance types for better performance and cost efficiency.", + "since": "2025-09-02" + }, + "smithy.api#enumValue": "ml.p3.8xlarge" } } } @@ -7201,30 +7420,6 @@ "smithy.api#enumValue": "ml.p2.16xlarge" } }, - "ML_P3_2XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.2xlarge" - } - }, - "ML_P3_8XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.8xlarge" - } - }, - "ML_P3_16XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3.16xlarge" - } - }, - "ML_P3DN_24XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p3dn.24xlarge" - } - }, "ML_P4D_24XLARGE": { "target": "smithy.api#Unit", "traits": { @@ -7590,6 +7785,310 @@ "traits": { "smithy.api#enumValue": "ml.r5.24xlarge" } + }, + "ML_C7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.large" + } + }, + "ML_C7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.xlarge" + } + }, + "ML_C7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.2xlarge" + } + }, + "ML_C7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.4xlarge" + } + }, + "ML_C7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.8xlarge" + } + }, + "ML_C7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.12xlarge" + } + }, + "ML_C7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.16xlarge" + } + }, + "ML_C7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.24xlarge" + } + }, + "ML_C7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.48xlarge" + } + }, + "ML_M7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.large" + } + }, + "ML_M7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.xlarge" + } + }, + "ML_M7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.2xlarge" + } + }, + "ML_M7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.4xlarge" + } + }, + "ML_M7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.8xlarge" + } + }, + "ML_M7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.12xlarge" + } + }, + "ML_M7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.16xlarge" + } + }, + "ML_M7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.24xlarge" + } + }, + "ML_M7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.48xlarge" + } + }, + "ML_R7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.large" + } + }, + "ML_R7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.xlarge" + } + }, + "ML_R7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.2xlarge" + } + }, + "ML_R7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.4xlarge" + } + }, + "ML_R7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.8xlarge" + } + }, + "ML_R7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.12xlarge" + } + }, + "ML_R7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.16xlarge" + } + }, + "ML_R7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.24xlarge" + } + }, + "ML_R7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.48xlarge" + } + }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + }, + "ML_G6E_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.xlarge" + } + }, + "ML_G6E_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.2xlarge" + } + }, + "ML_G6E_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.4xlarge" + } + }, + "ML_G6E_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.8xlarge" + } + }, + "ML_G6E_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.12xlarge" + } + }, + "ML_G6E_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.16xlarge" + } + }, + "ML_G6E_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.24xlarge" + } + }, + "ML_G6E_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6e.48xlarge" + } + }, + "ML_P5EN_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5en.48xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#deprecated": { + "message": "P3 instance types are deprecated. Use P4 or newer instance types for better performance and cost efficiency.", + "since": "2025-09-02" + }, + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#deprecated": { + "message": "P3 instance types are deprecated. Use P4 or newer instance types for better performance and cost efficiency.", + "since": "2025-09-02" + }, + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#deprecated": { + "message": "P3 instance types are deprecated. Use P4 or newer instance types for better performance and cost efficiency.", + "since": "2025-09-02" + }, + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_P3DN_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#deprecated": { + "message": "P3 instance types are deprecated. Use P4 or newer instance types for better performance and cost efficiency.", + "since": "2025-09-02" + }, + "smithy.api#enumValue": "ml.p3dn.24xlarge" + } } } }, @@ -9073,6 +9572,44 @@ "smithy.api#output": {} } }, + "com.amazonaws.cleanroomsml#LogRedactionConfiguration": { + "type": "structure", + "members": { + "entitiesToRedact": { + "target": "com.amazonaws.cleanroomsml#EntityTypeList", + "traits": { + "smithy.api#documentation": "

Specifies the entities to be redacted from logs. Entities to redact are \"ALL_PERSONALLY_IDENTIFIABLE_INFORMATION\", \"NUMBERS\",\"CUSTOM\". If CUSTOM is supplied or configured, custom patterns (customDataIdentifiers) should be provided, and the patterns will be redacted in logs or error messages.

", + "smithy.api#required": {} + } + }, + "customEntityConfig": { + "target": "com.amazonaws.cleanroomsml#CustomEntityConfig", + "traits": { + "smithy.api#documentation": "

Specifies the configuration for custom entities in the context of log redaction.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for log redaction.

" + } + }, + "com.amazonaws.cleanroomsml#LogType": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "ERROR_SUMMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR_SUMMARY" + } + } + } + }, "com.amazonaws.cleanroomsml#LogsConfigurationPolicy": { "type": "structure", "members": { @@ -9092,6 +9629,19 @@ "max": 1024 } } + }, + "logType": { + "target": "com.amazonaws.cleanroomsml#LogType", + "traits": { + "smithy.api#default": "ALL", + "smithy.api#documentation": "

Specifies the type of log this policy applies to. The currently supported policies are ALL or ERROR_SUMMARY.

" + } + }, + "logRedactionConfiguration": { + "target": "com.amazonaws.cleanroomsml#LogRedactionConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the log redaction configuration for this policy.

" + } } }, "traits": { @@ -9633,6 +10183,20 @@ } } }, + "com.amazonaws.cleanroomsml#PrivacyBudgets": { + "type": "union", + "members": { + "accessBudgets": { + "target": "com.amazonaws.cleanroomsml#AccessBudgets", + "traits": { + "smithy.api#documentation": "

A list of access budgets that apply to resources associated with this Clean Rooms ML input channel.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The privacy budget information that controls access to Clean Rooms ML input channels.

" + } + }, "com.amazonaws.cleanroomsml#PrivacyConfiguration": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/cloud9.json b/codegen/sdk/aws-models/cloud9.json index 806df005d26..e7a2abd9fd5 100644 --- a/codegen/sdk/aws-models/cloud9.json +++ b/codegen/sdk/aws-models/cloud9.json @@ -819,17 +819,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -843,17 +832,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -867,17 +845,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -891,17 +858,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/cloudcontrol.json b/codegen/sdk/aws-models/cloudcontrol.json index 8d0c09d6226..87e8aa26f4a 100644 --- a/codegen/sdk/aws-models/cloudcontrol.json +++ b/codegen/sdk/aws-models/cloudcontrol.json @@ -963,17 +963,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -987,17 +976,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1011,17 +989,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1035,17 +1002,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/clouddirectory.json b/codegen/sdk/aws-models/clouddirectory.json index a214b41c124..09ee0810bb1 100644 --- a/codegen/sdk/aws-models/clouddirectory.json +++ b/codegen/sdk/aws-models/clouddirectory.json @@ -993,17 +993,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1017,17 +1006,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1041,17 +1019,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1065,17 +1032,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/cloudformation.json b/codegen/sdk/aws-models/cloudformation.json index e9b48e2d9c0..014fa8de09f 100644 --- a/codegen/sdk/aws-models/cloudformation.json +++ b/codegen/sdk/aws-models/cloudformation.json @@ -73,18 +73,18 @@ "Status": { "target": "com.amazonaws.cloudformation#AccountGateStatus", "traits": { - "smithy.api#documentation": "

The status of the account gate function.

\n
    \n
  • \n

    \n SUCCEEDED: The account gate function has determined that the account and\n Region passes any requirements for a stack set operation to occur. CloudFormation proceeds with the\n stack operation in that account and Region.

    \n
  • \n
  • \n

    \n FAILED: The account gate function has determined that the account and Region\n doesn't meet the requirements for a stack set operation to occur. CloudFormation cancels the stack\n set operation in that account and Region, and sets the stack set operation result status for\n that account and Region to FAILED.

    \n
  • \n
  • \n

    \n SKIPPED: CloudFormation has skipped calling the account gate function for this\n account and Region, for one of the following reasons:

    \n
      \n
    • \n

      An account gate function hasn't been specified for the account and Region. CloudFormation\n proceeds with the stack set operation in this account and Region.

      \n
    • \n
    • \n

      The AWSCloudFormationStackSetExecutionRole of the stack set administration\n account lacks permissions to invoke the function. CloudFormation proceeds with the stack set\n operation in this account and Region.

      \n
    • \n
    • \n

      Either no action is necessary, or no action is possible, on the stack. CloudFormation skips\n the stack set operation in this account and Region.

      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The status of the account gate function.

\n
    \n
  • \n

    \n SUCCEEDED: The account gate function has determined that the account and\n Region passes any requirements for a StackSet operation to occur. CloudFormation proceeds with the\n stack operation in that account and Region.

    \n
  • \n
  • \n

    \n FAILED: The account gate function has determined that the account and Region\n doesn't meet the requirements for a StackSet operation to occur. CloudFormation cancels the\n StackSet operation in that account and Region, and sets the StackSet operation result status\n for that account and Region to FAILED.

    \n
  • \n
  • \n

    \n SKIPPED: CloudFormation has skipped calling the account gate function for this\n account and Region, for one of the following reasons:

    \n
      \n
    • \n

      An account gate function hasn't been specified for the account and Region. CloudFormation\n proceeds with the StackSet operation in this account and Region.

      \n
    • \n
    • \n

      The AWSCloudFormationStackSetExecutionRole of the administration account\n lacks permissions to invoke the function. CloudFormation proceeds with the StackSet operation in\n this account and Region.

      \n
    • \n
    • \n

      Either no action is necessary, or no action is possible, on the stack. CloudFormation skips\n the StackSet operation in this account and Region.

      \n
    • \n
    \n
  • \n
" } }, "StatusReason": { "target": "com.amazonaws.cloudformation#AccountGateStatusReason", "traits": { - "smithy.api#documentation": "

The reason for the account gate status assigned to this account and Region for the stack set\n operation.

" + "smithy.api#documentation": "

The reason for the account gate status assigned to this account and Region for the StackSet\n operation.

" } } }, "traits": { - "smithy.api#documentation": "

Structure that contains the results of the account gate function which CloudFormation invokes,\n if present, before proceeding with a stack set operation in an account and Region.

\n

For each account and Region, CloudFormation lets you specify a Lambda function that encapsulates\n any requirements that must be met before CloudFormation can proceed with a stack set operation in\n that account and Region. CloudFormation invokes the function each time a stack set operation is\n requested for that account and Region; if the function returns FAILED, CloudFormation\n cancels the operation in that account and Region, and sets the stack set operation result status\n for that account and Region to FAILED.

\n

For more information, see Configuring a target\n account gate in StackSets in the CloudFormation User Guide.

" + "smithy.api#documentation": "

Structure that contains the results of the account gate function which CloudFormation invokes,\n if present, before proceeding with a StackSet operation in an account and Region.

\n

For each account and Region, CloudFormation lets you specify a Lambda function that encapsulates\n any requirements that must be met before CloudFormation can proceed with a StackSet operation in that\n account and Region. CloudFormation invokes the function each time a StackSet operation is requested\n for that account and Region; if the function returns FAILED, CloudFormation cancels the\n operation in that account and Region, and sets the StackSet operation result status for that\n account and Region to FAILED.

\n

For more information, see Prevent failed StackSets\n deployments using target account gates in the\n CloudFormation User Guide.

" } }, "com.amazonaws.cloudformation#AccountGateStatus": { @@ -130,7 +130,7 @@ } }, "traits": { - "smithy.api#documentation": "

The AccountLimit data type.

\n

CloudFormation has the following limits per account:

\n
    \n
  • \n

    Number of concurrent resources

    \n
  • \n
  • \n

    Number of stacks

    \n
  • \n
  • \n

    Number of stack outputs

    \n
  • \n
\n

For more information about these account limits, and other CloudFormation limits, see Understand CloudFormation quotas in the CloudFormation User Guide.

" + "smithy.api#documentation": "

Describes the current CloudFormation limits for your account.

\n

CloudFormation has the following limits per account:

\n
    \n
  • \n

    Number of concurrent resources

    \n
  • \n
  • \n

    Number of stacks

    \n
  • \n
  • \n

    Number of stack outputs

    \n
  • \n
\n

For more information, see Understand CloudFormation\n quotas in the CloudFormation User Guide.

" } }, "com.amazonaws.cloudformation#AccountLimitList": { @@ -206,7 +206,7 @@ } ], "traits": { - "smithy.api#documentation": "

Activates a public third-party extension, making it available for use in stack templates.\n Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For\n more information, see Using public\n extensions in the CloudFormation User Guide.

", + "smithy.api#documentation": "

Activates a public third-party extension, such as a resource or module, to make it\n available for use in stack templates in your current account and Region. It can also create\n CloudFormation Hooks, which allow you to evaluate resource configurations before CloudFormation\n provisions them. Hooks integrate with both CloudFormation and Cloud Control API operations.

\n

After you activate an extension, you can use SetTypeConfiguration to set specific properties for the extension.

\n

To see which extensions have been activated, use ListTypes. To see\n configuration details for an extension, use DescribeType.

\n

For more information, see Activate a\n third-party public extension in your account in the\n CloudFormation User Guide. For information about creating Hooks, see the\n CloudFormation\n Hooks User Guide.

", "smithy.api#idempotent": {} } }, @@ -367,7 +367,7 @@ } }, "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit\n (OU).

" + "smithy.api#documentation": "

Describes whether StackSets automatically deploys to Organizations accounts that are\n added to a target organization or organizational unit (OU). For more information, see Enable or\n disable automatic deployments for StackSets in Organizations in the\n CloudFormation User Guide.

" } }, "com.amazonaws.cloudformation#AutoDeploymentNullable": { @@ -393,7 +393,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns configuration data for the specified CloudFormation extensions, from the CloudFormation\n registry for the account and Region.

\n

For more information, see Edit configuration\n data for extensions in your account in the\n CloudFormation User Guide.

" + "smithy.api#documentation": "

Returns configuration data for the specified CloudFormation extensions, from the CloudFormation\n registry in your current account and Region.

\n

For more information, see Edit configuration\n data for extensions in your account in the\n CloudFormation User Guide.

" } }, "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsError": { @@ -696,19 +696,19 @@ "InvocationPoint": { "target": "com.amazonaws.cloudformation#HookInvocationPoint", "traits": { - "smithy.api#documentation": "

Specifies the points in provisioning logic where a hook is invoked.

" + "smithy.api#documentation": "

The specific point in the provisioning process where the Hook is invoked.

" } }, "FailureMode": { "target": "com.amazonaws.cloudformation#HookFailureMode", "traits": { - "smithy.api#documentation": "

Specify the hook failure mode for non-compliant resources in the followings ways.

\n
    \n
  • \n

    \n FAIL Stops provisioning resources.

    \n
  • \n
  • \n

    \n WARN Allows provisioning to continue with a warning message.

    \n
  • \n
" + "smithy.api#documentation": "

Specify the Hook failure mode for non-compliant resources in the followings\n ways.

\n
    \n
  • \n

    \n FAIL Stops provisioning resources.

    \n
  • \n
  • \n

    \n WARN Allows provisioning to continue with a warning message.

    \n
  • \n
" } }, "TypeName": { "target": "com.amazonaws.cloudformation#HookTypeName", "traits": { - "smithy.api#documentation": "

The unique name for your hook. Specifies a three-part namespace for your hook, with a\n recommended pattern of Organization::Service::Hook.

\n \n

The following organization namespaces are reserved and can't be used in your hook type\n names:

\n
    \n
  • \n

    \n Alexa\n

    \n
  • \n
  • \n

    \n AMZN\n

    \n
  • \n
  • \n

    \n Amazon\n

    \n
  • \n
  • \n

    \n ASK\n

    \n
  • \n
  • \n

    \n AWS\n

    \n
  • \n
  • \n

    \n Custom\n

    \n
  • \n
  • \n

    \n Dev\n

    \n
  • \n
\n
" + "smithy.api#documentation": "

The unique name for your Hook. Specifies a three-part namespace for your\n Hook, with a recommended pattern of Organization::Service::Hook.

\n \n

The following organization namespaces are reserved and can't be used in your Hook\n type names:

\n
    \n
  • \n

    \n Alexa\n

    \n
  • \n
  • \n

    \n AMZN\n

    \n
  • \n
  • \n

    \n Amazon\n

    \n
  • \n
  • \n

    \n ASK\n

    \n
  • \n
  • \n

    \n AWS\n

    \n
  • \n
  • \n

    \n Custom\n

    \n
  • \n
  • \n

    \n Dev\n

    \n
  • \n
\n
" } }, "TypeVersionId": { @@ -726,12 +726,12 @@ "TargetDetails": { "target": "com.amazonaws.cloudformation#ChangeSetHookTargetDetails", "traits": { - "smithy.api#documentation": "

Specifies details about the target that the hook will run against.

" + "smithy.api#documentation": "

Specifies details about the target that the Hook will run against.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies the resource, the hook, and the hook version to be invoked.

" + "smithy.api#documentation": "

Specifies the resource, the Hook, and the Hook version to be\n invoked.

" } }, "com.amazonaws.cloudformation#ChangeSetHookResourceTargetDetails": { @@ -777,7 +777,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies target details for an activated hook.

" + "smithy.api#documentation": "

Specifies target details for an activated Hook.

" } }, "com.amazonaws.cloudformation#ChangeSetHooks": { @@ -2257,17 +2257,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2281,17 +2270,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2305,17 +2283,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2329,17 +2296,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -2470,7 +2426,7 @@ } ], "traits": { - "smithy.api#documentation": "

For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues\n rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of\n the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return\n your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try\n to update the stack again.

\n

A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll\n back all changes after a failed stack update. For example, you might have a stack that's\n rolling back to an old database instance that was deleted outside of CloudFormation. Because\n CloudFormation doesn't know the database was deleted, it assumes that the database instance still\n exists and attempts to roll back to it, causing the update rollback to fail.

" + "smithy.api#documentation": "

Continues rolling back a stack from UPDATE_ROLLBACK_FAILED to\n UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can\n manually fix the error and continue the rollback. By continuing the rollback, you can return\n your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state) and then try\n to update the stack again.

\n

A stack enters the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll\n back all changes after a failed stack update. For example, this might occur when a stack\n attempts to roll back to an old database that was deleted outside of CloudFormation. Because\n CloudFormation doesn't know the instance was deleted, it assumes the instance still exists and\n attempts to roll back to it, causing the update rollback to fail.

\n

For more information, see Continue rolling back an update in the CloudFormation User Guide. For\n information for troubleshooting a failed update rollback, see Update rollback failed.

" } }, "com.amazonaws.cloudformation#ContinueUpdateRollbackInput": { @@ -2577,7 +2533,7 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
    • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
    • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
    • \n
    \n

    If your stack template contains these resources, we suggest that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
  • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually creating the stack. If your stack template contains one or more macros,\n and you choose to create a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include\n and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    \n \n

    This capacity doesn't apply to creating change sets, and specifying it when creating\n change sets has no effect.

    \n

    If you want to create a stack from a stack template that contains macros\n and nested stacks, you must create or update the stack directly\n from the template using the CreateStack or UpdateStack action, and specifying this capability.

    \n
    \n

    For more information about macros, see Perform custom processing\n on CloudFormation templates with template macros.

    \n
  • \n
\n \n

Only one of the Capabilities and ResourceType parameters can\n be specified.

\n
" + "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
    • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
    • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
    • \n
    \n

    If your stack template contains these resources, we suggest that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
  • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually creating the stack. If your stack template contains one or more macros,\n and you choose to create a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include\n and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    \n \n

    This capacity doesn't apply to creating change sets, and specifying it when creating\n change sets has no effect.

    \n

    If you want to create a stack from a stack template that contains macros\n and nested stacks, you must create or update the stack directly\n from the template using the CreateStack or UpdateStack action, and specifying this capability.

    \n
    \n

    For more information about macros, see Perform custom processing\n on CloudFormation templates with template macros.

    \n
  • \n
\n \n

Only one of the Capabilities and ResourceType parameters can\n be specified.

\n
" } }, "ResourceTypes": { @@ -2657,7 +2613,7 @@ "ImportExistingResources": { "target": "com.amazonaws.cloudformation#ImportExistingResources", "traits": { - "smithy.api#documentation": "

Indicates if the change set auto-imports resources that already exist. For more\n information, see Import Amazon Web Services\n resources into a CloudFormation stack automatically in the\n CloudFormation User Guide.

\n \n

This parameter can only import resources that have custom names in templates. For more\n information, see name type in the\n CloudFormation User Guide. To import resources that do not accept custom\n names, such as EC2 instances, use the ResourcesToImport parameter\n instead.

\n
" + "smithy.api#documentation": "

Indicates if the change set auto-imports resources that already exist. For more\n information, see Import Amazon Web Services\n resources into a CloudFormation stack automatically in the\n CloudFormation User Guide.

\n \n

This parameter can only import resources that have custom names in templates. For more\n information, see name\n type in the CloudFormation User Guide. To import resources that do not\n accept custom names, such as EC2 instances, use the ResourcesToImport parameter\n instead.

\n
" } } }, @@ -2882,7 +2838,7 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
    • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
    • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
    • \n
    \n

    If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
  • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually creating the stack. If your stack template contains one or more macros,\n and you choose to create a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include\n and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    \n

    If you want to create a stack from a stack template that contains macros\n and nested stacks, you must create the stack directly from the\n template using this capability.

    \n \n

    You should only create stacks directly from a stack template that contains macros if\n you know what processing the macro performs.

    \n

    Each macro relies on an underlying Lambda service function for processing stack\n templates. Be aware that the Lambda function owner can update the function operation\n without CloudFormation being notified.

    \n
    \n

    For more information, see Perform custom processing\n on CloudFormation templates with template macros.

    \n
  • \n
\n \n

Only one of the Capabilities and ResourceType parameters can\n be specified.

\n
" + "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
    • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
    • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
    • \n
    \n

    If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
  • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually creating the stack. If your stack template contains one or more macros,\n and you choose to create a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include\n and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    \n

    If you want to create a stack from a stack template that contains macros\n and nested stacks, you must create the stack directly from the\n template using this capability.

    \n \n

    You should only create stacks directly from a stack template that contains macros if\n you know what processing the macro performs.

    \n

    Each macro relies on an underlying Lambda service function for processing stack\n templates. Be aware that the Lambda function owner can update the function operation\n without CloudFormation being notified.

    \n
    \n

    For more information, see Perform custom processing\n on CloudFormation templates with template macros.

    \n
  • \n
\n \n

Only one of the Capabilities and ResourceType parameters can\n be specified.

\n
" } }, "ResourceTypes": { @@ -2900,7 +2856,7 @@ "OnFailure": { "target": "com.amazonaws.cloudformation#OnFailure", "traits": { - "smithy.api#documentation": "

Determines what action will be taken if stack creation fails. This must be one of:\n DO_NOTHING, ROLLBACK, or DELETE. You can specify\n either OnFailure or DisableRollback, but not both.

\n

Default: ROLLBACK\n

" + "smithy.api#documentation": "

Determines what action will be taken if stack creation fails. This must be one of:\n DO_NOTHING, ROLLBACK, or DELETE. You can specify\n either OnFailure or DisableRollback, but not both.

\n \n

Although the default setting is ROLLBACK, there is one exception. This\n exception occurs when a StackSet attempts to deploy a stack instance and the stack instance\n fails to create successfully. In this case, the CreateStack call overrides the\n default setting and sets the value of OnFailure to DELETE.

\n
\n

Default: ROLLBACK\n

" } }, "StackPolicyBody": { @@ -2984,7 +2940,7 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to create stack instances\n from.

", + "smithy.api#documentation": "

The name or unique ID of the StackSet that you want to create stack instances from.

", "smithy.api#required": {} } }, @@ -2997,7 +2953,7 @@ "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts for which to create stack\n instances in the specified Amazon Web Services Regions.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" + "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts in which to create stack\n instances in the specified Amazon Web Services Regions.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" } }, "Regions": { @@ -3011,26 +2967,26 @@ "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

A list of stack set parameters whose values you want to override in the selected stack\n instances.

\n

Any overridden parameter values will be applied to all stack instances in the specified\n accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how\n CloudFormation sets parameter values during stack instance operations:

\n
    \n
  • \n

    To override the current value for a parameter, include the parameter and specify its\n value.

    \n
  • \n
  • \n

    To leave an overridden parameter set to its present value, include the parameter and\n specify UsePreviousValue as true. (You can't specify both a\n value and set UsePreviousValue to true.)

    \n
  • \n
  • \n

    To set an overridden parameter back to the value specified in the stack set, specify a\n parameter list but don't include the parameter in the list.

    \n
  • \n
  • \n

    To leave all parameters set to their present values, don't specify this property at\n all.

    \n
  • \n
\n

During stack set updates, any parameter values overridden for a stack instance aren't\n updated, but retain their overridden value.

\n

You can only override the parameter values that are specified in the\n stack set; to add or delete a parameter itself, use UpdateStackSet\n to update the stack set template.

" + "smithy.api#documentation": "

A list of StackSet parameters whose values you want to override in the selected stack\n instances.

\n

Any overridden parameter values will be applied to all stack instances in the specified\n accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how\n CloudFormation sets parameter values during stack instance operations:

\n
    \n
  • \n

    To override the current value for a parameter, include the parameter and specify its\n value.

    \n
  • \n
  • \n

    To leave an overridden parameter set to its present value, include the parameter and\n specify UsePreviousValue as true. (You can't specify both a\n value and set UsePreviousValue to true.)

    \n
  • \n
  • \n

    To set an overridden parameter back to the value specified in the StackSet, specify a\n parameter list but don't include the parameter in the list.

    \n
  • \n
  • \n

    To leave all parameters set to their present values, don't specify this property at\n all.

    \n
  • \n
\n

During StackSet updates, any parameter values overridden for a stack instance aren't\n updated, but retain their overridden value.

\n

You can only override the parameter values that are specified in the\n StackSet; to add or delete a parameter itself, use UpdateStackSet\n to update the StackSet template.

" } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

Preferences for how CloudFormation performs this stack set operation.

" + "smithy.api#documentation": "

Preferences for how CloudFormation performs this StackSet operation.

" } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique identifier for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the stack set operation only once, even if you retry the request multiple times. You\n might retry stack set operation requests to ensure that CloudFormation successfully received\n them.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

\n

Repeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.

", + "smithy.api#documentation": "

The unique identifier for this StackSet operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the StackSet operation only once, even if you retry the request multiple times. You\n might retry StackSet operation requests to ensure that CloudFormation successfully received\n them.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

\n

Repeating this StackSet operation with a new operation ID retries all stack instances\n whose status is OUTDATED.

", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } } }, @@ -3044,7 +3000,7 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique identifier for this stack set operation.

" + "smithy.api#documentation": "

The unique identifier for this StackSet operation.

" } } }, @@ -3149,7 +3105,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a stack set.

" + "smithy.api#documentation": "

Creates a StackSet.

" } }, "com.amazonaws.cloudformation#CreateStackSetInput": { @@ -3159,14 +3115,14 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name to associate with the stack set. The name must be unique in the Region where you\n create your stack set.

\n \n

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It\n must start with an alphabetic character and can't be longer than 128 characters.

\n
", + "smithy.api#documentation": "

The name to associate with the StackSet. The name must be unique in the Region where you\n create your StackSet.

\n \n

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It\n must start with an alphabetic character and can't be longer than 128 characters.

\n
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "

A description of the stack set. You can use the description to identify the stack set's\n purpose or other important information.

" + "smithy.api#documentation": "

A description of the StackSet. You can use the description to identify the StackSet's\n purpose or other important information.

" } }, "TemplateBody": { @@ -3184,68 +3140,68 @@ "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

The stack ID you are importing into a new stack set. Specify the Amazon Resource Name\n (ARN) of the stack.

" + "smithy.api#documentation": "

The stack ID you are importing into a new StackSet. Specify the Amazon Resource Name (ARN)\n of the stack.

" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

The input parameters for the stack set template.

" + "smithy.api#documentation": "

The input parameters for the StackSet template.

" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack set template contains\n certain capabilities in order for CloudFormation to create the stack set and related stack\n instances.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new IAM users. For those stack sets, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
    • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
    • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
    • \n
    \n

    If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
  • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some templates reference macros. If your stack set template references one or more\n macros, you must create the stack set directly from the processed template, without first\n reviewing the resulting changes in a change set. To create the stack set directly, you\n must acknowledge this capability. For more information, see Perform custom processing\n on CloudFormation templates with template macros.

    \n \n

    Stack sets with service-managed permissions don't currently support the use of\n macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if\n you specify this capability for a stack set with service-managed permissions, if you\n reference a macro in your template the stack set operation will fail.

    \n
    \n
  • \n
" + "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your StackSet template contains\n certain capabilities in order for CloudFormation to create the StackSet and related stack\n instances.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new IAM users. For those StackSets, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
    • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
    • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
    • \n
    \n

    If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
  • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some templates reference macros. If your StackSet template references one or more\n macros, you must create the StackSet directly from the processed template, without first\n reviewing the resulting changes in a change set. To create the StackSet directly, you must\n acknowledge this capability. For more information, see Perform custom processing\n on CloudFormation templates with template macros.

    \n \n

    StackSets with service-managed permissions don't currently support the use of macros\n in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if\n you specify this capability for a StackSet with service-managed permissions, if you\n reference a macro in your template the StackSet operation will fail.

    \n
    \n
  • \n
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "

The key-value pairs to associate with this stack set and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are created in the stacks. A\n maximum number of 50 tags can be specified.

\n

If you specify tags as part of a CreateStackSet action, CloudFormation checks to\n see if you have the required IAM permission to tag resources. If you don't, the entire\n CreateStackSet action fails with an access denied error, and the\n stack set is not created.

" + "smithy.api#documentation": "

The key-value pairs to associate with this StackSet and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are created in the stacks. A\n maximum number of 50 tags can be specified.

\n

If you specify tags as part of a CreateStackSet action, CloudFormation checks to\n see if you have the required IAM permission to tag resources. If you don't, the entire\n CreateStackSet action fails with an access denied error, and the\n StackSet is not created.

" } }, "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.

\n

Specify an IAM role only if you are using customized administrator roles to control\n which users or groups can manage specific stack sets within the same administrator account.\n For more information, see Grant\n self-managed permissions in the CloudFormation User Guide.

\n

Valid only if the permissions model is SELF_MANAGED.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to use to create this StackSet.

\n

Specify an IAM role only if you are using customized administrator roles to control\n which users or groups can manage specific StackSets within the same administrator account. For\n more information, see Grant\n self-managed permissions in the CloudFormation User Guide.

\n

Valid only if the permissions model is SELF_MANAGED.

" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "

The name of the IAM execution role to use to create the stack set. If you do not specify\n an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole\n role for the stack set operation.

\n

Specify an IAM role only if you are using customized execution roles to control which\n stack resources users and groups can include in their stack sets.

\n

Valid only if the permissions model is SELF_MANAGED.

" + "smithy.api#documentation": "

The name of the IAM execution role to use to create the StackSet. If you do not specify\n an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole\n role for the StackSet operation.

\n

Specify an IAM role only if you are using customized execution roles to control which\n stack resources users and groups can include in their StackSets.

\n

Valid only if the permissions model is SELF_MANAGED.

" } }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { - "smithy.api#documentation": "

Describes how the IAM roles required for stack set operations are created. By default,\n SELF-MANAGED is specified.

\n " + "smithy.api#documentation": "

Describes how the IAM roles required for StackSet operations are created. By default,\n SELF-MANAGED is specified.

\n " } }, "AutoDeployment": { "target": "com.amazonaws.cloudformation#AutoDeployment", "traits": { - "smithy.api#documentation": "

Describes whether StackSets automatically deploys to Organizations accounts that\n are added to the target organization or organizational unit (OU). For more information, see\n Manage\n automatic deployments for CloudFormation StackSets that use service-managed permissions\n in the CloudFormation User Guide.

\n

Required if the permissions model is SERVICE_MANAGED. (Not used with\n self-managed permissions.)

" + "smithy.api#documentation": "

Describes whether StackSets automatically deploys to Organizations accounts that\n are added to the target organization or organizational unit (OU). For more information, see\n Enable or disable automatic deployments for StackSets in Organizations\n in the CloudFormation User Guide.

\n

Required if the permissions model is SERVICE_MANAGED. (Not used with\n self-managed permissions.)

" } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

    \n
  • \n
  • \n

    To create a stack set with service-managed permissions while signed in to a delegated\n administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
\n

Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated\n administrators.

\n

Valid only if the permissions model is SERVICE_MANAGED.

" + "smithy.api#documentation": "

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    To create a StackSet with service-managed permissions while signed in to the management account, specify SELF.

    \n
  • \n
  • \n

    To create a StackSet with service-managed permissions while signed in to a delegated\n administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
\n

StackSets with service-managed permissions are created in the management account, including StackSets that are created by delegated administrators.

\n

Valid only if the permissions model is SERVICE_MANAGED.

" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique identifier for this CreateStackSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to create\n another stack set with the same name. You might retry CreateStackSet requests to\n ensure that CloudFormation successfully received them.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

", + "smithy.api#documentation": "

A unique identifier for this CreateStackSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to create\n another StackSet with the same name. You might retry CreateStackSet requests to\n ensure that CloudFormation successfully received them.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

", "smithy.api#idempotencyToken": {} } }, "ManagedExecution": { "target": "com.amazonaws.cloudformation#ManagedExecution", "traits": { - "smithy.api#documentation": "

Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.

" + "smithy.api#documentation": "

Describes whether CloudFormation performs non-conflicting operations concurrently and queues\n conflicting operations.

" } } }, @@ -3259,7 +3215,7 @@ "StackSetId": { "target": "com.amazonaws.cloudformation#StackSetId", "traits": { - "smithy.api#documentation": "

The ID of the stack set that you're creating.

" + "smithy.api#documentation": "

The ID of the StackSet that you're creating.

" } } }, @@ -3338,7 +3294,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deactivates a public extension that was previously activated in this account and\n Region.

\n

Once deactivated, an extension can't be used in any CloudFormation operation. This includes\n stack update operations where the stack template includes the extension, even if no updates\n are being made to the extension. In addition, deactivated extensions aren't automatically\n updated if a new version of the extension is released.

", + "smithy.api#documentation": "

Deactivates a public third-party extension, such as a resource or module, or a CloudFormation\n Hook when you no longer use it.

\n

Deactivating an extension deletes the configuration details that are associated with it.\n To temporary disable a CloudFormation Hook instead, you can use SetTypeConfiguration.

\n

Once deactivated, an extension can't be used in any CloudFormation operation. This includes\n stack update operations where the stack template includes the extension, even if no updates\n are being made to the extension. In addition, deactivated extensions aren't automatically\n updated if a new version of the extension is released.

\n

To see which extensions are currently activated, use ListTypes.

", "smithy.api#idempotent": {} } }, @@ -3562,7 +3518,7 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to delete stack instances for.

", + "smithy.api#documentation": "

The name or unique ID of the StackSet that you want to delete stack instances for.

", "smithy.api#required": {} } }, @@ -3582,35 +3538,35 @@ "target": "com.amazonaws.cloudformation#RegionList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Web Services Regions where you want to delete stack set instances.

", + "smithy.api#documentation": "

The Amazon Web Services Regions where you want to delete StackSet instances.

", "smithy.api#required": {} } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

Preferences for how CloudFormation performs this stack set operation.

" + "smithy.api#documentation": "

Preferences for how CloudFormation performs this StackSet operation.

" } }, "RetainStacks": { "target": "com.amazonaws.cloudformation#RetainStacks", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Removes the stack instances from the specified stack set, but doesn't delete the stacks.\n You can't reassociate a retained stack or add an existing, saved stack to a new stack\n set.

\n

For more information, see Stack set operation options.

", + "smithy.api#documentation": "

Removes the stack instances from the specified StackSet, but doesn't delete the stacks.\n You can't reassociate a retained stack or add an existing, saved stack to a new stack\n set.

\n

For more information, see StackSet operation options.

", "smithy.api#required": {} } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique identifier for this stack set operation.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the stack set operation only once, even if you retry the request multiple times. You\n can retry stack set operation requests to ensure that CloudFormation successfully received\n them.

\n

Repeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.

", + "smithy.api#documentation": "

The unique identifier for this StackSet operation.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the StackSet operation only once, even if you retry the request multiple times. You\n can retry StackSet operation requests to ensure that CloudFormation successfully received\n them.

\n

Repeating this StackSet operation with a new operation ID retries all stack instances\n whose status is OUTDATED.

", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } } }, @@ -3624,7 +3580,7 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique identifier for this stack set operation.

" + "smithy.api#documentation": "

The unique identifier for this StackSet operation.

" } } }, @@ -3649,7 +3605,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a stack set. Before you can delete a stack set, all its member stack instances\n must be deleted. For more information about how to complete this, see DeleteStackInstances.

" + "smithy.api#documentation": "

Deletes a StackSet. Before you can delete a StackSet, all its member stack instances must\n be deleted. For more information about how to complete this, see DeleteStackInstances.

" } }, "com.amazonaws.cloudformation#DeleteStackSetInput": { @@ -3659,14 +3615,14 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set that you're deleting. You can obtain this value by\n running ListStackSets.

", + "smithy.api#documentation": "

The name or unique ID of the StackSet that you're deleting. You can obtain this value by\n running ListStackSets.

", "smithy.api#required": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } } }, @@ -3707,30 +3663,30 @@ "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { - "smithy.api#documentation": "

The account IDs of the Amazon Web Services accounts. If you have many account numbers, you can provide\n those accounts using the AccountsUrl property instead.

" + "smithy.api#documentation": "

The Amazon Web Services account IDs where you want to perform stack operations. How these accounts are\n used depends on the AccountFilterType property.

\n

If you have many account numbers, you can provide those accounts using the\n AccountsUrl property instead.

" } }, "AccountsUrl": { "target": "com.amazonaws.cloudformation#AccountsUrl", "traits": { - "smithy.api#documentation": "

The Amazon S3 URL path to a file that contains a list of Amazon Web Services account IDs. The file\n format must be either .csv or .txt, and the data can be comma-separated\n or new-line-separated. There is currently a 10MB limit for the data (approximately 800,000\n accounts).

\n

" + "smithy.api#documentation": "

The Amazon S3 URL path to a file that contains a list of Amazon Web Services account IDs. The file\n format must be either .csv or .txt, and the data can be comma-separated\n or new-line-separated. There is currently a 10MB limit for the data (approximately 800,000\n accounts).

\n

This property serves the same purpose as Accounts but allows you to specify a\n large number of accounts.

" } }, "OrganizationalUnitIds": { "target": "com.amazonaws.cloudformation#OrganizationalUnitIdList", "traits": { - "smithy.api#documentation": "

The organization root ID or organizational unit (OU) IDs.

" + "smithy.api#documentation": "

The organization root ID or organizational unit (OU) IDs where you want to perform stack\n operations. CloudFormation will perform operations on accounts within these OUs and their child\n OUs.

" } }, "AccountFilterType": { "target": "com.amazonaws.cloudformation#AccountFilterType", "traits": { - "smithy.api#documentation": "

Limit deployment targets to individual accounts or include additional accounts with provided\n OUs.

\n

The following is a list of possible values for the AccountFilterType\n operation.

\n
    \n
  • \n

    \n INTERSECTION: StackSets deploys to the accounts specified in\n Accounts parameter.

    \n
  • \n
  • \n

    \n DIFFERENCE: StackSets excludes the accounts specified in\n Accounts parameter. This enables user to avoid certain accounts within an OU such\n as suspended accounts.

    \n
  • \n
  • \n

    \n UNION: StackSets includes additional accounts deployment targets.

    \n

    This is the default value if AccountFilterType is not provided. This enables\n user to update an entire OU and individual accounts from a different OU in one request, which\n used to be two separate requests.

    \n
  • \n
  • \n

    \n NONE: Deploys to all the accounts in specified organizational units\n (OU).

    \n
  • \n
" + "smithy.api#documentation": "

Refines which accounts will have stack operations performed on them by specifying how to use\n the Accounts and OrganizationalUnitIds properties together.

\n

The following values determine how CloudFormation selects target accounts:

\n
    \n
  • \n

    \n INTERSECTION: Performs stack operations only on specific individual accounts\n within the selected OUs. Only accounts that are both specified in the Accounts\n property and belong to the specified OUs will be targeted.

    \n
  • \n
  • \n

    \n DIFFERENCE: Performs stack operations on all accounts in the selected OUs\n except for specific accounts listed in the Accounts property. This enables you to\n exclude certain accounts within an OU, such as suspended accounts.

    \n
  • \n
  • \n

    \n UNION: Performs stack operations on the specified OUs plus additional\n individual accounts listed in the Accounts property. This is the default value if\n AccountFilterType is not provided. This lets you target an entire OU and\n individual accounts from a different OU in one request. Note that UNION is not\n supported for CreateStackInstances operations.

    \n
  • \n
  • \n

    \n NONE: Performs stack operations on all accounts in the specified\n organizational units (OUs).

    \n
  • \n
" } } }, "traits": { - "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts to which StackSets deploys.\n StackSets doesn't deploy stack instances to the organization management account, even\n if the organization management account is in your organization or in an OU in your\n organization.

\n

For update operations, you can specify either Accounts or\n OrganizationalUnitIds. For create and delete operations, specify\n OrganizationalUnitIds.

" + "smithy.api#documentation": "

Specifies the Organizations accounts where you want to create, update, or delete\n stack instances. You can target either your entire organization or specific accounts using\n organizational units (OUs) and account filter options.

\n

CloudFormation doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU\n in your organization.

\n

When performing create operations, if you specify both OrganizationalUnitIds\n and Accounts, you must also specify the AccountFilterType property.

" } }, "com.amazonaws.cloudformation#DeprecatedStatus": { @@ -3767,7 +3723,7 @@ } ], "traits": { - "smithy.api#documentation": "

Marks an extension or extension version as DEPRECATED in the CloudFormation\n registry, removing it from active use. Deprecated extensions or extension versions cannot be\n used in CloudFormation operations.

\n

To deregister an entire extension, you must individually deregister all active versions of\n that extension. If an extension has only a single active version, deregistering that version\n results in the extension itself being deregistered and marked as deprecated in the\n registry.

\n

You can't deregister the default version of an extension if there are other active version\n of that extension. If you do deregister the default version of an extension, the extension\n type itself is deregistered as well and marked as deprecated.

\n

To view the deprecation status of an extension or extension version, use DescribeType.

", + "smithy.api#documentation": "

Marks an extension or extension version as DEPRECATED in the CloudFormation\n registry, removing it from active use. Deprecated extensions or extension versions cannot be\n used in CloudFormation operations.

\n

To deregister an entire extension, you must individually deregister all active versions of\n that extension. If an extension has only a single active version, deregistering that version\n results in the extension itself being deregistered and marked as deprecated in the\n registry.

\n

You can't deregister the default version of an extension if there are other active version\n of that extension. If you do deregister the default version of an extension, the extension\n type itself is deregistered as well and marked as deprecated.

\n

To view the deprecation status of an extension or extension version, use DescribeType.

\n

For more information, see Remove\n third-party private extensions from your account in the\n CloudFormation User Guide.

", "smithy.api#idempotent": {} } }, @@ -3986,7 +3942,7 @@ "Hooks": { "target": "com.amazonaws.cloudformation#ChangeSetHooks", "traits": { - "smithy.api#documentation": "

List of hook objects.

" + "smithy.api#documentation": "

List of Hook objects.

" } }, "Status": { @@ -4179,7 +4135,7 @@ "ImportExistingResources": { "target": "com.amazonaws.cloudformation#ImportExistingResources", "traits": { - "smithy.api#documentation": "

Indicates if the change set imports resources that already exist.

\n \n

This parameter can only import resources that have custom names in\n templates. To import resources that do not accept custom names, such as EC2 instances, use\n the resource import\n feature instead.

\n
" + "smithy.api#documentation": "

Indicates if the change set imports resources that already exist.

\n \n

This parameter can only import resources that have custom\n names in templates. To import resources that do not accept custom names, such as\n EC2 instances, use the resource import\n feature instead.

\n
" } } }, @@ -4558,7 +4514,7 @@ "StackDriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { - "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected configuration.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from its expected template configuration. A\n stack is considered to have drifted if one or more of its resources have drifted.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its\n expected template configuration.

    \n
  • \n
  • \n

    \n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.

    \n
  • \n
  • \n

    \n UNKNOWN: CloudFormation could not run drift detection for a resource in the stack. See the DetectionStatusReason for details.

    \n
  • \n
" + "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected configuration.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from its expected template configuration. A\n stack is considered to have drifted if one or more of its resources have drifted.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its\n expected template configuration.

    \n
  • \n
  • \n

    \n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.

    \n
  • \n
  • \n

    \n UNKNOWN: CloudFormation could not run drift detection for a resource in the\n stack. See the DetectionStatusReason for details.

    \n
  • \n
" } }, "DetectionStatus": { @@ -4680,7 +4636,7 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or the unique stack ID of the stack set that you want to get stack instance\n information for.

", + "smithy.api#documentation": "

The name or the unique stack ID of the StackSet that you want to get stack instance\n information for.

", "smithy.api#required": {} } }, @@ -4703,7 +4659,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } } }, @@ -4930,7 +4886,7 @@ "StackResourceDriftStatusFilters": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatusFilters", "traits": { - "smithy.api#documentation": "

The resource drift status values to use as filters for the resource drift results\n returned.

\n
    \n
  • \n

    \n DELETED: The resource differs from its expected template configuration in\n that the resource has been deleted.

    \n
  • \n
  • \n

    \n MODIFIED: One or more resource properties differ from their expected\n template values.

    \n
  • \n
  • \n

    \n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation doesn't currently return this value.

    \n
  • \n
  • \n

    \n UNKNOWN: CloudFormation could not run drift detection for the resource.

    \n
  • \n
" + "smithy.api#documentation": "

The resource drift status values to use as filters for the resource drift results\n returned.

\n
    \n
  • \n

    \n DELETED: The resource differs from its expected template configuration in\n that the resource has been deleted.

    \n
  • \n
  • \n

    \n MODIFIED: One or more resource properties differ from their expected\n template values.

    \n
  • \n
  • \n

    \n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation doesn't currently return this value.

    \n
  • \n
  • \n

    \n UNKNOWN: CloudFormation could not run drift detection for the\n resource.

    \n
  • \n
" } }, "NextToken": { @@ -5090,14 +5046,14 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set whose description you want.

", + "smithy.api#documentation": "

The name or unique ID of the StackSet whose description you want.

", "smithy.api#required": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } } }, @@ -5132,7 +5088,7 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or the unique stack ID of the stack set for the stack operation.

", + "smithy.api#documentation": "

The name or the unique stack ID of the StackSet for the stack operation.

", "smithy.api#required": {} } }, @@ -5140,14 +5096,14 @@ "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The unique ID of the stack set operation.

", + "smithy.api#documentation": "

The unique ID of the StackSet operation.

", "smithy.api#required": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } } }, @@ -5161,7 +5117,7 @@ "StackSetOperation": { "target": "com.amazonaws.cloudformation#StackSetOperation", "traits": { - "smithy.api#documentation": "

The specified stack set operation.

" + "smithy.api#documentation": "

The specified StackSet operation.

" } } }, @@ -5175,7 +5131,7 @@ "StackSet": { "target": "com.amazonaws.cloudformation#StackSet", "traits": { - "smithy.api#documentation": "

The specified stack set.

" + "smithy.api#documentation": "

The specified StackSet.

" } } }, @@ -5701,7 +5657,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns detailed information about an extension that has been registered.

\n

If you specify a VersionId, DescribeType returns information\n about that specific extension version. Otherwise, it returns information about the default\n extension version.

", + "smithy.api#documentation": "

Returns detailed information about an extension from the CloudFormation registry in your\n current account and Region.

\n

If you specify a VersionId, DescribeType returns information\n about that specific extension version. Otherwise, it returns information about the default\n extension version.

", "smithy.api#idempotent": {} } }, @@ -6161,7 +6117,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it\n performs drift detection on the stack associated with each stack instance in the stack set.\n For more information, see Performing drift detection on\n CloudFormation StackSets.

\n

\n DetectStackSetDrift returns the OperationId of the stack set\n drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection\n operation. The drift detection operation may take some time, depending on the number of stack\n instances included in the stack set, in addition to the number of resources included in each\n stack.

\n

Once the operation has completed, use the following actions to return drift\n information:

\n
    \n
  • \n

    Use DescribeStackSet to return detailed information about the stack\n set, including detailed information about the last completed drift\n operation performed on the stack set. (Information about drift operations that are in\n progress isn't included.)

    \n
  • \n
  • \n

    Use ListStackInstances to return a list of stack instances belonging\n to the stack set, including the drift status and last drift time checked of each\n instance.

    \n
  • \n
  • \n

    Use DescribeStackInstance to return detailed information about a\n specific stack instance, including its drift status and last drift time checked.

    \n
  • \n
\n

You can only run a single drift detection operation on a given stack set at one\n time.

\n

To stop a drift detection stack set operation, use StopStackSetOperation.

" + "smithy.api#documentation": "

Detect drift on a StackSet. When CloudFormation performs drift detection on a StackSet, it\n performs drift detection on the stack associated with each stack instance in the StackSet. For\n more information, see Performing drift detection on\n CloudFormation StackSets.

\n

\n DetectStackSetDrift returns the OperationId of the StackSet\n drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection\n operation. The drift detection operation may take some time, depending on the number of stack\n instances included in the StackSet, in addition to the number of resources included in each\n stack.

\n

Once the operation has completed, use the following actions to return drift\n information:

\n
    \n
  • \n

    Use DescribeStackSet to return detailed information about the stack\n set, including detailed information about the last completed drift\n operation performed on the StackSet. (Information about drift operations that are in\n progress isn't included.)

    \n
  • \n
  • \n

    Use ListStackInstances to return a list of stack instances belonging\n to the StackSet, including the drift status and last drift time checked of each\n instance.

    \n
  • \n
  • \n

    Use DescribeStackInstance to return detailed information about a\n specific stack instance, including its drift status and last drift time checked.

    \n
  • \n
\n

You can only run a single drift detection operation on a given StackSet at one\n time.

\n

To stop a drift detection StackSet operation, use StopStackSetOperation.

" } }, "com.amazonaws.cloudformation#DetectStackSetDriftInput": { @@ -6171,27 +6127,27 @@ "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the stack set on which to perform the drift detection operation.

", + "smithy.api#documentation": "

The name of the StackSet on which to perform the drift detection operation.

", "smithy.api#required": {} } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a stack set operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

" + "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a StackSet operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.

" } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

\n The ID of the stack set operation.\n

", + "smithy.api#documentation": "

\n The ID of the StackSet operation.\n

", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } } }, @@ -6205,7 +6161,7 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The ID of the drift detection stack set operation.

\n

You can use this operation ID with DescribeStackSetOperation to monitor\n the progress of the drift detection operation.

" + "smithy.api#documentation": "

The ID of the drift detection StackSet operation.

\n

You can use this operation ID with DescribeStackSetOperation to monitor\n the progress of the drift detection operation.

" } } }, @@ -6528,7 +6484,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Export structure describes the exported output values for a stack.

" + "smithy.api#documentation": "

The Export structure describes the exported output values for a stack.

\n

For more information, see Get exported outputs from\n a deployed CloudFormation stack.

" } }, "com.amazonaws.cloudformation#ExportName": { @@ -6926,7 +6882,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about a new or existing template. The GetTemplateSummary\n action is useful for viewing parameter information, such as default parameter values and\n parameter types, before you create or update a stack or stack set.

\n

You can use the GetTemplateSummary action when you submit a template, or you\n can get template information for a stack set, or a running or deleted stack.

\n

For deleted stacks, GetTemplateSummary returns the template information for\n up to 90 days after the stack has been deleted. If the template doesn't exist, a\n ValidationError is returned.

" + "smithy.api#documentation": "

Returns information about a new or existing template. The GetTemplateSummary\n action is useful for viewing parameter information, such as default parameter values and\n parameter types, before you create or update a stack or StackSet.

\n

You can use the GetTemplateSummary action when you submit a template, or you\n can get template information for a StackSet, or a running or deleted stack.

\n

For deleted stacks, GetTemplateSummary returns the template information for\n up to 90 days after the stack has been deleted. If the template doesn't exist, a\n ValidationError is returned.

" } }, "com.amazonaws.cloudformation#GetTemplateSummaryInput": { @@ -6953,13 +6909,13 @@ "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { - "smithy.api#documentation": "

The name or unique ID of the stack set from which the stack was created.

\n

Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.

" + "smithy.api#documentation": "

The name or unique ID of the StackSet from which the stack was created.

\n

Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.

" } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } }, "TemplateSummaryConfig": { @@ -7188,6 +7144,16 @@ } } }, + "com.amazonaws.cloudformation#HookInvocationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, "com.amazonaws.cloudformation#HookInvocationPoint": { "type": "enum", "members": { @@ -7235,46 +7201,82 @@ "com.amazonaws.cloudformation#HookResultSummary": { "type": "structure", "members": { + "HookResultId": { + "target": "com.amazonaws.cloudformation#HookInvocationId", + "traits": { + "smithy.api#documentation": "

The unique identifier for this Hook invocation result.

" + } + }, "InvocationPoint": { "target": "com.amazonaws.cloudformation#HookInvocationPoint", "traits": { - "smithy.api#documentation": "

The exact point in the provisioning logic where the Hook runs.

" + "smithy.api#documentation": "

The specific point in the provisioning process where the Hook is invoked.

" } }, "FailureMode": { "target": "com.amazonaws.cloudformation#HookFailureMode", "traits": { - "smithy.api#documentation": "

The failure mode of the invocation. The following are potential modes:

\n
    \n
  • \n

    \n FAIL: If the hook invocation returns a failure, then the requested target\n operation should fail.

    \n
  • \n
  • \n

    \n WARN: If the hook invocation returns a failure, then the requested target\n operation should warn.

    \n
  • \n
" + "smithy.api#documentation": "

The failure mode of the invocation.

" } }, "TypeName": { "target": "com.amazonaws.cloudformation#HookTypeName", "traits": { - "smithy.api#documentation": "

The type name of the Hook being invoked.

" + "smithy.api#documentation": "

The name of the Hook that was invoked.

" } }, "TypeVersionId": { "target": "com.amazonaws.cloudformation#HookTypeVersionId", "traits": { - "smithy.api#documentation": "

The version of the Hook being invoked.

" + "smithy.api#documentation": "

The version of the Hook that was invoked.

" } }, "TypeConfigurationVersionId": { "target": "com.amazonaws.cloudformation#HookTypeConfigurationVersionId", "traits": { - "smithy.api#documentation": "

The version of the Hook type configuration.

" + "smithy.api#documentation": "

The version of the Hook configuration.

" } }, "Status": { "target": "com.amazonaws.cloudformation#HookStatus", "traits": { - "smithy.api#documentation": "

The state of the Hook invocation.

" + "smithy.api#documentation": "

The status of the Hook invocation. The following statuses are possible:

\n
    \n
  • \n

    \n HOOK_IN_PROGRESS: The Hook is currently running.

    \n
  • \n
  • \n

    \n HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

    \n
  • \n
  • \n

    \n HOOK_COMPLETE_FAILED: The Hook completed but failed\n validation.

    \n
  • \n
  • \n

    \n HOOK_FAILED: The Hook encountered an error during execution.

    \n
  • \n
" } }, "HookStatusReason": { "target": "com.amazonaws.cloudformation#HookStatusReason", "traits": { - "smithy.api#documentation": "

A description of the Hook results status. For example, if the Hook\n result is in a FAILED state, this may contain additional information for the\n FAILED state.

" + "smithy.api#documentation": "

A description of the Hook results status. For example, if the Hook\n result is in a failed state, this may contain additional information for the failed state.

" + } + }, + "InvokedAt": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the Hook was invoked.

\n

Only shown in responses when the request does not specify TargetType and\n TargetId filters.

" + } + }, + "TargetType": { + "target": "com.amazonaws.cloudformation#ListHookResultsTargetType", + "traits": { + "smithy.api#documentation": "

The target type that the Hook was invoked against.

" + } + }, + "TargetId": { + "target": "com.amazonaws.cloudformation#HookResultId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Hook invocation target.

" + } + }, + "TypeArn": { + "target": "com.amazonaws.cloudformation#HookTypeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Hook that was invoked.

" + } + }, + "HookExecutionTarget": { + "target": "com.amazonaws.cloudformation#HookResultId", + "traits": { + "smithy.api#documentation": "

The ARN of the target stack or request token of the Cloud Control API operation.

\n

Only shown in responses when the request does not specify TargetType and\n TargetId filters.

" } } }, @@ -7350,6 +7352,16 @@ } } }, + "com.amazonaws.cloudformation#HookTypeArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/[A-Za-z0-9-]+/?$" + } + }, "com.amazonaws.cloudformation#HookTypeConfigurationVersionId": { "type": "string", "traits": { @@ -7437,7 +7449,7 @@ } ], "traits": { - "smithy.api#documentation": "

Import existing stacks into a new stack sets. Use the stack import operation to import up\n to 10 stacks into a new stack set in the same account as the source stack or in a different\n administrator account and Region, by specifying the stack ID of the stack you intend to\n import.

" + "smithy.api#documentation": "

Import existing stacks into a new StackSets. Use the stack import operation to import up\n to 10 stacks into a new StackSet in the same account as the source stack or in a different\n administrator account and Region, by specifying the stack ID of the stack you intend to\n import.

" } }, "com.amazonaws.cloudformation#ImportStacksToStackSetInput": { @@ -7447,14 +7459,14 @@ "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the stack set. The name must be unique in the Region where you create your\n stack set.

", + "smithy.api#documentation": "

The name of the StackSet. The name must be unique in the Region where you create your\n StackSet.

", "smithy.api#required": {} } }, "StackIds": { "target": "com.amazonaws.cloudformation#StackIdList", "traits": { - "smithy.api#documentation": "

The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per\n stack set at a time.

\n

Specify either StackIds or StackIdsUrl.

" + "smithy.api#documentation": "

The IDs of the stacks you are importing into a StackSet. You import up to 10 stacks per\n StackSet at a time.

\n

Specify either StackIds or StackIdsUrl.

" } }, "StackIdsUrl": { @@ -7466,26 +7478,26 @@ "OrganizationalUnitIds": { "target": "com.amazonaws.cloudformation#OrganizationalUnitIdList", "traits": { - "smithy.api#documentation": "

The list of OU ID's to which the stacks being imported has to be mapped as deployment\n target.

" + "smithy.api#documentation": "

The list of OU ID's to which the imported stacks must be mapped as deployment\n targets.

" } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a stack set operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

" + "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a StackSet operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.

" } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique, user defined, identifier for the stack set operation.

", + "smithy.api#documentation": "

A unique, user defined, identifier for the StackSet operation.

", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    For service managed stack sets, specify DELEGATED_ADMIN.

    \n
  • \n
" + "smithy.api#documentation": "

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    For service managed StackSets, specify DELEGATED_ADMIN.

    \n
  • \n
" } } }, @@ -7499,7 +7511,7 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique identifier for the stack set operation.

" + "smithy.api#documentation": "

The unique identifier for the StackSet operation.

" } } }, @@ -7738,7 +7750,7 @@ "target": "com.amazonaws.cloudformation#ListExportsOutput" }, "traits": { - "smithy.api#documentation": "

Lists all exported output values in the account and Region in which you call this action.\n Use this action to see the exported output values that you can import into other stacks. To\n import values, use the \n Fn::ImportValue function.

\n

For more information, see Get exported outputs\n from a deployed CloudFormation stack.

", + "smithy.api#documentation": "

Lists all exported output values in the account and Region in which you call this action.\n Use this action to see the exported output values that you can import into other stacks. To\n import values, use the Fn::ImportValue function.

\n

For more information, see Get exported outputs\n from a deployed CloudFormation stack.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7852,7 +7864,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns summaries of invoked Hooks when a change set or Cloud Control API operation target is\n provided.

" + "smithy.api#documentation": "

Returns summaries of invoked Hooks. For more information, see View CloudFormation Hooks\n invocations in the CloudFormation Hooks User Guide.

\n

This operation supports the following parameter combinations:

\n
    \n
  • \n

    No parameters: Returns all Hook invocation summaries.

    \n
  • \n
  • \n

    \n TypeArn only: Returns summaries for a specific Hook.

    \n
  • \n
  • \n

    \n TypeArn and Status: Returns summaries for a specific\n Hook filtered by status.

    \n
  • \n
  • \n

    \n TargetId and TargetType: Returns summaries for a specific\n Hook invocation target.

    \n
  • \n
" } }, "com.amazonaws.cloudformation#ListHookResultsInput": { @@ -7861,17 +7873,25 @@ "TargetType": { "target": "com.amazonaws.cloudformation#ListHookResultsTargetType", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of operation being targeted by the Hook.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Filters results by target type. Currently, only CHANGE_SET and\n CLOUD_CONTROL are supported filter options.

\n

Required when TargetId is specified and cannot be used otherwise.

" } }, "TargetId": { "target": "com.amazonaws.cloudformation#HookResultId", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The logical ID of the target the operation is acting on by the Hook. If the\n target is a change set, it's the ARN of the change set.

\n

If the target is a Cloud Control API operation, this will be the HookRequestToken\n returned by the Cloud Control API operation request. For more information on the\n HookRequestToken, see ProgressEvent.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Filters results by the unique identifier of the target the Hook was invoked\n against.

\n

For change sets, this is the change set ARN. When the target is a Cloud Control API operation, this\n value must be the HookRequestToken returned by the Cloud Control API request. For more\n information on the HookRequestToken, see ProgressEvent.

\n

Required when TargetType is specified and cannot be used otherwise.

" + } + }, + "TypeArn": { + "target": "com.amazonaws.cloudformation#HookTypeArn", + "traits": { + "smithy.api#documentation": "

Filters results by the ARN of the Hook. Can be used alone or in combination with\n Status.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudformation#HookStatus", + "traits": { + "smithy.api#documentation": "

Filters results by the status of Hook invocations. Can only be used in\n combination with TypeArn. Valid values are:

\n
    \n
  • \n

    \n HOOK_IN_PROGRESS: The Hook is currently running.

    \n
  • \n
  • \n

    \n HOOK_COMPLETE_SUCCEEDED: The Hook completed\n successfully.

    \n
  • \n
  • \n

    \n HOOK_COMPLETE_FAILED: The Hook completed but failed\n validation.

    \n
  • \n
  • \n

    \n HOOK_FAILED: The Hook encountered an error during\n execution.

    \n
  • \n
" } }, "NextToken": { @@ -7891,13 +7911,13 @@ "TargetType": { "target": "com.amazonaws.cloudformation#ListHookResultsTargetType", "traits": { - "smithy.api#documentation": "

The type of operation being targeted by the Hook.

" + "smithy.api#documentation": "

The target type.

" } }, "TargetId": { "target": "com.amazonaws.cloudformation#HookResultId", "traits": { - "smithy.api#documentation": "

The logical ID of the target the operation is acting on by the Hook. If the\n target is a change set, it's the ARN of the change set.

\n

If the target is a Cloud Control API operation, this will be the HooksRequestToken\n returned by the Cloud Control API operation request. For more information on the\n HooksRequestToken, see ProgressEvent.

" + "smithy.api#documentation": "

The unique identifier of the Hook invocation target.

" } }, "HookResults": { @@ -7955,7 +7975,7 @@ "target": "com.amazonaws.cloudformation#ListImportsOutput" }, "traits": { - "smithy.api#documentation": "

Lists all stacks that are importing an exported output value. To modify or remove an\n exported output value, first use this action to see which stacks are using it. To see the\n exported output values in your account, see ListExports.

\n

For more information about importing an exported output value, see the Fn::ImportValue function.

", + "smithy.api#documentation": "

Lists all stacks that are importing an exported output value. To modify or remove an\n exported output value, first use this action to see which stacks are using it. To see the\n exported output values in your account, see ListExports.

\n

For more information about importing an exported output value, see the Fn::ImportValue function.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8392,7 +8412,7 @@ "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to list drifted resources for.

", + "smithy.api#documentation": "

The name or unique ID of the StackSet that you want to list drifted resources for.

", "smithy.api#required": {} } }, @@ -8441,7 +8461,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } } }, @@ -8483,7 +8503,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns summary information about stack instances that are associated with the specified\n stack set. You can filter for stack instances that are associated with a specific\n Amazon Web Services account name or Region, or that have a specific status.

", + "smithy.api#documentation": "

Returns summary information about stack instances that are associated with the specified\n StackSet. You can filter for stack instances that are associated with a specific Amazon Web Services account\n name or Region, or that have a specific status.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8499,7 +8519,7 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to list stack instances for.

", + "smithy.api#documentation": "

The name or unique ID of the StackSet that you want to list stack instances for.

", "smithy.api#required": {} } }, @@ -8536,7 +8556,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } } }, @@ -8773,7 +8793,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns summary information about deployment targets for a stack set.

" + "smithy.api#documentation": "

Returns summary information about deployment targets for a StackSet.

" } }, "com.amazonaws.cloudformation#ListStackSetAutoDeploymentTargetsInput": { @@ -8783,14 +8803,14 @@ "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to get automatic deployment targets\n for.

", + "smithy.api#documentation": "

The name or unique ID of the StackSet that you want to get automatic deployment targets\n for.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

A string that identifies the next page of stack set deployment targets that you want to\n retrieve.

" + "smithy.api#documentation": "

A string that identifies the next page of deployment targets that you want to\n retrieve.

" } }, "MaxResults": { @@ -8816,7 +8836,7 @@ "Summaries": { "target": "com.amazonaws.cloudformation#StackSetAutoDeploymentTargetSummaries", "traits": { - "smithy.api#documentation": "

An array of summaries of the deployment targets for the stack set.

" + "smithy.api#documentation": "

An array of summaries of the deployment targets for the StackSet.

" } }, "NextToken": { @@ -8847,7 +8867,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns summary information about the results of a stack set operation.

\n \n

This API provides eventually consistent reads meaning it may take\n some time but will eventually return the most up-to-date data.

\n
", + "smithy.api#documentation": "

Returns summary information about the results of a StackSet operation.

\n \n

This API provides eventually consistent reads meaning it may take\n some time but will eventually return the most up-to-date data.

\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8863,7 +8883,7 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to get operation results for.

", + "smithy.api#documentation": "

The name or unique ID of the StackSet that you want to get operation results for.

", "smithy.api#required": {} } }, @@ -8871,7 +8891,7 @@ "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the stack set operation.

", + "smithy.api#documentation": "

The ID of the StackSet operation.

", "smithy.api#required": {} } }, @@ -8890,7 +8910,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } }, "Filters": { @@ -8938,7 +8958,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns summary information about operations performed on a stack set.

\n \n

This API provides eventually consistent reads meaning it may take\n some time but will eventually return the most up-to-date data.

\n
", + "smithy.api#documentation": "

Returns summary information about operations performed on a StackSet.

\n \n

This API provides eventually consistent reads meaning it may take\n some time but will eventually return the most up-to-date data.

\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8954,7 +8974,7 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to get operation summaries\n for.

", + "smithy.api#documentation": "

The name or unique ID of the StackSet that you want to get operation summaries for.

", "smithy.api#required": {} } }, @@ -8973,7 +8993,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } } }, @@ -8987,7 +9007,7 @@ "Summaries": { "target": "com.amazonaws.cloudformation#StackSetOperationSummaries", "traits": { - "smithy.api#documentation": "

A list of StackSetOperationSummary structures that contain summary\n information about operations for the specified stack set.

" + "smithy.api#documentation": "

A list of StackSetOperationSummary structures that contain summary\n information about operations for the specified StackSet.

" } }, "NextToken": { @@ -9010,7 +9030,7 @@ "target": "com.amazonaws.cloudformation#ListStackSetsOutput" }, "traits": { - "smithy.api#documentation": "

Returns summary information about stack sets that are associated with the user.

\n \n

This API provides strongly consistent reads meaning it will always\n return the most up-to-date data.

\n
\n
    \n
  • \n

    [Self-managed permissions] If you set the CallAs parameter to\n SELF while signed in to your Amazon Web Services account, ListStackSets\n returns all self-managed stack sets in your Amazon Web Services account.

    \n
  • \n
  • \n

    [Service-managed permissions] If you set the CallAs parameter to\n SELF while signed in to the organization's management account,\n ListStackSets returns all stack sets in the management account.

    \n
  • \n
  • \n

    [Service-managed permissions] If you set the CallAs parameter to\n DELEGATED_ADMIN while signed in to your member account,\n ListStackSets returns all stack sets with service-managed permissions in\n the management account.

    \n
  • \n
", + "smithy.api#documentation": "

Returns summary information about StackSets that are associated with the user.

\n \n

This API provides strongly consistent reads meaning it will always\n return the most up-to-date data.

\n
\n
    \n
  • \n

    [Self-managed permissions] If you set the CallAs parameter to\n SELF while signed in to your Amazon Web Services account, ListStackSets\n returns all self-managed StackSets in your Amazon Web Services account.

    \n
  • \n
  • \n

    [Service-managed permissions] If you set the CallAs parameter to\n SELF while signed in to the organization's management account,\n ListStackSets returns all StackSets in the management account.

    \n
  • \n
  • \n

    [Service-managed permissions] If you set the CallAs parameter to\n DELEGATED_ADMIN while signed in to your member account,\n ListStackSets returns all StackSets with service-managed permissions in the\n management account.

    \n
  • \n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9037,13 +9057,13 @@ "Status": { "target": "com.amazonaws.cloudformation#StackSetStatus", "traits": { - "smithy.api#documentation": "

The status of the stack sets that you want to get summary information about.

" + "smithy.api#documentation": "

The status of the StackSets that you want to get summary information about.

" } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the management account or as a delegated administrator in a member\n account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the management account or as a delegated administrator in a member\n account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } } }, @@ -9057,7 +9077,7 @@ "Summaries": { "target": "com.amazonaws.cloudformation#StackSetSummaries", "traits": { - "smithy.api#documentation": "

A list of StackSetSummary structures that contain information about the\n user's stack sets.

" + "smithy.api#documentation": "

A list of StackSetSummary structures that contain information about the\n user's StackSets.

" } }, "NextToken": { @@ -9337,7 +9357,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns summary information about extension that have been registered with\n CloudFormation.

", + "smithy.api#documentation": "

Returns summary information about all extensions, including your private resource types,\n modules, and Hooks as well as all public extensions from Amazon Web Services and third-party\n publishers.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -9487,7 +9507,7 @@ "Active": { "target": "com.amazonaws.cloudformation#ManagedExecutionNullable", "traits": { - "smithy.api#documentation": "

When true, StackSets performs non-conflicting operations concurrently and\n queues conflicting operations. After conflicting operations finish, StackSets starts queued\n operations in request order.

\n \n

If there are already running or queued operations, StackSets queues all incoming operations\n even if they are non-conflicting.

\n

You can't modify your stack set's execution configuration while there are running or queued\n operations for that stack set.

\n
\n

When false (default), StackSets performs one operation at a time in request\n order.

" + "smithy.api#documentation": "

When true, CloudFormation performs non-conflicting operations concurrently and\n queues conflicting operations. After conflicting operations finish, CloudFormation starts queued\n operations in request order.

\n \n

If there are already running or queued operations, CloudFormation queues all incoming\n operations even if they are non-conflicting.

\n

You can't modify your StackSet's execution configuration while there are running or queued\n operations for that StackSet.

\n
\n

When false (default), StackSets performs one operation at a time in request\n order.

" } } }, @@ -9683,7 +9703,7 @@ "code": "OperationInProgressException", "httpResponseCode": 409 }, - "smithy.api#documentation": "

Another operation is currently in progress for this stack set. Only one operation can be performed for a stack\n set at a given time.

", + "smithy.api#documentation": "

Another operation is currently in progress for this StackSet. Only one operation can be performed for a stack\n set at a given time.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -11724,7 +11744,7 @@ } }, "traits": { - "smithy.api#documentation": "

Structure that contains the rollback triggers for CloudFormation to monitor during stack creation\n and updating operations, and for the specified monitoring period afterwards.

\n

Rollback triggers enable you to have CloudFormation monitor the state of your application during\n stack creation and updating, and to roll back that operation if the application breaches the\n threshold of any of the alarms you've specified. For more information, see Roll back your CloudFormation stack on alarm breach with rollback triggers.

" + "smithy.api#documentation": "

Structure that contains the rollback triggers for CloudFormation to monitor during stack\n creation and updating operations, and for the specified monitoring period afterwards.

\n

Rollback triggers enable you to have CloudFormation monitor the state of your application during\n stack creation and updating, and to roll back that operation if the application breaches the\n threshold of any of the alarms you've specified. For more information, see Roll back your CloudFormation stack on alarm breach with rollback triggers.

" } }, "com.amazonaws.cloudformation#RollbackStack": { @@ -12312,13 +12332,13 @@ "ParentId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

For nested stacks, the stack ID of the direct\n parent of this stack. For the first level of nested stacks, the root stack is also the parent\n stack.

\n

For more information, see Nested stacks in the CloudFormation User Guide.

" + "smithy.api#documentation": "

For nested stacks, the stack ID of the direct parent of this stack. For the first level of\n nested stacks, the root stack is also the parent stack.

\n

For more information, see Nested stacks in\n the CloudFormation User Guide.

" } }, "RootId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

For nested stacks, the stack ID of the\n top-level stack to which the nested stack ultimately belongs.

\n

For more information, see Nested stacks in the CloudFormation User Guide.

" + "smithy.api#documentation": "

For nested stacks, the stack ID of the top-level stack to which the nested stack ultimately\n belongs.

\n

For more information, see Nested stacks in\n the CloudFormation User Guide.

" } }, "DriftInformation": { @@ -12342,7 +12362,7 @@ "DetailedStatus": { "target": "com.amazonaws.cloudformation#DetailedStatus", "traits": { - "smithy.api#documentation": "

The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is\n present, the resource or resource configuration phase has completed and the stabilization of the\n resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the\n resources in the stack have reached that event. For more information, see Understand\n CloudFormation stack creation events in the CloudFormation User Guide.

" + "smithy.api#documentation": "

The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is\n present, the resource or resource configuration phase has completed and the stabilization of the\n resources is in progress. The StackSets CONFIGURATION_COMPLETE when all of the\n resources in the stack have reached that event. For more information, see Understand\n CloudFormation stack creation events in the CloudFormation User Guide.

" } } }, @@ -12424,7 +12444,7 @@ "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected template\n configuration.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from its expected template configuration. A stack\n is considered to have drifted if one or more of its resources have drifted.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected\n template configuration.

    \n
  • \n
  • \n

    \n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.

    \n
  • \n
  • \n

    \n UNKNOWN: CloudFormation could not run drift detection for a resource in the stack.

    \n
  • \n
", + "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected template\n configuration.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from its expected template configuration. A stack\n is considered to have drifted if one or more of its resources have drifted.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected\n template configuration.

    \n
  • \n
  • \n

    \n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.

    \n
  • \n
  • \n

    \n UNKNOWN: CloudFormation could not run drift detection for a resource in the\n stack.

    \n
  • \n
", "smithy.api#required": {} } }, @@ -12446,7 +12466,7 @@ "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected template\n configuration.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from its expected template configuration. A stack\n is considered to have drifted if one or more of its resources have drifted.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected\n template configuration.

    \n
  • \n
  • \n

    \n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.

    \n
  • \n
  • \n

    \n UNKNOWN: CloudFormation could not run drift detection for a resource in the stack.

    \n
  • \n
", + "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected template\n configuration.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from its expected template configuration. A stack\n is considered to have drifted if one or more of its resources have drifted.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected\n template configuration.

    \n
  • \n
  • \n

    \n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.

    \n
  • \n
  • \n

    \n UNKNOWN: CloudFormation could not run drift detection for a resource in the\n stack.

    \n
  • \n
", "smithy.api#required": {} } }, @@ -12505,7 +12525,7 @@ "target": "com.amazonaws.cloudformation#EventId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The unique ID of this event.

", + "smithy.api#documentation": "

The unique identifier of this event.

", "smithy.api#required": {} } }, @@ -12570,31 +12590,37 @@ "HookType": { "target": "com.amazonaws.cloudformation#HookType", "traits": { - "smithy.api#documentation": "

The name of the hook.

" + "smithy.api#documentation": "

The name of the Hook.

" } }, "HookStatus": { "target": "com.amazonaws.cloudformation#HookStatus", "traits": { - "smithy.api#documentation": "

Provides the status of the change set hook.

" + "smithy.api#documentation": "

Provides the status of the change set Hook.

" } }, "HookStatusReason": { "target": "com.amazonaws.cloudformation#HookStatusReason", "traits": { - "smithy.api#documentation": "

Provides the reason for the hook status.

" + "smithy.api#documentation": "

Provides the reason for the Hook status.

" } }, "HookInvocationPoint": { "target": "com.amazonaws.cloudformation#HookInvocationPoint", "traits": { - "smithy.api#documentation": "

Invocation points are points in provisioning logic where Hooks are initiated.

" + "smithy.api#documentation": "

The specific point in the provisioning process where the Hook is invoked.

" + } + }, + "HookInvocationId": { + "target": "com.amazonaws.cloudformation#HookInvocationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Hook invocation.

" } }, "HookFailureMode": { "target": "com.amazonaws.cloudformation#HookFailureMode", "traits": { - "smithy.api#documentation": "

Specify the hook failure mode for non-compliant resources in the followings ways.

\n
    \n
  • \n

    \n FAIL Stops provisioning resources.

    \n
  • \n
  • \n

    \n WARN Allows provisioning to continue with a warning message.

    \n
  • \n
" + "smithy.api#documentation": "

Specify the Hook failure mode for non-compliant resources in the followings\n ways.

\n
    \n
  • \n

    \n FAIL Stops provisioning resources.

    \n
  • \n
  • \n

    \n WARN Allows provisioning to continue with a warning message.

    \n
  • \n
" } }, "DetailedStatus": { @@ -12645,7 +12671,7 @@ "StackSetId": { "target": "com.amazonaws.cloudformation#StackSetId", "traits": { - "smithy.api#documentation": "

The name or unique ID of the stack set that the stack instance is associated with.

" + "smithy.api#documentation": "

The name or unique ID of the StackSet that the stack instance is associated with.

" } }, "Region": { @@ -12669,13 +12695,13 @@ "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

A list of parameters from the stack set template whose values have been overridden in this\n stack instance.

" + "smithy.api#documentation": "

A list of parameters from the StackSet template whose values have been overridden in this\n stack instance.

" } }, "Status": { "target": "com.amazonaws.cloudformation#StackInstanceStatus", "traits": { - "smithy.api#documentation": "

The status of the stack instance, in terms of its synchronization with its associated stack\n set.

\n
    \n
  • \n

    \n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.\n INOPERABLE can be returned here when the cause is a failed import. If it's due to\n a failed import, the operation can be retried once the failures are fixed. To see if this is\n due to a failed import, look at the DetailedStatus member in the\n StackInstanceSummary member that is a peer to this Status\n member.

    \n
  • \n
  • \n

    \n OUTDATED: The stack isn't currently up to date with the stack set\n because:

    \n
      \n
    • \n

      The associated stack failed during a CreateStackSet or\n UpdateStackSet operation.

      \n
    • \n
    • \n

      The stack was part of a CreateStackSet or UpdateStackSet\n operation that failed or was stopped before the stack was created or updated.

      \n
    • \n
    \n
  • \n
  • \n

    \n CURRENT: The stack is currently up to date with the stack set.

    \n
  • \n
" + "smithy.api#documentation": "

The status of the stack instance, in terms of its synchronization with its associated stack\n set.

\n
    \n
  • \n

    \n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.\n INOPERABLE can be returned here when the cause is a failed import. If it's due to\n a failed import, the operation can be retried once the failures are fixed. To see if this is\n due to a failed import, look at the DetailedStatus member in the\n StackInstanceSummary member that is a peer to this Status\n member.

    \n
  • \n
  • \n

    \n OUTDATED: The stack isn't currently up to date with the StackSet\n because:

    \n
      \n
    • \n

      The associated stack failed during a CreateStackSet or\n UpdateStackSet operation.

      \n
    • \n
    • \n

      The stack was part of a CreateStackSet or UpdateStackSet\n operation that failed or was stopped before the stack was created or updated.

      \n
    • \n
    \n
  • \n
  • \n

    \n CURRENT: The stack is currently up to date with the StackSet.

    \n
  • \n
" } }, "StackInstanceStatus": { @@ -12699,13 +12725,13 @@ "DriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { - "smithy.api#documentation": "

Status of the stack instance's actual configuration compared to the expected template and\n parameter configuration of the stack set to which it belongs.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from the expected template and parameter\n configuration of the stack set to which it belongs. A stack instance is considered to have\n drifted if one or more of the resources in the associated stack have drifted.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its\n expected stack set configuration.

    \n
  • \n
  • \n

    \n IN_SYNC: The stack instance's actual configuration matches its expected stack\n set configuration.

    \n
  • \n
  • \n

    \n UNKNOWN: This value is reserved for future use.

    \n
  • \n
" + "smithy.api#documentation": "

Status of the stack instance's actual configuration compared to the expected template and\n parameter configuration of the StackSet it belongs to.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from the expected template and parameter\n configuration of the StackSet it belongs to. A stack instance is considered to have drifted if\n one or more of the resources in the associated stack have drifted.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its\n expected StackSet configuration.

    \n
  • \n
  • \n

    \n IN_SYNC: The stack instance's actual configuration matches its expected\n StackSset configuration.

    \n
  • \n
  • \n

    \n UNKNOWN: This value is reserved for future use.

    \n
  • \n
" } }, "LastDriftCheckTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

Most recent time when CloudFormation performed a drift detection operation on the stack\n instance. This value will be NULL for any stack instance on which drift detection\n hasn't yet been performed.

" + "smithy.api#documentation": "

Most recent time when CloudFormation performed a drift detection operation on the stack\n instance. This value will be NULL for any stack instance that drift detection hasn't\n yet been performed on.

" } }, "LastOperationId": { @@ -12716,7 +12742,7 @@ } }, "traits": { - "smithy.api#documentation": "

A CloudFormation stack, in a specific account and Region, that's part of a stack set operation.\n A stack instance is a reference to an attempted or actual stack in a given account within a given\n Region. A stack instance can exist without a stack—for example, if the stack couldn't be created\n for some reason. A stack instance is associated with only one stack set. Each stack instance\n contains the ID of its associated stack set, in addition to the ID of the actual stack and the\n stack status.

" + "smithy.api#documentation": "

A CloudFormation stack, in a specific account and Region, that's part of a StackSet operation. A\n stack instance is a reference to an attempted or actual stack in a given account within a given\n Region. A stack instance can exist without a stack—for example, if the stack couldn't be created\n for some reason. A stack instance is associated with only one StackSet. Each stack instance\n contains the ID of its associated StackSet, in addition to the ID of the actual stack and the\n stack status.

" } }, "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus": { @@ -12725,7 +12751,7 @@ "DetailedStatus": { "target": "com.amazonaws.cloudformation#StackInstanceDetailedStatus", "traits": { - "smithy.api#documentation": "
    \n
  • \n

    \n CANCELLED: The operation in the specified account and Region has been\n canceled. This is either because a user has stopped the stack set operation, or because the\n failure tolerance of the stack set operation has been exceeded.

    \n
  • \n
  • \n

    \n FAILED: The operation in the specified account and Region failed. If the\n stack set operation fails in enough accounts within a Region, the failure tolerance for the\n stack set operation as a whole might be exceeded.

    \n
  • \n
  • \n

    \n FAILED_IMPORT: The import of the stack instance in the specified account and\n Region failed and left the stack in an unstable state. Once the issues causing the failure are\n fixed, the import operation can be retried. If enough stack set operations fail in enough\n accounts within a Region, the failure tolerance for the stack set operation as a whole might be\n exceeded.

    \n
  • \n
  • \n

    \n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.

    \n
  • \n
  • \n

    \n PENDING: The operation in the specified account and Region has yet to\n start.

    \n
  • \n
  • \n

    \n RUNNING: The operation in the specified account and Region is currently in\n progress.

    \n
  • \n
  • \n

    \n SKIPPED_SUSPENDED_ACCOUNT: The operation in the specified account and Region\n has been skipped because the account was suspended at the time of the operation.

    \n
  • \n
  • \n

    \n SUCCEEDED: The operation in the specified account and Region completed\n successfully.

    \n
  • \n
" + "smithy.api#documentation": "
    \n
  • \n

    \n CANCELLED: The operation in the specified account and Region has been\n canceled. This is either because a user has stopped the StackSet operation, or because the\n failure tolerance of the StackSet operation has been exceeded.

    \n
  • \n
  • \n

    \n FAILED: The operation in the specified account and Region failed. If the\n StackSet operation fails in enough accounts within a Region, the failure tolerance for the\n StackSet operation as a whole might be exceeded.

    \n
  • \n
  • \n

    \n FAILED_IMPORT: The import of the stack instance in the specified account and\n Region failed and left the stack in an unstable state. Once the issues causing the failure are\n fixed, the import operation can be retried. If enough StackSet operations fail in enough\n accounts within a Region, the failure tolerance for the StackSet operation as a whole might be\n exceeded.

    \n
  • \n
  • \n

    \n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.

    \n
  • \n
  • \n

    \n PENDING: The operation in the specified account and Region has yet to\n start.

    \n
  • \n
  • \n

    \n RUNNING: The operation in the specified account and Region is currently in\n progress.

    \n
  • \n
  • \n

    \n SKIPPED_SUSPENDED_ACCOUNT: The operation in the specified account and Region\n has been skipped because the account was suspended at the time of the operation.

    \n
  • \n
  • \n

    \n SUCCEEDED: The operation in the specified account and Region completed\n successfully.

    \n
  • \n
" } } }, @@ -12975,7 +13001,7 @@ "StackSetId": { "target": "com.amazonaws.cloudformation#StackSetId", "traits": { - "smithy.api#documentation": "

The name or unique ID of the stack set that the stack instance is associated with.

" + "smithy.api#documentation": "

The name or unique ID of the StackSet that the stack instance is associated with.

" } }, "Region": { @@ -12999,7 +13025,7 @@ "Status": { "target": "com.amazonaws.cloudformation#StackInstanceStatus", "traits": { - "smithy.api#documentation": "

The status of the stack instance, in terms of its synchronization with its associated stack\n set.

\n
    \n
  • \n

    \n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.\n INOPERABLE can be returned here when the cause is a failed import. If it's due to\n a failed import, the operation can be retried once the failures are fixed. To see if this is\n due to a failed import, call the DescribeStackInstance API operation, look at\n the DetailedStatus member returned in the StackInstanceSummary\n member.

    \n
  • \n
  • \n

    \n OUTDATED: The stack isn't currently up to date with the stack set\n because:

    \n
      \n
    • \n

      The associated stack failed during a CreateStackSet or\n UpdateStackSet operation.

      \n
    • \n
    • \n

      The stack was part of a CreateStackSet or UpdateStackSet\n operation that failed or was stopped before the stack was created or updated.

      \n
    • \n
    \n
  • \n
  • \n

    \n CURRENT: The stack is currently up to date with the stack set.

    \n
  • \n
" + "smithy.api#documentation": "

The status of the stack instance, in terms of its synchronization with its associated stack\n set.

\n
    \n
  • \n

    \n INOPERABLE: A DeleteStackInstances operation has failed and left\n the stack in an unstable state. Stacks in this state are excluded from further\n UpdateStackSet operations. You might need to perform a\n DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.\n INOPERABLE can be returned here when the cause is a failed import. If it's due to\n a failed import, the operation can be retried once the failures are fixed. To see if this is\n due to a failed import, call the DescribeStackInstance API operation, look at\n the DetailedStatus member returned in the StackInstanceSummary\n member.

    \n
  • \n
  • \n

    \n OUTDATED: The stack isn't currently up to date with the StackSet\n because:

    \n
      \n
    • \n

      The associated stack failed during a CreateStackSet or\n UpdateStackSet operation.

      \n
    • \n
    • \n

      The stack was part of a CreateStackSet or UpdateStackSet\n operation that failed or was stopped before the stack was created or updated.

      \n
    • \n
    \n
  • \n
  • \n

    \n CURRENT: The stack is currently up to date with the StackSet.

    \n
  • \n
" } }, "StatusReason": { @@ -13023,13 +13049,13 @@ "DriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { - "smithy.api#documentation": "

Status of the stack instance's actual configuration compared to the expected template and\n parameter configuration of the stack set to which it belongs.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from the expected template and parameter\n configuration of the stack set to which it belongs. A stack instance is considered to have\n drifted if one or more of the resources in the associated stack have drifted.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its\n expected stack set configuration.

    \n
  • \n
  • \n

    \n IN_SYNC: The stack instance's actual configuration matches its expected stack\n set configuration.

    \n
  • \n
  • \n

    \n UNKNOWN: This value is reserved for future use.

    \n
  • \n
" + "smithy.api#documentation": "

Status of the stack instance's actual configuration compared to the expected template and\n parameter configuration of the StackSet it belongs to.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from the expected template and parameter\n configuration of the StackSet it belongs to. A stack instance is considered to have drifted if\n one or more of the resources in the associated stack have drifted.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its\n expected StackSet configuration.

    \n
  • \n
  • \n

    \n IN_SYNC: The stack instance's actual configuration matches its expected\n StackSet configuration.

    \n
  • \n
  • \n

    \n UNKNOWN: This value is reserved for future use.

    \n
  • \n
" } }, "LastDriftCheckTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

Most recent time when CloudFormation performed a drift detection operation on the stack\n instance. This value will be NULL for any stack instance on which drift detection\n hasn't yet been performed.

" + "smithy.api#documentation": "

Most recent time when CloudFormation performed a drift detection operation on the stack\n instance. This value will be NULL for any stack instance that drift detection hasn't\n yet been performed on.

" } }, "LastOperationId": { @@ -13639,7 +13665,7 @@ "ExpectedProperties": { "target": "com.amazonaws.cloudformation#Properties", "traits": { - "smithy.api#documentation": "

A JSON structure that contains the expected property values of the stack resource, as defined\n in the stack template and any values specified as template parameters.

\n

For resources whose StackResourceDriftStatus is DELETED, this\n structure will not be present.

" + "smithy.api#documentation": "

A JSON structure that contains the expected property values of the stack resource, as\n defined in the stack template and any values specified as template parameters.

\n

For resources whose StackResourceDriftStatus is DELETED, this\n structure will not be present.

" } }, "ActualProperties": { @@ -13658,7 +13684,7 @@ "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Status of the resource's actual configuration compared to its expected configuration.

\n
    \n
  • \n

    \n DELETED: The resource differs from its expected template configuration\n because the resource has been deleted.

    \n
  • \n
  • \n

    \n MODIFIED: One or more resource properties differ from their expected values\n (as defined in the stack template and any values specified as template parameters).

    \n
  • \n
  • \n

    \n IN_SYNC: The resource's actual configuration matches its expected template\n configuration.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation does not currently return this value.

    \n
  • \n
  • \n

    \n UNKNOWN: CloudFormation could not run drift detection for the resource. See the DriftStatusReason for details.

    \n
  • \n
", + "smithy.api#documentation": "

Status of the resource's actual configuration compared to its expected configuration.

\n
    \n
  • \n

    \n DELETED: The resource differs from its expected template configuration\n because the resource has been deleted.

    \n
  • \n
  • \n

    \n MODIFIED: One or more resource properties differ from their expected values\n (as defined in the stack template and any values specified as template parameters).

    \n
  • \n
  • \n

    \n IN_SYNC: The resource's actual configuration matches its expected template\n configuration.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation does not currently return this value.

    \n
  • \n
  • \n

    \n UNKNOWN: CloudFormation could not run drift detection for the resource. See the\n DriftStatusReason for details.

    \n
  • \n
", "smithy.api#required": {} } }, @@ -13869,85 +13895,85 @@ "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetName", "traits": { - "smithy.api#documentation": "

The name that's associated with the stack set.

" + "smithy.api#documentation": "

The name that's associated with the StackSet.

" } }, "StackSetId": { "target": "com.amazonaws.cloudformation#StackSetId", "traits": { - "smithy.api#documentation": "

The ID of the stack set.

" + "smithy.api#documentation": "

The ID of the StackSet.

" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "

A description of the stack set that you specify when the stack set is created or\n updated.

" + "smithy.api#documentation": "

A description of the StackSet that you specify when the StackSet is created or\n updated.

" } }, "Status": { "target": "com.amazonaws.cloudformation#StackSetStatus", "traits": { - "smithy.api#documentation": "

The status of the stack set.

" + "smithy.api#documentation": "

The status of the StackSet.

" } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

The structure that contains the body of the template that was used to create or update the\n stack set.

" + "smithy.api#documentation": "

The structure that contains the body of the template that was used to create or update the\n StackSet.

" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

A list of input parameters for a stack set.

" + "smithy.api#documentation": "

A list of input parameters for a StackSet.

" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

The capabilities that are allowed in the stack set. Some stack set templates might include\n resources that can affect permissions in your Amazon Web Services account—for example, by creating new\n Identity and Access Management (IAM) users. For more information, see Acknowledging IAM resources in CloudFormation templates.

" + "smithy.api#documentation": "

The capabilities that are allowed in the StackSet. Some StackSet templates might include\n resources that can affect permissions in your Amazon Web Services account—for example, by creating new\n Identity and Access Management (IAM) users. For more information, see Acknowledging IAM resources in CloudFormation templates.

" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "

A list of tags that specify information about the stack set. A maximum number of 50 tags can\n be specified.

" + "smithy.api#documentation": "

A list of tags that specify information about the StackSet. A maximum number of 50 tags can\n be specified.

" } }, "StackSetARN": { "target": "com.amazonaws.cloudformation#StackSetARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stack set.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the StackSet.

" } }, "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to create or update the stack\n set.

\n

Use customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Prerequisites for using CloudFormation StackSets in the\n CloudFormation User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to create or update the stack\n set.

\n

Use customized administrator roles to control which users or groups can manage specific\n StackSets within the same administrator account. For more information, see Prerequisites for using CloudFormation StackSets in the\n CloudFormation User Guide.

" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "

The name of the IAM execution role used to create or update the stack set.

\n

Use customized execution roles to control which stack resources users and groups can include\n in their stack sets.

" + "smithy.api#documentation": "

The name of the IAM execution role used to create or update the StackSet.

\n

Use customized execution roles to control which stack resources users and groups can include\n in their StackSets.

" } }, "StackSetDriftDetectionDetails": { "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", "traits": { - "smithy.api#documentation": "

Detailed information about the drift status of the stack set.

\n

For stack sets, contains information about the last completed drift\n operation performed on the stack set. Information about drift operations currently in progress\n isn't included.

" + "smithy.api#documentation": "

Detailed information about the drift status of the StackSet.

\n

For StackSets, contains information about the last completed drift\n operation performed on the StackSet. Information about drift operations currently in progress\n isn't included.

" } }, "AutoDeployment": { "target": "com.amazonaws.cloudformation#AutoDeployment", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit\n (OU).

" + "smithy.api#documentation": "

Describes whether StackSets automatically deploys to Organizations accounts that are\n added to a target organization or organizational unit (OU). Valid only if the StackSet uses\n service-managed permissions.

" } }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { - "smithy.api#documentation": "

Describes how the IAM roles required for stack set operations are created.

\n " + "smithy.api#documentation": "

Describes how the IAM roles required for StackSet operations are created.

\n " } }, "OrganizationalUnitIds": { @@ -13970,7 +13996,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that contains information about a stack set. A stack set enables you to\n provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation template. In\n the stack set, you specify the template to use, in addition to any parameters and capabilities\n that the template requires.

" + "smithy.api#documentation": "

A structure that contains information about a StackSet. With StackSets, you can provision\n stacks across Amazon Web Services accounts and Regions from a single CloudFormation template. Each stack is based\n on the same CloudFormation template, but you can customize individual stacks using parameters.

" } }, "com.amazonaws.cloudformation#StackSetARN": { @@ -13988,7 +14014,7 @@ "OrganizationalUnitId": { "target": "com.amazonaws.cloudformation#OrganizationalUnitId", "traits": { - "smithy.api#documentation": "

The organization root ID or organizational unit (OU) IDs where the stack set is\n targeted.

" + "smithy.api#documentation": "

The organization root ID or organizational unit (OU) IDs where the StackSet is\n targeted.

" } }, "Regions": { @@ -13999,7 +14025,7 @@ } }, "traits": { - "smithy.api#documentation": "

One of the targets for the stack set. Returned by the ListStackSetAutoDeploymentTargets API operation.

" + "smithy.api#documentation": "

One of the targets for the StackSet. Returned by the ListStackSetAutoDeploymentTargets API operation.

" } }, "com.amazonaws.cloudformation#StackSetDriftDetectionDetails": { @@ -14008,37 +14034,37 @@ "DriftStatus": { "target": "com.amazonaws.cloudformation#StackSetDriftStatus", "traits": { - "smithy.api#documentation": "

Status of the stack set's actual configuration compared to its expected template and\n parameter configuration. A stack set is considered to have drifted if one or more of its stack\n instances have drifted from their expected template and parameter configuration.

\n
    \n
  • \n

    \n DRIFTED: One or more of the stack instances belonging to the stack set stack\n differs from the expected template and parameter configuration. A stack instance is considered\n to have drifted if one or more of the resources in the associated stack have drifted.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.

    \n
  • \n
  • \n

    \n IN_SYNC: All of the stack instances belonging to the stack set stack match\n from the expected template and parameter configuration.

    \n
  • \n
" + "smithy.api#documentation": "

Status of the StackSet's actual configuration compared to its expected template and\n parameter configuration.

\n
    \n
  • \n

    \n DRIFTED: One or more of the stack instances belonging to the StackSet differs\n from the expected template and parameter configuration. A stack instance is considered to have\n drifted if one or more of the resources in the associated stack have drifted.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked the StackSet for drift.

    \n
  • \n
  • \n

    \n IN_SYNC: All of the stack instances belonging to the StackSet stack match the\n expected template and parameter configuration.

    \n
  • \n
" } }, "DriftDetectionStatus": { "target": "com.amazonaws.cloudformation#StackSetDriftDetectionStatus", "traits": { - "smithy.api#documentation": "

The status of the stack set drift detection operation.

\n
    \n
  • \n

    \n COMPLETED: The drift detection operation completed without failing on any\n stack instances.

    \n
  • \n
  • \n

    \n FAILED: The drift detection operation exceeded the specified failure\n tolerance.

    \n
  • \n
  • \n

    \n PARTIAL_SUCCESS: The drift detection operation completed without exceeding\n the failure tolerance for the operation.

    \n
  • \n
  • \n

    \n IN_PROGRESS: The drift detection operation is currently being\n performed.

    \n
  • \n
  • \n

    \n STOPPED: The user has canceled the drift detection operation.

    \n
  • \n
" + "smithy.api#documentation": "

The status of the StackSet drift detection operation.

\n
    \n
  • \n

    \n COMPLETED: The drift detection operation completed without failing on any\n stack instances.

    \n
  • \n
  • \n

    \n FAILED: The drift detection operation exceeded the specified failure\n tolerance.

    \n
  • \n
  • \n

    \n PARTIAL_SUCCESS: The drift detection operation completed without exceeding\n the failure tolerance for the operation.

    \n
  • \n
  • \n

    \n IN_PROGRESS: The drift detection operation is currently being\n performed.

    \n
  • \n
  • \n

    \n STOPPED: The user has canceled the drift detection operation.

    \n
  • \n
" } }, "LastDriftCheckTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

Most recent time when CloudFormation performed a drift detection operation on the stack set.\n This value will be NULL for any stack set on which drift detection hasn't yet been\n performed.

" + "smithy.api#documentation": "

Most recent time when CloudFormation performed a drift detection operation on the StackSet. This\n value will be NULL for any StackSet that drift detection hasn't yet been performed\n on.

" } }, "TotalStackInstancesCount": { "target": "com.amazonaws.cloudformation#TotalStackInstancesCount", "traits": { - "smithy.api#documentation": "

The total number of stack instances belonging to this stack set.

\n

The total number of stack instances is equal to the total of:

\n
    \n
  • \n

    Stack instances that match the stack set configuration.

    \n
  • \n
  • \n

    Stack instances that have drifted from the stack set configuration.

    \n
  • \n
  • \n

    Stack instances where the drift detection operation has failed.

    \n
  • \n
  • \n

    Stack instances currently being checked for drift.

    \n
  • \n
" + "smithy.api#documentation": "

The total number of stack instances belonging to this StackSet.

\n

The total number of stack instances is equal to the total of:

\n
    \n
  • \n

    Stack instances that match the StackSet configuration.

    \n
  • \n
  • \n

    Stack instances that have drifted from the StackSet configuration.

    \n
  • \n
  • \n

    Stack instances where the drift detection operation has failed.

    \n
  • \n
  • \n

    Stack instances currently being checked for drift.

    \n
  • \n
" } }, "DriftedStackInstancesCount": { "target": "com.amazonaws.cloudformation#DriftedStackInstancesCount", "traits": { - "smithy.api#documentation": "

The number of stack instances that have drifted from the expected template and parameter\n configuration of the stack set. A stack instance is considered to have drifted if one or more of\n the resources in the associated stack don't match their expected configuration.

" + "smithy.api#documentation": "

The number of stack instances that have drifted from the expected template and parameter\n configuration of the StackSet. A stack instance is considered to have drifted if one or more of\n the resources in the associated stack don't match their expected configuration.

" } }, "InSyncStackInstancesCount": { "target": "com.amazonaws.cloudformation#InSyncStackInstancesCount", "traits": { - "smithy.api#documentation": "

The number of stack instances which match the expected template and parameter configuration\n of the stack set.

" + "smithy.api#documentation": "

The number of stack instances which match the expected template and parameter configuration\n of the StackSet.

" } }, "InProgressStackInstancesCount": { @@ -14055,7 +14081,7 @@ } }, "traits": { - "smithy.api#documentation": "

Detailed information about the drift status of the stack set.

\n

For stack sets, contains information about the last completed drift\n operation performed on the stack set. Information about drift operations in-progress isn't\n included.

\n

For stack set operations, includes information about drift operations currently being\n performed on the stack set.

\n

For more information, see Performing drift detection on\n CloudFormation StackSets in the CloudFormation User Guide.

" + "smithy.api#documentation": "

Detailed information about the drift status of the StackSet.

\n

For StackSets, contains information about the last completed drift\n operation performed on the StackSet. Information about drift operations in-progress isn't\n included.

\n

For StackSet operations, includes information about drift operations currently being\n performed on the StackSet.

\n

For more information, see Performing drift detection on\n CloudFormation StackSets in the CloudFormation User Guide.

" } }, "com.amazonaws.cloudformation#StackSetDriftDetectionStatus": { @@ -14140,7 +14166,7 @@ "code": "StackSetNotEmptyException", "httpResponseCode": 409 }, - "smithy.api#documentation": "

You can't yet delete this stack set, because it still contains one or more stack instances. Delete all stack\n instances from the stack set before deleting the stack set.

", + "smithy.api#documentation": "

You can't yet delete this StackSet, because it still contains one or more stack instances. Delete all stack\n instances from the StackSet before deleting the StackSet.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -14157,7 +14183,7 @@ "code": "StackSetNotFoundException", "httpResponseCode": 404 }, - "smithy.api#documentation": "

The specified stack set doesn't exist.

", + "smithy.api#documentation": "

The specified StackSet doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -14168,49 +14194,49 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique ID of a stack set operation.

" + "smithy.api#documentation": "

The unique ID of a StackSet operation.

" } }, "StackSetId": { "target": "com.amazonaws.cloudformation#StackSetId", "traits": { - "smithy.api#documentation": "

The ID of the stack set.

" + "smithy.api#documentation": "

The ID of the StackSet.

" } }, "Action": { "target": "com.amazonaws.cloudformation#StackSetOperationAction", "traits": { - "smithy.api#documentation": "

The type of stack set operation: CREATE, UPDATE, or\n DELETE. Create and delete operations affect only the specified stack set instances\n that are associated with the specified stack set. Update operations affect both the stack set\n itself, in addition to all associated stack set instances.

" + "smithy.api#documentation": "

The type of StackSet operation: CREATE, UPDATE, or\n DELETE. Create and delete operations affect only the specified stack instances that\n are associated with the specified StackSet. Update operations affect both the StackSet itself, in\n addition to all associated stack instances.

" } }, "Status": { "target": "com.amazonaws.cloudformation#StackSetOperationStatus", "traits": { - "smithy.api#documentation": "

The status of the operation.

\n
    \n
  • \n

    \n FAILED: The operation exceeded the specified failure tolerance. The failure\n tolerance value that you've set for an operation is applied for each Region during stack create\n and update operations. If the number of failed stacks within a Region exceeds the failure\n tolerance, the status of the operation in the Region is set to FAILED. This in\n turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels\n the operation in any remaining Regions.

    \n
  • \n
  • \n

    \n QUEUED: [Service-managed permissions] For automatic deployments that require\n a sequence of operations, the operation is queued to be performed. For more information, see\n the StackSets status codes in the CloudFormation User Guide.

    \n
  • \n
  • \n

    \n RUNNING: The operation is currently being performed.

    \n
  • \n
  • \n

    \n STOPPED: The user has canceled the operation.

    \n
  • \n
  • \n

    \n STOPPING: The operation is in the process of stopping, at user\n request.

    \n
  • \n
  • \n

    \n SUCCEEDED: The operation completed creating or updating all the specified\n stacks without exceeding the failure tolerance for the operation.

    \n
  • \n
" + "smithy.api#documentation": "

The status of the operation.

\n
    \n
  • \n

    \n FAILED: The operation exceeded the specified failure tolerance. The failure\n tolerance value that you've set for an operation is applied for each Region during stack create\n and update operations. If the number of failed stacks within a Region exceeds the failure\n tolerance, the status of the operation in the Region is set to FAILED. This in\n turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels\n the operation in any remaining Regions.

    \n
  • \n
  • \n

    \n QUEUED: [Service-managed permissions] For automatic deployments that require\n a sequence of operations, the operation is queued to be performed. For more information, see\n the StackSets status codes in the CloudFormation User Guide.

    \n
  • \n
  • \n

    \n RUNNING: The operation is currently being performed.

    \n
  • \n
  • \n

    \n STOPPED: The user has canceled the operation.

    \n
  • \n
  • \n

    \n STOPPING: The operation is in the process of stopping, at user\n request.

    \n
  • \n
  • \n

    \n SUCCEEDED: The operation completed creating or updating all the specified\n stacks without exceeding the failure tolerance for the operation.

    \n
  • \n
" } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

The preferences for how CloudFormation performs this stack set operation.

" + "smithy.api#documentation": "

The preferences for how CloudFormation performs this StackSet operation.

" } }, "RetainStacks": { "target": "com.amazonaws.cloudformation#RetainStacksNullable", "traits": { - "smithy.api#documentation": "

For stack set operations of action type DELETE, specifies whether to remove the\n stack instances from the specified stack set, but doesn't delete the stacks. You can't\n re-associate a retained stack, or add an existing, saved stack to a new stack set.

" + "smithy.api#documentation": "

For StackSet operations of action type DELETE, specifies whether to remove the\n stack instances from the specified StackSet, but doesn't delete the stacks. You can't\n re-associate a retained stack, or add an existing, saved stack to a new StackSet.

" } }, "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to perform this stack set\n operation.

\n

Use customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Grant self-managed\n permissions in the CloudFormation User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used to perform this StackSet\n operation.

\n

Use customized administrator roles to control which users or groups can manage specific\n StackSets within the same administrator account. For more information, see Grant self-managed\n permissions in the CloudFormation User Guide.

" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "

The name of the IAM execution role used to create or update the stack set.

\n

Use customized execution roles to control which stack resources users and groups can include\n in their stack sets.

" + "smithy.api#documentation": "

The name of the IAM execution role used to create or update the StackSet.

\n

Use customized execution roles to control which stack resources users and groups can include\n in their StackSets.

" } }, "CreationTimestamp": { @@ -14222,19 +14248,19 @@ "EndTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

The time at which the stack set operation ended, across all accounts and Regions specified.\n Note that this doesn't necessarily mean that the stack set operation was successful, or even\n attempted, in each account or Region.

" + "smithy.api#documentation": "

The time at which the StackSet operation ended, across all accounts and Regions specified.\n Note that this doesn't necessarily mean that the StackSet operation was successful, or even\n attempted, in each account or Region.

" } }, "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts affected by the stack\n operation.

" + "smithy.api#documentation": "

The Organizations accounts affected by the stack operation. Valid only if the\n StackSet uses service-managed permissions.

" } }, "StackSetDriftDetectionDetails": { "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", "traits": { - "smithy.api#documentation": "

Detailed information about the drift status of the stack set. This includes information\n about drift operations currently being performed on the stack set.

\n

This information will only be present for stack set operations whose Action\n type is DETECT_DRIFT.

\n

For more information, see Performing drift detection on\n CloudFormation StackSets in the CloudFormation User Guide.

" + "smithy.api#documentation": "

Detailed information about the drift status of the StackSet. This includes information about\n drift operations currently being performed on the StackSet.

\n

This information will only be present for StackSet operations whose Action type\n is DETECT_DRIFT.

\n

For more information, see Performing drift detection on\n CloudFormation StackSets in the CloudFormation User Guide.

" } }, "StatusReason": { @@ -14251,7 +14277,7 @@ } }, "traits": { - "smithy.api#documentation": "

The structure that contains information about a stack set operation.

" + "smithy.api#documentation": "

The structure that contains information about a StackSet operation.

" } }, "com.amazonaws.cloudformation#StackSetOperationAction": { @@ -14301,13 +14327,13 @@ "FailureToleranceCount": { "target": "com.amazonaws.cloudformation#FailureToleranceCount", "traits": { - "smithy.api#documentation": "

The number of accounts, per Region, for which this operation can fail before CloudFormation\n stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't\n attempt the operation in any subsequent Regions.

\n

You can specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.

\n

By default, 0 is specified.

" + "smithy.api#documentation": "

The number of accounts per Region this operation can fail in before CloudFormation stops the\n operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the\n operation in any subsequent Regions.

\n

You can specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.

\n

By default, 0 is specified.

" } }, "FailureTolerancePercentage": { "target": "com.amazonaws.cloudformation#FailureTolerancePercentage", "traits": { - "smithy.api#documentation": "

The percentage of accounts, per Region, for which this stack operation can fail before\n CloudFormation stops the operation in that Region. If the operation is stopped in a Region,\n CloudFormation doesn't attempt the operation in any subsequent Regions.

\n

When calculating the number of accounts based on the specified percentage, CloudFormation rounds\n down to the next whole number.

\n

You can specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.

\n

By default, 0 is specified.

" + "smithy.api#documentation": "

The percentage of accounts per Region this stack operation can fail in before CloudFormation\n stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't\n attempt the operation in any subsequent Regions.

\n

When calculating the number of accounts based on the specified percentage, CloudFormation rounds\n down to the next whole number.

\n

You can specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.

\n

By default, 0 is specified.

" } }, "MaxConcurrentCount": { @@ -14325,12 +14351,12 @@ "ConcurrencyMode": { "target": "com.amazonaws.cloudformation#ConcurrencyMode", "traits": { - "smithy.api#documentation": "

Specifies how the concurrency level behaves during the operation execution.

\n
    \n
  • \n

    \n STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency\n level to ensure the number of failed accounts never exceeds the value of\n FailureToleranceCount +1. The initial actual concurrency is set to the lower of\n either the value of the MaxConcurrentCount, or the value of\n FailureToleranceCount +1. The actual concurrency is then reduced proportionally\n by the number of failures. This is the default behavior.

    \n

    If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior\n is similar.

    \n
  • \n
  • \n

    \n SOFT_FAILURE_TOLERANCE: This option decouples\n FailureToleranceCount from the actual concurrency. This allows stack set\n operations to run at the concurrency level set by the MaxConcurrentCount value, or\n MaxConcurrentPercentage, regardless of the number of failures.

    \n
  • \n
" + "smithy.api#documentation": "

Specifies how the concurrency level behaves during the operation execution.

\n
    \n
  • \n

    \n STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency\n level to ensure the number of failed accounts never exceeds the value of\n FailureToleranceCount +1. The initial actual concurrency is set to the lower of\n either the value of the MaxConcurrentCount, or the value of\n FailureToleranceCount +1. The actual concurrency is then reduced proportionally\n by the number of failures. This is the default behavior.

    \n

    If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior\n is similar.

    \n
  • \n
  • \n

    \n SOFT_FAILURE_TOLERANCE: This option decouples\n FailureToleranceCount from the actual concurrency. This allows StackSet\n operations to run at the concurrency level set by the MaxConcurrentCount value, or\n MaxConcurrentPercentage, regardless of the number of failures.

    \n
  • \n
" } } }, "traits": { - "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a stack set operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see Stack\n set operation options.

\n \n

\n StackSetOperationPreferences don't apply to AutoDeployment, even\n if it's enabled.

\n
" + "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a StackSet operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see StackSet\n operation options.

\n \n

\n StackSetOperationPreferences don't apply to AutoDeployment, even\n if it's enabled.

\n
" } }, "com.amazonaws.cloudformation#StackSetOperationResultStatus": { @@ -14392,7 +14418,7 @@ "Status": { "target": "com.amazonaws.cloudformation#StackSetOperationResultStatus", "traits": { - "smithy.api#documentation": "

The result status of the stack set operation for the given account in the given\n Region.

\n
    \n
  • \n

    \n CANCELLED: The operation in the specified account and Region has been\n canceled. This is either because a user has stopped the stack set operation, or because the\n failure tolerance of the stack set operation has been exceeded.

    \n
  • \n
  • \n

    \n FAILED: The operation in the specified account and Region failed.

    \n

    If the stack set operation fails in enough accounts within a Region, the failure tolerance\n for the stack set operation as a whole might be exceeded.

    \n
  • \n
  • \n

    \n RUNNING: The operation in the specified account and Region is currently in\n progress.

    \n
  • \n
  • \n

    \n PENDING: The operation in the specified account and Region has yet to\n start.

    \n
  • \n
  • \n

    \n SUCCEEDED: The operation in the specified account and Region completed\n successfully.

    \n
  • \n
" + "smithy.api#documentation": "

The result status of the StackSet operation for the given account in the given\n Region.

\n
    \n
  • \n

    \n CANCELLED: The operation in the specified account and Region has been\n canceled. This is either because a user has stopped the StackSet operation, or because the\n failure tolerance of the StackSet operation has been exceeded.

    \n
  • \n
  • \n

    \n FAILED: The operation in the specified account and Region failed.

    \n

    If the StackSet operation fails in enough accounts within a Region, the failure tolerance\n for the StackSet operation as a whole might be exceeded.

    \n
  • \n
  • \n

    \n RUNNING: The operation in the specified account and Region is currently in\n progress.

    \n
  • \n
  • \n

    \n PENDING: The operation in the specified account and Region has yet to\n start.

    \n
  • \n
  • \n

    \n SUCCEEDED: The operation in the specified account and Region completed\n successfully.

    \n
  • \n
" } }, "StatusReason": { @@ -14404,7 +14430,7 @@ "AccountGateResult": { "target": "com.amazonaws.cloudformation#AccountGateResult", "traits": { - "smithy.api#documentation": "

The results of the account gate function CloudFormation invokes, if present, before proceeding\n with stack set operations in an account.

" + "smithy.api#documentation": "

The results of the account gate function CloudFormation invokes, if present, before proceeding\n with StackSet operations in an account.

" } }, "OrganizationalUnitId": { @@ -14488,31 +14514,31 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique ID of the stack set operation.

" + "smithy.api#documentation": "

The unique ID of the StackSet operation.

" } }, "Action": { "target": "com.amazonaws.cloudformation#StackSetOperationAction", "traits": { - "smithy.api#documentation": "

The type of operation: CREATE, UPDATE, or DELETE.\n Create and delete operations affect only the specified stack instances that are associated with\n the specified stack set. Update operations affect both the stack set itself and\n all associated stack set instances.

" + "smithy.api#documentation": "

The type of operation: CREATE, UPDATE, or DELETE.\n Create and delete operations affect only the specified stack instances that are associated with\n the specified StackSet. Update operations affect both the StackSet itself and\n all associated StackSet instances.

" } }, "Status": { "target": "com.amazonaws.cloudformation#StackSetOperationStatus", "traits": { - "smithy.api#documentation": "

The overall status of the operation.

\n
    \n
  • \n

    \n FAILED: The operation exceeded the specified failure tolerance. The failure\n tolerance value that you've set for an operation is applied for each Region during stack create\n and update operations. If the number of failed stacks within a Region exceeds the failure\n tolerance, the status of the operation in the Region is set to FAILED. This in\n turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels\n the operation in any remaining Regions.

    \n
  • \n
  • \n

    \n QUEUED: [Service-managed permissions] For automatic deployments that require\n a sequence of operations, the operation is queued to be performed. For more information, see\n the stack\n set operation status codes in the CloudFormation User Guide.

    \n
  • \n
  • \n

    \n RUNNING: The operation is currently being performed.

    \n
  • \n
  • \n

    \n STOPPED: The user has canceled the operation.

    \n
  • \n
  • \n

    \n STOPPING: The operation is in the process of stopping, at user\n request.

    \n
  • \n
  • \n

    \n SUCCEEDED: The operation completed creating or updating all the specified\n stacks without exceeding the failure tolerance for the operation.

    \n
  • \n
" + "smithy.api#documentation": "

The overall status of the operation.

\n
    \n
  • \n

    \n FAILED: The operation exceeded the specified failure tolerance. The failure\n tolerance value that you've set for an operation is applied for each Region during stack create\n and update operations. If the number of failed stacks within a Region exceeds the failure\n tolerance, the status of the operation in the Region is set to FAILED. This in\n turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels\n the operation in any remaining Regions.

    \n
  • \n
  • \n

    \n QUEUED: [Service-managed permissions] For automatic deployments that require\n a sequence of operations, the operation is queued to be performed. For more information, see\n the StackSet status codes in the CloudFormation User Guide.

    \n
  • \n
  • \n

    \n RUNNING: The operation is currently being performed.

    \n
  • \n
  • \n

    \n STOPPED: The user has canceled the operation.

    \n
  • \n
  • \n

    \n STOPPING: The operation is in the process of stopping, at user\n request.

    \n
  • \n
  • \n

    \n SUCCEEDED: The operation completed creating or updating all the specified\n stacks without exceeding the failure tolerance for the operation.

    \n
  • \n
" } }, "CreationTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

The time at which the operation was initiated. Note that the creation times for the stack\n set operation might differ from the creation time of the individual stacks themselves. This is\n because CloudFormation needs to perform preparatory work for the operation, such as dispatching the\n work to the requested Regions, before actually creating the first stacks.

" + "smithy.api#documentation": "

The time at which the operation was initiated. Note that the creation times for the StackSet\n operation might differ from the creation time of the individual stacks themselves. This is\n because CloudFormation needs to perform preparatory work for the operation, such as dispatching the\n work to the requested Regions, before actually creating the first stacks.

" } }, "EndTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

The time at which the stack set operation ended, across all accounts and Regions specified.\n Note that this doesn't necessarily mean that the stack set operation was successful, or even\n attempted, in each account or Region.

" + "smithy.api#documentation": "

The time at which the StackSet operation ended, across all accounts and Regions specified.\n Note that this doesn't necessarily mean that the StackSet operation was successful, or even\n attempted, in each account or Region.

" } }, "StatusReason": { @@ -14524,13 +14550,13 @@ "StatusDetails": { "target": "com.amazonaws.cloudformation#StackSetOperationStatusDetails", "traits": { - "smithy.api#documentation": "

Detailed information about the stack set operation.

" + "smithy.api#documentation": "

Detailed information about the StackSet operation.

" } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a stack set operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see Stack\n set operation options.

" + "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a StackSet operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see StackSet\n operation options.

" } } }, @@ -14567,25 +14593,25 @@ "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetName", "traits": { - "smithy.api#documentation": "

The name of the stack set.

" + "smithy.api#documentation": "

The name of the StackSet.

" } }, "StackSetId": { "target": "com.amazonaws.cloudformation#StackSetId", "traits": { - "smithy.api#documentation": "

The ID of the stack set.

" + "smithy.api#documentation": "

The ID of the StackSet.

" } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "

A description of the stack set that you specify when the stack set is created or\n updated.

" + "smithy.api#documentation": "

A description of the StackSet that you specify when the StackSet is created or\n updated.

" } }, "Status": { "target": "com.amazonaws.cloudformation#StackSetStatus", "traits": { - "smithy.api#documentation": "

The status of the stack set.

" + "smithy.api#documentation": "

The status of the StackSet.

" } }, "AutoDeployment": { @@ -14597,19 +14623,19 @@ "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { - "smithy.api#documentation": "

Describes how the IAM roles required for stack set operations are created.

\n " + "smithy.api#documentation": "

Describes how the IAM roles required for StackSet operations are created.

\n " } }, "DriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { - "smithy.api#documentation": "

Status of the stack set's actual configuration compared to its expected template and\n parameter configuration. A stack set is considered to have drifted if one or more of its stack\n instances have drifted from their expected template and parameter configuration.

\n
    \n
  • \n

    \n DRIFTED: One or more of the stack instances belonging to the stack set stack\n differs from the expected template and parameter configuration. A stack instance is considered\n to have drifted if one or more of the resources in the associated stack have drifted.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.

    \n
  • \n
  • \n

    \n IN_SYNC: All the stack instances belonging to the stack set stack match from\n the expected template and parameter configuration.

    \n
  • \n
  • \n

    \n UNKNOWN: This value is reserved for future use.

    \n
  • \n
" + "smithy.api#documentation": "

Status of the StackSet's actual configuration compared to its expected template and\n parameter configuration.

\n
    \n
  • \n

    \n DRIFTED: One or more of the stack instances belonging to the StackSet differs\n from the expected template and parameter configuration. A stack instance is considered to have\n drifted if one or more of the resources in the associated stack have drifted.

    \n
  • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked the StackSet for drift.

    \n
  • \n
  • \n

    \n IN_SYNC: All the stack instances belonging to the StackSet match the expected\n template and parameter configuration.

    \n
  • \n
  • \n

    \n UNKNOWN: This value is reserved for future use.

    \n
  • \n
" } }, "LastDriftCheckTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

Most recent time when CloudFormation performed a drift detection operation on the stack set.\n This value will be NULL for any stack set on which drift detection hasn't yet been\n performed.

" + "smithy.api#documentation": "

Most recent time when CloudFormation performed a drift detection operation on the StackSet. This\n value will be NULL for any StackSet that drift detection hasn't yet been performed\n on.

" } }, "ManagedExecution": { @@ -14620,7 +14646,7 @@ } }, "traits": { - "smithy.api#documentation": "

The structures that contain summary information about the specified stack set.

" + "smithy.api#documentation": "

The structures that contain summary information about the specified StackSet.

" } }, "com.amazonaws.cloudformation#StackStatus": { @@ -14841,13 +14867,13 @@ "ParentId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

For nested stacks, the stack ID of the direct\n parent of this stack. For the first level of nested stacks, the root stack is also the parent\n stack.

\n

For more information, see Nested stacks in the CloudFormation User Guide.

" + "smithy.api#documentation": "

For nested stacks, the stack ID of the direct parent of this stack. For the first level of\n nested stacks, the root stack is also the parent stack.

\n

For more information, see Nested stacks in\n the CloudFormation User Guide.

" } }, "RootId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

For nested stacks, the stack ID of the\n top-level stack to which the nested stack ultimately belongs.

\n

For more information, see Nested stacks in the CloudFormation User Guide.

" + "smithy.api#documentation": "

For nested stacks, the stack ID of the top-level stack to which the nested stack ultimately\n belongs.

\n

For more information, see Nested stacks in\n the CloudFormation User Guide.

" } }, "DriftInformation": { @@ -14885,7 +14911,7 @@ "code": "StaleRequestException", "httpResponseCode": 409 }, - "smithy.api#documentation": "

Another operation has been performed on this stack set since the specified operation was performed.

", + "smithy.api#documentation": "

Another operation has been performed on this StackSet since the specified operation was performed.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -14982,7 +15008,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops an in-progress operation on a stack set and its associated stack instances. StackSets\n will cancel all the unstarted stack instance deployments and wait for those are in-progress to\n complete.

" + "smithy.api#documentation": "

Stops an in-progress operation on a StackSet and its associated stack instances. StackSets\n will cancel all the unstarted stack instance deployments and wait for those are in-progress to\n complete.

" } }, "com.amazonaws.cloudformation#StopStackSetOperationInput": { @@ -14992,7 +15018,7 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to stop the operation for.

", + "smithy.api#documentation": "

The name or unique ID of the StackSet that you want to stop the operation for.

", "smithy.api#required": {} } }, @@ -15007,7 +15033,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a member\n account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid only if the\n StackSet uses service-managed permissions.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } } }, @@ -15525,7 +15551,7 @@ "Arn": { "target": "com.amazonaws.cloudformation#TypeConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the configuration data, in this account and\n Region.

" + "smithy.api#documentation": "

The ARN for the configuration data, in this account and Region.

" } }, "Alias": { @@ -15549,7 +15575,7 @@ "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the extension, in this account and Region.

\n

For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this\n will be the ARN assigned when you call the RegisterType API\n operation in this account and Region.

" + "smithy.api#documentation": "

The ARN for the extension, in this account and Region.

\n

For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this\n will be the ARN assigned when you call the RegisterType API\n operation in this account and Region.

" } }, "TypeName": { @@ -15581,7 +15607,7 @@ "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the extension, in this account and Region.

\n

For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this\n will be the ARN assigned when you call the RegisterType API\n operation in this account and Region.

" + "smithy.api#documentation": "

The ARN for the extension, in this account and Region.

\n

For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this\n will be the ARN assigned when you call the RegisterType API\n operation in this account and Region.

" } }, "TypeConfigurationAlias": { @@ -15593,7 +15619,7 @@ "TypeConfigurationArn": { "target": "com.amazonaws.cloudformation#TypeConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the configuration, in this account and Region.

" + "smithy.api#documentation": "

The ARN for the configuration, in this account and Region.

" } }, "Type": { @@ -15752,7 +15778,7 @@ "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension.

" + "smithy.api#documentation": "

The ARN of the extension.

" } }, "LastUpdated": { @@ -15887,7 +15913,7 @@ "VersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

The ID of a specific version of the extension. The version ID is the value at the end of the\n Amazon Resource Name (ARN) assigned to the extension version when it's registered.

" + "smithy.api#documentation": "

The ID of a specific version of the extension. The version ID is the value at the end of the\n ARN assigned to the extension version when it's registered.

" } }, "IsDefaultVersion": { @@ -15899,7 +15925,7 @@ "Arn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension version.

" + "smithy.api#documentation": "

The ARN of the extension version.

" } }, "TimeCreated": { @@ -16135,7 +16161,7 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account, for example, by creating new IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
    • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
    • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
    • \n
    \n

    If your stack template contains these resources, we suggest that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
  • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually updating the stack. If your stack template contains one or more macros,\n and you choose to update a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include\n and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    \n

    If you want to update a stack from a stack template that contains macros\n and nested stacks, you must update the stack directly from the\n template using this capability.

    \n \n

    You should only update stacks directly from a stack template that contains macros if\n you know what processing the macro performs.

    \n

    Each macro relies on an underlying Lambda service function for processing stack\n templates. Be aware that the Lambda function owner can update the function operation\n without CloudFormation being notified.

    \n
    \n

    For more information, see Perform custom processing\n on CloudFormation templates with template macros.

    \n
  • \n
\n \n

Only one of the Capabilities and ResourceType parameters can\n be specified.

\n
" + "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account, for example, by creating new IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
    • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
    • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
    • \n
    \n

    If your stack template contains these resources, we suggest that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
  • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually updating the stack. If your stack template contains one or more macros,\n and you choose to update a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include\n and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    \n

    If you want to update a stack from a stack template that contains macros\n and nested stacks, you must update the stack directly from the\n template using this capability.

    \n \n

    You should only update stacks directly from a stack template that contains macros if\n you know what processing the macro performs.

    \n

    Each macro relies on an underlying Lambda service function for processing stack\n templates. Be aware that the Lambda function owner can update the function operation\n without CloudFormation being notified.

    \n
    \n

    For more information, see Perform custom processing\n on CloudFormation templates with template macros.

    \n
  • \n
\n \n

Only one of the Capabilities and ResourceType parameters can\n be specified.

\n
" } }, "ResourceTypes": { @@ -16233,7 +16259,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the parameter values for stack instances for the specified accounts, within the\n specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and\n Region.

\n

You can only update stack instances in Amazon Web Services Regions and accounts where they already\n exist; to create additional stack instances, use CreateStackInstances.

\n

During stack set updates, any parameters overridden for a stack instance aren't updated,\n but retain their overridden value.

\n

You can only update the parameter values that are specified in the\n stack set; to add or delete a parameter itself, use UpdateStackSet\n to update the stack set template. If you add a parameter to a template, before you can\n override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and\n parameter value specified in the stack set. Once a stack instance has been updated with the\n new parameter, you can then override the parameter value using\n UpdateStackInstances.

\n \n

The maximum number of organizational unit (OUs) supported by a\n UpdateStackInstances operation is 50.

\n

If you need more than 50, consider the following options:

\n
    \n
  • \n

    \n Batch processing: If you don't want to expose your OU\n hierarchy, split up the operations into multiple calls with less than 50 OUs\n each.

    \n
  • \n
  • \n

    \n Parent OU strategy: If you don't mind exposing the OU\n hierarchy, target a parent OU that contains all desired child OUs.

    \n
  • \n
\n
" + "smithy.api#documentation": "

Updates the parameter values for stack instances for the specified accounts, within the\n specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and\n Region.

\n

You can only update stack instances in Amazon Web Services Regions and accounts where they already\n exist; to create additional stack instances, use CreateStackInstances.

\n

During StackSet updates, any parameters overridden for a stack instance aren't updated,\n but retain their overridden value.

\n

You can only update the parameter values that are specified in the\n StackSet. To add or delete a parameter itself, use UpdateStackSet\n to update the StackSet template. If you add a parameter to a template, before you can override\n the parameter value specified in the StackSet you must first use UpdateStackSet\n to update all stack instances with the updated template and parameter value specified in the\n StackSet. Once a stack instance has been updated with the new parameter, you can then override\n the parameter value using UpdateStackInstances.

\n \n

The maximum number of organizational unit (OUs) supported by a\n UpdateStackInstances operation is 50.

\n

If you need more than 50, consider the following options:

\n
    \n
  • \n

    \n Batch processing: If you don't want to expose your OU\n hierarchy, split up the operations into multiple calls with less than 50 OUs\n each.

    \n
  • \n
  • \n

    \n Parent OU strategy: If you don't mind exposing the OU\n hierarchy, target a parent OU that contains all desired child OUs.

    \n
  • \n
\n
" } }, "com.amazonaws.cloudformation#UpdateStackInstancesInput": { @@ -16243,20 +16269,20 @@ "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set associated with the stack instances.

", + "smithy.api#documentation": "

The name or unique ID of the StackSet associated with the stack instances.

", "smithy.api#required": {} } }, "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The account IDs of one or more Amazon Web Services accounts for which you\n want to update parameter values for stack instances. The overridden parameter values will be\n applied to all stack instances in the specified accounts and Amazon Web Services Regions.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" + "smithy.api#documentation": "

[Self-managed permissions] The account IDs of one or more Amazon Web Services accounts in which you want\n to update parameter values for stack instances. The overridden parameter values will be\n applied to all stack instances in the specified accounts and Amazon Web Services Regions.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" } }, "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts for which you want to\n update parameter values for stack instances. If your update targets OUs, the overridden\n parameter values only apply to the accounts that are currently in the target OUs and their\n child OUs. Accounts added to the target OUs and their child OUs in the future won't use the\n overridden values.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" + "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts in which you want to\n update parameter values for stack instances. If your update targets OUs, the overridden\n parameter values only apply to the accounts that are currently in the target OUs and their\n child OUs. Accounts added to the target OUs and their child OUs in the future won't use the\n overridden values.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" } }, "Regions": { @@ -16270,26 +16296,26 @@ "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

A list of input parameters whose values you want to update for the specified stack\n instances.

\n

Any overridden parameter values will be applied to all stack instances in the specified\n accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how\n CloudFormation sets parameter values during stack instance update operations:

\n
    \n
  • \n

    To override the current value for a parameter, include the parameter and specify its\n value.

    \n
  • \n
  • \n

    To leave an overridden parameter set to its present value, include the parameter and\n specify UsePreviousValue as true. (You can't specify both a\n value and set UsePreviousValue to true.)

    \n
  • \n
  • \n

    To set an overridden parameter back to the value specified in the stack set, specify a\n parameter list but don't include the parameter in the list.

    \n
  • \n
  • \n

    To leave all parameters set to their present values, don't specify this property at\n all.

    \n
  • \n
\n

During stack set updates, any parameter values overridden for a stack instance aren't\n updated, but retain their overridden value.

\n

You can only override the parameter values that are specified in the\n stack set; to add or delete a parameter itself, use UpdateStackSet to update the\n stack set template. If you add a parameter to a template, before you can override the\n parameter value specified in the stack set you must first use UpdateStackSet\n to update all stack instances with the updated template and parameter value specified in the\n stack set. Once a stack instance has been updated with the new parameter, you can then\n override the parameter value using UpdateStackInstances.

" + "smithy.api#documentation": "

A list of input parameters whose values you want to update for the specified stack\n instances.

\n

Any overridden parameter values will be applied to all stack instances in the specified\n accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how\n CloudFormation sets parameter values during stack instance update operations:

\n
    \n
  • \n

    To override the current value for a parameter, include the parameter and specify its\n value.

    \n
  • \n
  • \n

    To leave an overridden parameter set to its present value, include the parameter and\n specify UsePreviousValue as true. (You can't specify both a\n value and set UsePreviousValue to true.)

    \n
  • \n
  • \n

    To set an overridden parameter back to the value specified in the StackSet, specify a\n parameter list but don't include the parameter in the list.

    \n
  • \n
  • \n

    To leave all parameters set to their present values, don't specify this property at\n all.

    \n
  • \n
\n

During StackSet updates, any parameter values overridden for a stack instance aren't\n updated, but retain their overridden value.

\n

You can only override the parameter values that are specified in the\n StackSet. To add or delete a parameter itself, use UpdateStackSet to update the\n StackSet template. If you add a parameter to a template, before you can override the parameter\n value specified in the StackSet you must first use UpdateStackSet\n to update all stack instances with the updated template and parameter value specified in the\n StackSet. Once a stack instance has been updated with the new parameter, you can then override\n the parameter value using UpdateStackInstances.

" } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

Preferences for how CloudFormation performs this stack set operation.

" + "smithy.api#documentation": "

Preferences for how CloudFormation performs this StackSet operation.

" } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique identifier for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the stack set operation only once, even if you retry the request multiple times. You\n might retry stack set operation requests to ensure that CloudFormation successfully received\n them.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

", + "smithy.api#documentation": "

The unique identifier for this StackSet operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the StackSet operation only once, even if you retry the request multiple times. You\n might retry StackSet operation requests to ensure that CloudFormation successfully received\n them.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } } }, @@ -16303,7 +16329,7 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique identifier for this stack set operation.

" + "smithy.api#documentation": "

The unique identifier for this StackSet operation.

" } } }, @@ -16355,7 +16381,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the stack set and associated stack instances in the specified accounts and\n Amazon Web Services Regions.

\n

Even if the stack set operation created by updating the stack set fails (completely or\n partially, below or above a specified failure tolerance), the stack set is updated with your\n changes. Subsequent CreateStackInstances calls on the specified stack set\n use the updated stack set.

\n \n

The maximum number of organizational unit (OUs) supported by a\n UpdateStackSet operation is 50.

\n

If you need more than 50, consider the following options:

\n
    \n
  • \n

    \n Batch processing: If you don't want to expose your OU\n hierarchy, split up the operations into multiple calls with less than 50 OUs\n each.

    \n
  • \n
  • \n

    \n Parent OU strategy: If you don't mind exposing the OU\n hierarchy, target a parent OU that contains all desired child OUs.

    \n
  • \n
\n
" + "smithy.api#documentation": "

Updates the StackSet and associated stack instances in the specified accounts and\n Amazon Web Services Regions.

\n

Even if the StackSet operation created by updating the StackSet fails (completely or\n partially, below or above a specified failure tolerance), the StackSet is updated with your\n changes. Subsequent CreateStackInstances calls on the specified StackSet use\n the updated StackSet.

\n \n

The maximum number of organizational unit (OUs) supported by a\n UpdateStackSet operation is 50.

\n

If you need more than 50, consider the following options:

\n
    \n
  • \n

    \n Batch processing: If you don't want to expose your OU\n hierarchy, split up the operations into multiple calls with less than 50 OUs\n each.

    \n
  • \n
  • \n

    \n Parent OU strategy: If you don't mind exposing the OU\n hierarchy, target a parent OU that contains all desired child OUs.

    \n
  • \n
\n
" } }, "com.amazonaws.cloudformation#UpdateStackSetInput": { @@ -16365,7 +16391,7 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to update.

", + "smithy.api#documentation": "

The name or unique ID of the StackSet that you want to update.

", "smithy.api#required": {} } }, @@ -16390,92 +16416,92 @@ "UsePreviousTemplate": { "target": "com.amazonaws.cloudformation#UsePreviousTemplate", "traits": { - "smithy.api#documentation": "

Use the existing template that's associated with the stack set that you're\n updating.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL—or set\n UsePreviousTemplate to true.

" + "smithy.api#documentation": "

Use the existing template that's associated with the StackSet that you're updating.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL—or set\n UsePreviousTemplate to true.

" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

A list of input parameters for the stack set template.

" + "smithy.api#documentation": "

A list of input parameters for the StackSet template.

" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack set and its associated stack\n instances.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account, for example, by creating new IAM users. For those stacks sets, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
    • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
    • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
    • \n
    \n

    If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
  • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some templates reference macros. If your stack set template references one or more\n macros, you must update the stack set directly from the processed template, without first\n reviewing the resulting changes in a change set. To update the stack set directly, you\n must acknowledge this capability. For more information, see Perform custom processing\n on CloudFormation templates with template macros.

    \n \n

    Stack sets with service-managed permissions do not currently support the use of\n macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if\n you specify this capability for a stack set with service-managed permissions, if you\n reference a macro in your template the stack set operation will fail.

    \n
    \n
  • \n
" + "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the StackSet and its associated stack\n instances.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account, for example, by creating new IAM users. For those stacks sets, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
    • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
    • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
    • \n
    \n

    If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
  • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some templates reference macros. If your StackSet template references one or more\n macros, you must update the StackSet directly from the processed template, without first\n reviewing the resulting changes in a change set. To update the StackSet directly, you must\n acknowledge this capability. For more information, see Perform custom processing\n on CloudFormation templates with template macros.

    \n \n

    StackSets with service-managed permissions do not currently support the use of\n macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if\n you specify this capability for a StackSet with service-managed permissions, if you\n reference a macro in your template the StackSet operation will fail.

    \n
    \n
  • \n
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "

The key-value pairs to associate with this stack set and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are created in the stacks.\n You can specify a maximum number of 50 tags.

\n

If you specify tags for this parameter, those tags replace any list of tags that are\n currently associated with this stack set. This means:

\n
    \n
  • \n

    If you don't specify this parameter, CloudFormation doesn't modify the stack's\n tags.

    \n
  • \n
  • \n

    If you specify any tags using this parameter, you must specify\n all the tags that you want associated with this stack set, even\n tags you've specified before (for example, when creating the stack set or during a\n previous update of the stack set.). Any tags that you don't include in the updated list of\n tags are removed from the stack set, and therefore from the stacks and resources as\n well.

    \n
  • \n
  • \n

    If you specify an empty value, CloudFormation removes all currently associated\n tags.

    \n
  • \n
\n

If you specify new tags as part of an UpdateStackSet action, CloudFormation\n checks to see if you have the required IAM permission to tag resources. If you omit tags\n that are currently associated with the stack set from the list of tags you specify, CloudFormation\n assumes that you want to remove those tags from the stack set, and checks to see if you have\n permission to untag resources. If you don't have the necessary permission(s), the entire\n UpdateStackSet action fails with an access denied error, and the\n stack set is not updated.

" + "smithy.api#documentation": "

The key-value pairs to associate with this StackSet and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are created in the stacks.\n You can specify a maximum number of 50 tags.

\n

If you specify tags for this parameter, those tags replace any list of tags that are\n currently associated with this StackSet. This means:

\n
    \n
  • \n

    If you don't specify this parameter, CloudFormation doesn't modify the stack's\n tags.

    \n
  • \n
  • \n

    If you specify any tags using this parameter, you must specify\n all the tags that you want associated with this StackSet, even tags\n you've specified before (for example, when creating the StackSet or during a previous\n update of the StackSet.). Any tags that you don't include in the updated list of tags are\n removed from the StackSet, and therefore from the stacks and resources as well.

    \n
  • \n
  • \n

    If you specify an empty value, CloudFormation removes all currently associated\n tags.

    \n
  • \n
\n

If you specify new tags as part of an UpdateStackSet action, CloudFormation\n checks to see if you have the required IAM permission to tag resources. If you omit tags\n that are currently associated with the StackSet from the list of tags you specify, CloudFormation\n assumes that you want to remove those tags from the StackSet, and checks to see if you have\n permission to untag resources. If you don't have the necessary permission(s), the entire\n UpdateStackSet action fails with an access denied error, and the\n StackSet is not updated.

" } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

Preferences for how CloudFormation performs this stack set operation.

" + "smithy.api#documentation": "

Preferences for how CloudFormation performs this StackSet operation.

" } }, "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The Amazon Resource Name (ARN) of the IAM role to use to\n update this stack set.

\n

Specify an IAM role only if you are using customized administrator roles to control\n which users or groups can manage specific stack sets within the same administrator account.\n For more information, see Grant\n self-managed permissions in the CloudFormation User Guide.

\n

If you specified a customized administrator role when you created the stack set, you must\n specify a customized administrator role, even if it is the same customized administrator role\n used with this stack set previously.

" + "smithy.api#documentation": "

[Self-managed permissions] The Amazon Resource Name (ARN) of the IAM role to use to\n update this StackSet.

\n

Specify an IAM role only if you are using customized administrator roles to control\n which users or groups can manage specific StackSets within the same administrator account. For\n more information, see Grant\n self-managed permissions in the CloudFormation User Guide.

\n

If you specified a customized administrator role when you created the StackSet, you must\n specify a customized administrator role, even if it is the same customized administrator role\n used with this StackSet previously.

" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The name of the IAM execution role to use to update the stack\n set. If you do not specify an execution role, CloudFormation uses the\n AWSCloudFormationStackSetExecutionRole role for the stack set operation.

\n

Specify an IAM role only if you are using customized execution roles to control which\n stack resources users and groups can include in their stack sets.

\n

If you specify a customized execution role, CloudFormation uses that role to update the stack.\n If you do not specify a customized execution role, CloudFormation performs the update using the\n role previously associated with the stack set, so long as you have permissions to perform\n operations on the stack set.

" + "smithy.api#documentation": "

[Self-managed permissions] The name of the IAM execution role to use to update the stack\n set. If you do not specify an execution role, CloudFormation uses the\n AWSCloudFormationStackSetExecutionRole role for the StackSet operation.

\n

Specify an IAM role only if you are using customized execution roles to control which\n stack resources users and groups can include in their StackSets.

\n

If you specify a customized execution role, CloudFormation uses that role to update the stack.\n If you do not specify a customized execution role, CloudFormation performs the update using the\n role previously associated with the StackSet, so long as you have permissions to perform\n operations on the StackSet.

" } }, "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts in which to update\n associated stack instances.

\n

To update all the stack instances associated with this stack set, do not specify\n DeploymentTargets or Regions.

\n

If the stack set update includes changes to the template (that is, if\n TemplateBody or TemplateURL is specified), or the\n Parameters, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the stack set update doesn't include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Regions, while leaving\n all other stack instances with their existing stack instance status.

" + "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts in which to update\n associated stack instances.

\n

To update all the stack instances associated with this StackSet, do not specify\n DeploymentTargets or Regions.

\n

If the StackSet update includes changes to the template (that is, if\n TemplateBody or TemplateURL is specified), or the\n Parameters, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the StackSet update doesn't include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Regions, while leaving\n all other stack instances with their existing stack instance status.

" } }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { - "smithy.api#documentation": "

Describes how the IAM roles required for stack set operations are created. You cannot\n modify PermissionModel if there are stack instances associated with your stack\n set.

\n " + "smithy.api#documentation": "

Describes how the IAM roles required for StackSet operations are created. You cannot\n modify PermissionModel if there are stack instances associated with your stack\n set.

\n " } }, "AutoDeployment": { "target": "com.amazonaws.cloudformation#AutoDeployment", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).\n For more information, see Manage\n automatic deployments for CloudFormation StackSets that use service-managed permissions\n in the CloudFormation User Guide.

\n

If you specify AutoDeployment, don't specify DeploymentTargets\n or Regions.

" + "smithy.api#documentation": "

[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).\n For more information, see Enable or disable automatic deployments for StackSets in Organizations\n in the CloudFormation User Guide.

\n

If you specify AutoDeployment, don't specify DeploymentTargets\n or Regions.

" } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique ID for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the stack set operation only once, even if you retry the request multiple times. You\n might retry stack set operation requests to ensure that CloudFormation successfully received\n them.

\n

If you don't specify an operation ID, CloudFormation generates one\n automatically.

\n

Repeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.

", + "smithy.api#documentation": "

The unique ID for this StackSet operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the StackSet operation only once, even if you retry the request multiple times. You\n might retry StackSet operation requests to ensure that CloudFormation successfully received\n them.

\n

If you don't specify an operation ID, CloudFormation generates one\n automatically.

\n

Repeating this StackSet operation with a new operation ID retries all stack instances\n whose status is OUTDATED.

", "smithy.api#idempotencyToken": {} } }, "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The accounts in which to update associated stack instances. If\n you specify accounts, you must also specify the Amazon Web Services Regions in which to update stack set\n instances.

\n

To update all the stack instances associated with this stack set,\n don't specify the Accounts or Regions properties.

\n

If the stack set update includes changes to the template (that is, if the\n TemplateBody or TemplateURL properties are specified), or the\n Parameters property, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Amazon Web Services Regions, while\n leaving all other stack instances with their existing stack instance status.

" + "smithy.api#documentation": "

[Self-managed permissions] The accounts in which to update associated stack instances. If\n you specify accounts, you must also specify the Amazon Web Services Regions in which to update StackSet\n instances.

\n

To update all the stack instances associated with this StackSet,\n don't specify the Accounts or Regions properties.

\n

If the StackSet update includes changes to the template (that is, if the\n TemplateBody or TemplateURL properties are specified), or the\n Parameters property, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the StackSet update does not include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Amazon Web Services Regions, while\n leaving all other stack instances with their existing stack instance status.

" } }, "Regions": { "target": "com.amazonaws.cloudformation#RegionList", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions,\n you must also specify accounts in which to update stack set instances.

\n

To update all the stack instances associated with this stack set, do\n not specify the Accounts or Regions properties.

\n

If the stack set update includes changes to the template (that is, if the\n TemplateBody or TemplateURL properties are specified), or the\n Parameters property, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Regions. If the stack set update does not include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Regions, while leaving\n all other stack instances with their existing stack instance status.

" + "smithy.api#documentation": "

The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions,\n you must also specify accounts in which to update StackSet instances.

\n

To update all the stack instances associated with this StackSet, do\n not specify the Accounts or Regions properties.

\n

If the StackSet update includes changes to the template (that is, if the\n TemplateBody or TemplateURL properties are specified), or the\n Parameters property, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Regions. If the StackSet update does not include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Regions, while leaving\n all other stack instances with their existing stack instance status.

" } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
  • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
  • \n
" } }, "ManagedExecution": { "target": "com.amazonaws.cloudformation#ManagedExecution", "traits": { - "smithy.api#documentation": "

Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.

" + "smithy.api#documentation": "

Describes whether CloudFormation performs non-conflicting operations concurrently and queues\n conflicting operations.

" } } }, @@ -16489,7 +16515,7 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique ID for this stack set operation.

" + "smithy.api#documentation": "

The unique ID for this StackSet operation.

" } } }, diff --git a/codegen/sdk/aws-models/cloudfront.json b/codegen/sdk/aws-models/cloudfront.json index 35a37687827..c1b772400db 100644 --- a/codegen/sdk/aws-models/cloudfront.json +++ b/codegen/sdk/aws-models/cloudfront.json @@ -2754,17 +2754,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2786,17 +2775,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2818,17 +2796,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2850,17 +2817,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2882,17 +2838,6 @@ "UseDualStack": false } }, - { - "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": { @@ -2914,17 +2859,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2947,18 +2881,28 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://cloudfront-fips.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -2969,43 +2913,53 @@ } ] }, - "url": "https://cloudfront-fips.csp.hci.ic.gov" + "url": "https://cloudfront.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eusc-de-east-1" + } + ] + }, + "url": "https://cloudfront-fips.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingRegion": "us-isof-south-1" + "signingRegion": "eusc-de-east-1" } ] }, - "url": "https://cloudfront.csp.hci.ic.gov" + "url": "https://cloudfront.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } @@ -6638,6 +6592,12 @@ "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 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.

" } + }, + "IpAddressType": { + "target": "com.amazonaws.cloudfront#IpAddressType", + "traits": { + "smithy.api#documentation": "

Specifies which IP protocol CloudFront uses when connecting to your origin. If your origin uses both IPv4 and IPv6 protocols, you can choose dualstack to help optimize reliability.

" + } } }, "traits": { @@ -13439,6 +13399,29 @@ } } }, + "com.amazonaws.cloudfront#IpAddressType": { + "type": "enum", + "members": { + "Ipv4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "Ipv6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + }, + "DualStack": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dualstack" + } + } + } + }, "com.amazonaws.cloudfront#ItemSelection": { "type": "enum", "members": { @@ -16642,6 +16625,12 @@ "traits": { "smithy.api#enumValue": "TLSv1.2_2021" } + }, + "TLSv1_3_2025": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TLSv1.3_2025" + } } } }, diff --git a/codegen/sdk/aws-models/cloudhsm-v2.json b/codegen/sdk/aws-models/cloudhsm-v2.json index fcfcb58bb69..6c26dde9e98 100644 --- a/codegen/sdk/aws-models/cloudhsm-v2.json +++ b/codegen/sdk/aws-models/cloudhsm-v2.json @@ -1099,17 +1099,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1123,17 +1112,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1147,17 +1125,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1171,17 +1138,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/cloudhsm.json b/codegen/sdk/aws-models/cloudhsm.json index 996148ee774..91d27efce94 100644 --- a/codegen/sdk/aws-models/cloudhsm.json +++ b/codegen/sdk/aws-models/cloudhsm.json @@ -731,17 +731,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -755,17 +744,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -779,17 +757,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -803,17 +770,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/cloudsearch-domain.json b/codegen/sdk/aws-models/cloudsearch-domain.json index 62108433ede..f322ea3502a 100644 --- a/codegen/sdk/aws-models/cloudsearch-domain.json +++ b/codegen/sdk/aws-models/cloudsearch-domain.json @@ -539,17 +539,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -563,17 +552,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -587,17 +565,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -611,17 +578,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/cloudsearch.json b/codegen/sdk/aws-models/cloudsearch.json index 7ba0bbf603b..ca039627d7e 100644 --- a/codegen/sdk/aws-models/cloudsearch.json +++ b/codegen/sdk/aws-models/cloudsearch.json @@ -718,17 +718,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -742,17 +731,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -766,17 +744,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -790,17 +757,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/cloudtrail-data.json b/codegen/sdk/aws-models/cloudtrail-data.json index d7cd7e0390a..86e5c773c68 100644 --- a/codegen/sdk/aws-models/cloudtrail-data.json +++ b/codegen/sdk/aws-models/cloudtrail-data.json @@ -646,17 +646,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -670,17 +659,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -694,17 +672,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -718,17 +685,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/cloudtrail.json b/codegen/sdk/aws-models/cloudtrail.json index bc7ea358487..7bfe895857e 100644 --- a/codegen/sdk/aws-models/cloudtrail.json +++ b/codegen/sdk/aws-models/cloudtrail.json @@ -1760,17 +1760,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1784,17 +1773,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1808,17 +1786,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1832,17 +1799,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/cloudwatch-events.json b/codegen/sdk/aws-models/cloudwatch-events.json index b61dcd6823a..4f5acb017ce 100644 --- a/codegen/sdk/aws-models/cloudwatch-events.json +++ b/codegen/sdk/aws-models/cloudwatch-events.json @@ -192,7 +192,7 @@ "sdkId": "CloudWatch Events", "arnNamespace": "events", "cloudFormationName": "Events", - "cloudTrailEventSource": "cloudwatchevents.amazonaws.com", + "cloudTrailEventSource": "events.amazonaws.com", "docId": "events-2015-10-07", "endpointPrefix": "events" }, @@ -1092,17 +1092,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1116,17 +1105,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1140,17 +1118,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1164,17 +1131,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -6408,7 +6364,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n
    \n
  • \n

    \n API\n destination\n

    \n
  • \n
  • \n

    Amazon API Gateway REST API endpoints

    \n
  • \n
  • \n

    API Gateway

    \n
  • \n
  • \n

    Batch job queue

    \n
  • \n
  • \n

    CloudWatch Logs group

    \n
  • \n
  • \n

    CodeBuild project

    \n
  • \n
  • \n

    CodePipeline

    \n
  • \n
  • \n

    Amazon EC2 CreateSnapshot API call

    \n
  • \n
  • \n

    Amazon EC2 RebootInstances API call

    \n
  • \n
  • \n

    Amazon EC2 StopInstances API call

    \n
  • \n
  • \n

    Amazon EC2 TerminateInstances API call

    \n
  • \n
  • \n

    Amazon ECS tasks

    \n
  • \n
  • \n

    Event bus in a different Amazon Web Services account or Region.

    \n

    You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon)\n us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.

    \n
  • \n
  • \n

    Firehose delivery stream (Kinesis Data Firehose)

    \n
  • \n
  • \n

    Inspector assessment template (Amazon Inspector)

    \n
  • \n
  • \n

    Kinesis stream (Kinesis Data Stream)

    \n
  • \n
  • \n

    Lambda function

    \n
  • \n
  • \n

    Redshift clusters (Data API statement execution)

    \n
  • \n
  • \n

    Amazon SNS topic

    \n
  • \n
  • \n

    Amazon SQS queues (includes FIFO queues

    \n
  • \n
  • \n

    SSM Automation

    \n
  • \n
  • \n

    SSM OpsItem

    \n
  • \n
  • \n

    SSM Run Command

    \n
  • \n
  • \n

    Step Functions state machines

    \n
  • \n
\n

Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The\n built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API\n call, EC2 StopInstances API call, and EC2 TerminateInstances API\n call.

\n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.

\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n needs the appropriate permissions. For Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, \n Step Functions state machines and API Gateway REST APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN argument in PutTargets.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.

\n

If another Amazon Web Services account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge\n Pricing.

\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different Amazon Web Services \n account.

\n
\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.

\n

For more information about enabling cross-account events, see PutPermission.

\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n
    \n
  • \n

    If none of the following arguments are specified for a target, then the entire event\n is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or\n Amazon ECS task, in which case nothing from the event is passed to the target).

    \n
  • \n
  • \n

    If Input is specified in the form of valid JSON, then\n the matched event is overridden with this constant.

    \n
  • \n
  • \n

    If InputPath is specified in the form of JSONPath\n (for example, $.detail), then only the part of the event specified in the\n path is passed to the target (for example, only the detail part of the event is\n passed).

    \n
  • \n
  • \n

    If InputTransformer is specified, then one or more\n specified JSONPaths are extracted from the event and used as values in a template that you\n specify as the input to the target.

    \n
  • \n
\n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" + "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n
    \n
  • \n

    \n API\n destination\n

    \n
  • \n
  • \n

    Amazon API Gateway REST API endpoints

    \n
  • \n
  • \n

    API Gateway

    \n
  • \n
  • \n

    Batch job queue

    \n
  • \n
  • \n

    CloudWatch Logs group

    \n
  • \n
  • \n

    CodeBuild project

    \n
  • \n
  • \n

    CodePipeline

    \n
  • \n
  • \n

    Amazon EC2 CreateSnapshot API call

    \n
  • \n
  • \n

    Amazon EC2 RebootInstances API call

    \n
  • \n
  • \n

    Amazon EC2 StopInstances API call

    \n
  • \n
  • \n

    Amazon EC2 TerminateInstances API call

    \n
  • \n
  • \n

    Amazon ECS tasks

    \n
  • \n
  • \n

    Event bus in a different Amazon Web Services account or Region.

    \n

    You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon)\n us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.

    \n
  • \n
  • \n

    Firehose delivery stream (Firehose)

    \n
  • \n
  • \n

    Inspector assessment template (Amazon Inspector)

    \n
  • \n
  • \n

    Kinesis stream (Kinesis Data Stream)

    \n
  • \n
  • \n

    Lambda function

    \n
  • \n
  • \n

    Redshift clusters (Data API statement execution)

    \n
  • \n
  • \n

    Amazon SNS topic

    \n
  • \n
  • \n

    Amazon SQS queues (includes FIFO queues

    \n
  • \n
  • \n

    SSM Automation

    \n
  • \n
  • \n

    SSM OpsItem

    \n
  • \n
  • \n

    SSM Run Command

    \n
  • \n
  • \n

    Step Functions state machines

    \n
  • \n
\n

Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The\n built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API\n call, EC2 StopInstances API call, and EC2 TerminateInstances API\n call.

\n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.

\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n needs the appropriate permissions. For Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, \n Step Functions state machines and API Gateway REST APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN argument in PutTargets.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.

\n

If another Amazon Web Services account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge\n Pricing.

\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different Amazon Web Services \n account.

\n
\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.

\n

For more information about enabling cross-account events, see PutPermission.

\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n
    \n
  • \n

    If none of the following arguments are specified for a target, then the entire event\n is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or\n Amazon ECS task, in which case nothing from the event is passed to the target).

    \n
  • \n
  • \n

    If Input is specified in the form of valid JSON, then\n the matched event is overridden with this constant.

    \n
  • \n
  • \n

    If InputPath is specified in the form of JSONPath\n (for example, $.detail), then only the part of the event specified in the\n path is passed to the target (for example, only the detail part of the event is\n passed).

    \n
  • \n
  • \n

    If InputTransformer is specified, then one or more\n specified JSONPaths are extracted from the event and used as values in a template that you\n specify as the input to the target.

    \n
  • \n
\n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" } }, "com.amazonaws.cloudwatchevents#PutTargetsRequest": { @@ -7216,20 +7172,20 @@ "Name": { "target": "com.amazonaws.cloudwatchevents#SageMakerPipelineParameterName", "traits": { - "smithy.api#documentation": "

Name of parameter to start execution of a SageMaker Model Building Pipeline.

", + "smithy.api#documentation": "

Name of parameter to start execution of a SageMaker AI Model Building Pipeline.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.cloudwatchevents#SageMakerPipelineParameterValue", "traits": { - "smithy.api#documentation": "

Value of parameter to start execution of a SageMaker Model Building Pipeline.

", + "smithy.api#documentation": "

Value of parameter to start execution of a SageMaker AI Model Building Pipeline.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Name/Value pair of a parameter to start execution of a SageMaker Model Building\n Pipeline.

" + "smithy.api#documentation": "

Name/Value pair of a parameter to start execution of a SageMaker AI Model Building\n Pipeline.

" } }, "com.amazonaws.cloudwatchevents#SageMakerPipelineParameterList": { @@ -7269,12 +7225,12 @@ "PipelineParameterList": { "target": "com.amazonaws.cloudwatchevents#SageMakerPipelineParameterList", "traits": { - "smithy.api#documentation": "

List of Parameter names and values for SageMaker Model Building Pipeline execution.

" + "smithy.api#documentation": "

List of Parameter names and values for SageMaker AI Model Building Pipeline execution.

" } } }, "traits": { - "smithy.api#documentation": "

These are custom parameters to use when the target is a SageMaker Model Building Pipeline\n that starts based on EventBridge events.

" + "smithy.api#documentation": "

These are custom parameters to use when the target is a SageMaker AI Model Building Pipeline\n that starts based on EventBridge events.

" } }, "com.amazonaws.cloudwatchevents#ScheduleExpression": { @@ -7656,7 +7612,7 @@ "SageMakerPipelineParameters": { "target": "com.amazonaws.cloudwatchevents#SageMakerPipelineParameters", "traits": { - "smithy.api#documentation": "

Contains the SageMaker Model Building Pipeline parameters to start execution of a\n SageMaker Model Building Pipeline.

\n

If you specify a SageMaker Model Building Pipeline as a target, you can use this to\n specify parameters to start a pipeline execution based on EventBridge events.

" + "smithy.api#documentation": "

Contains the SageMaker AI Model Building Pipeline parameters to start execution of a\n SageMaker AI Model Building Pipeline.

\n

If you specify a SageMaker AI Model Building Pipeline as a target, you can use this to\n specify parameters to start a pipeline execution based on EventBridge events.

" } }, "DeadLetterConfig": { diff --git a/codegen/sdk/aws-models/cloudwatch-logs.json b/codegen/sdk/aws-models/cloudwatch-logs.json index 7cd7bc71750..85ff8b6add0 100644 --- a/codegen/sdk/aws-models/cloudwatch-logs.json +++ b/codegen/sdk/aws-models/cloudwatch-logs.json @@ -2080,13 +2080,13 @@ "resourceArn": { "target": "com.amazonaws.cloudwatchlogs#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch Logs resource for which the resource policy needs to be deleted

" + "smithy.api#documentation": "

The ARN of the CloudWatch Logs resource for which the resource policy needs to be\n deleted

" } }, "expectedRevisionId": { "target": "com.amazonaws.cloudwatchlogs#ExpectedRevisionId", "traits": { - "smithy.api#documentation": "

The expected revision ID of the resource policy. Required when deleting a resource-scoped policy to prevent concurrent modifications.

" + "smithy.api#documentation": "

The expected revision ID of the resource policy. Required when deleting a resource-scoped\n policy to prevent concurrent modifications.

" } } }, @@ -2284,7 +2284,7 @@ "deliveryDestinationType": { "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", "traits": { - "smithy.api#documentation": "

Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, Firehose, or X-Ray.

" + "smithy.api#documentation": "

Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, Firehose, or X-Ray.

" } }, "recordFields": { @@ -2334,7 +2334,7 @@ "deliveryDestinationType": { "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", "traits": { - "smithy.api#documentation": "

Displays whether this delivery destination is CloudWatch Logs, Amazon S3, Firehose, or X-Ray.

" + "smithy.api#documentation": "

Displays whether this delivery destination is CloudWatch Logs, Amazon S3,\n Firehose, or X-Ray.

" } }, "outputFormat": { @@ -2357,7 +2357,7 @@ } }, "traits": { - "smithy.api#documentation": "

This structure contains information about one delivery destination in\n your account. A delivery destination is an Amazon Web Services resource that represents an\n Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, Firehose, and X-Ray\n are supported as delivery destinations.

\n

To configure logs delivery between a supported Amazon Web Services service and a\n destination, you must do the following:

\n
    \n
  • \n

    Create a delivery source, which is a logical object that represents the resource that\n is actually sending the logs. For more information, see PutDeliverySource.

    \n
  • \n
  • \n

    Create a delivery destination, which is a logical object that\n represents the actual delivery destination.

    \n
  • \n
  • \n

    If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.\n

    \n
  • \n
  • \n

    Create a delivery by pairing exactly one delivery source and one\n delivery destination. For more information, see CreateDelivery.

    \n
  • \n
\n

You can configure a single delivery source to send logs to multiple destinations by\n creating multiple deliveries. You can also create multiple deliveries to configure multiple\n delivery sources to send logs to the same delivery destination.

" + "smithy.api#documentation": "

This structure contains information about one delivery destination in\n your account. A delivery destination is an Amazon Web Services resource that represents an\n Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3,\n Firehose, and X-Ray are supported as delivery destinations.

\n

To configure logs delivery between a supported Amazon Web Services service and a\n destination, you must do the following:

\n
    \n
  • \n

    Create a delivery source, which is a logical object that represents the resource that\n is actually sending the logs. For more information, see PutDeliverySource.

    \n
  • \n
  • \n

    Create a delivery destination, which is a logical object that\n represents the actual delivery destination.

    \n
  • \n
  • \n

    If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.\n

    \n
  • \n
  • \n

    Create a delivery by pairing exactly one delivery source and one\n delivery destination. For more information, see CreateDelivery.

    \n
  • \n
\n

You can configure a single delivery source to send logs to multiple destinations by\n creating multiple deliveries. You can also create multiple deliveries to configure multiple\n delivery sources to send logs to the same delivery destination.

" } }, "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration": { @@ -2715,7 +2715,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of the deliveries that have been created in the account.

\n

A delivery is a connection between a \n delivery\n source\n and a \n delivery destination\n .

\n

A delivery source represents an Amazon Web Services resource that sends logs to an logs\n delivery destination. The destination can be CloudWatch Logs, Amazon S3, Firehose or X-Ray. Only some Amazon Web Services services support being configured as a delivery\n source. These services are listed in Enable logging from\n Amazon Web Services services.\n

", + "smithy.api#documentation": "

Retrieves a list of the deliveries that have been created in the account.

\n

A delivery is a connection between a \n delivery\n source\n and a \n delivery destination\n .

\n

A delivery source represents an Amazon Web Services resource that sends logs to an logs\n delivery destination. The destination can be CloudWatch Logs, Amazon S3, Firehose or X-Ray. Only some Amazon Web Services services support being\n configured as a delivery source. These services are listed in Enable logging from\n Amazon Web Services services.\n

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3054,7 +3054,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of field indexes listed in the field index policies of one or more log\n groups. For more information about field index policies, see PutIndexPolicy.

" + "smithy.api#documentation": "

Returns a list of custom and default field indexes which are discovered in log data. For\n more information about field index policies, see PutIndexPolicy.

" } }, "com.amazonaws.cloudwatchlogs#DescribeFieldIndexesLogGroupIdentifiers": { @@ -3130,7 +3130,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the field index policies of one or more log groups. For more information about\n field index policies, see PutIndexPolicy.

\n

If a specified log group has a log-group level index policy, that policy is returned by\n this operation.

\n

If a specified log group doesn't have a log-group level index policy, but an account-wide\n index policy applies to it, that account-wide policy is returned by this operation.

\n

To find information about only account-level policies, use DescribeAccountPolicies instead.

" + "smithy.api#documentation": "

Returns the field index policies of the specified log group. For more information about\n field index policies, see PutIndexPolicy.

\n

If a specified log group has a log-group level index policy, that policy is returned by\n this operation.

\n

If a specified log group doesn't have a log-group level index policy, but an account-wide\n index policy applies to it, that account-wide policy is returned by this operation.

\n

To find information about only account-level policies, use DescribeAccountPolicies instead.

" } }, "com.amazonaws.cloudwatchlogs#DescribeIndexPoliciesLogGroupIdentifiers": { @@ -3690,7 +3690,7 @@ "policyScope": { "target": "com.amazonaws.cloudwatchlogs#PolicyScope", "traits": { - "smithy.api#documentation": "

Specifies the scope of the resource policy. Valid values are ACCOUNT or RESOURCE. When not specified, defaults to ACCOUNT.

" + "smithy.api#documentation": "

Specifies the scope of the resource policy. Valid values are ACCOUNT or\n RESOURCE. When not specified, defaults to ACCOUNT.

" } } }, @@ -3996,6 +3996,12 @@ "smithy.api#default": 0 } }, + "com.amazonaws.cloudwatchlogs#EmitSystemFields": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#SystemField" + } + }, "com.amazonaws.cloudwatchlogs#EncryptionKey": { "type": "string", "traits": { @@ -4532,18 +4538,27 @@ "target": "com.amazonaws.cloudwatchlogs#FieldIndex" } }, + "com.amazonaws.cloudwatchlogs#FieldSelectionCriteria": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, "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.

" + "smithy.api#documentation": "

The actual log data content returned in the streaming response. This contains the fields\n and values of the log event in a structured format that can be parsed and processed by the\n 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.

" + "smithy.api#documentation": "

A structure containing the extracted fields from a log event. These fields are extracted\n based on the log format and can be used for structured querying and analysis.

" } }, "com.amazonaws.cloudwatchlogs#FilterCount": { @@ -4569,7 +4584,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists log events from the specified log group. You can list all the log events or\n filter the results using one or more of the following:

\n
    \n
  • \n

    A filter pattern

    \n
  • \n
  • \n

    A time range

    \n
  • \n
  • \n

    The log stream name, or a log stream name prefix that matches mutltiple log\n streams

    \n
  • \n
\n

You must have the logs:FilterLogEvents permission to perform this\n operation.

\n

You can specify the log group to search by using either logGroupIdentifier or\n logGroupName. You must include one of these two parameters, but you can't\n include both.

\n

\n FilterLogEvents is a paginated operation. Each page returned can contain up\n to 1 MB of log events or up to 10,000 log events. A returned page might only be partially\n full, or even empty. For example, if the result of a query would return 15,000 log events, the\n first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.

\n

Partially full or empty pages don't necessarily mean that pagination is finished. If the\n results include a nextToken, there might be more log events available. You can\n return these additional log events by providing the nextToken in a subsequent\n FilterLogEvents operation. If the results don't include a\n nextToken, then pagination is finished.

\n

Specifying the limit parameter only guarantees that a single page doesn't\n return more log events than the specified limit, but it might return fewer events than the\n limit. This is the expected API behavior.

\n

The returned log events are sorted by event timestamp, the timestamp when the event was\n ingested by CloudWatch Logs, and the ID of the PutLogEvents request.

\n

If you are using CloudWatch cross-account observability, you can use this operation\n in a monitoring account and view data from the linked source accounts. For more information,\n see CloudWatch cross-account observability.

\n \n

If you are using log\n transformation, the FilterLogEvents operation returns only the\n original versions of log events, before they were transformed. To view the transformed\n versions, you must use a CloudWatch Logs\n query.\n

\n
", + "smithy.api#documentation": "

Lists log events from the specified log group. You can list all the log events or\n filter the results using one or more of the following:

\n
    \n
  • \n

    A filter pattern

    \n
  • \n
  • \n

    A time range

    \n
  • \n
  • \n

    The log stream name, or a log stream name prefix that matches multiple log\n streams

    \n
  • \n
\n

You must have the logs:FilterLogEvents permission to perform this\n operation.

\n

You can specify the log group to search by using either logGroupIdentifier or\n logGroupName. You must include one of these two parameters, but you can't\n include both.

\n

\n FilterLogEvents is a paginated operation. Each page returned can contain up\n to 1 MB of log events or up to 10,000 log events. A returned page might only be partially\n full, or even empty. For example, if the result of a query would return 15,000 log events, the\n first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.

\n

Partially full or empty pages don't necessarily mean that pagination is finished. If the\n results include a nextToken, there might be more log events available. You can\n return these additional log events by providing the nextToken in a subsequent\n FilterLogEvents operation. If the results don't include a\n nextToken, then pagination is finished.

\n

Specifying the limit parameter only guarantees that a single page doesn't\n return more log events than the specified limit, but it might return fewer events than the\n limit. This is the expected API behavior.

\n

The returned log events are sorted by event timestamp, the timestamp when the event was\n ingested by CloudWatch Logs, and the ID of the PutLogEvents request.

\n

If you are using CloudWatch cross-account observability, you can use this operation\n in a monitoring account and view data from the linked source accounts. For more information,\n see CloudWatch cross-account observability.

\n \n

If you are using log\n transformation, the FilterLogEvents operation returns only the\n original versions of log events, before they were transformed. To view the transformed\n versions, you must use a CloudWatch Logs\n query.\n

\n
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -5478,7 +5493,7 @@ } ], "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#documentation": "

Retrieves a large logging object (LLO) and streams it back. This API is used to fetch the\n content of large portions of log events that have been ingested through the\n PutOpenTelemetryLogs API. When log events contain fields that would cause the total event size\n to exceed 1MB, CloudWatch Logs automatically processes up to 10 fields, starting with the\n largest fields. Each field is truncated as needed to keep the total event size as close to 1MB\n as possible. The excess portions are stored as Large Log Objects (LLOs) and these fields are\n processed separately and LLO reference system fields (in the format\n @ptr.$[path.to.field]) are added. The path in the reference field reflects the\n original JSON structure where the large field was located. For example, this could be\n @ptr.$['input']['message'], @ptr.$['AAA']['BBB']['CCC']['DDD'],\n @ptr.$['AAA'], or any other path matching your log structure.

", "smithy.api#endpoint": { "hostPrefix": "streaming-" } @@ -5491,13 +5506,13 @@ "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.

" + "smithy.api#documentation": "

A boolean flag that indicates whether to unmask sensitive log data. When set to true, any\n masked or redacted data in the log object will be displayed in its original form. Default is\n 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#documentation": "

A pointer to the specific log object to retrieve. This is a required parameter that\n uniquely identifies the log object within CloudWatch Logs. The pointer is typically obtained\n from a previous query or filter operation.

", "smithy.api#required": {} } } @@ -5511,7 +5526,10 @@ "type": "structure", "members": { "fieldStream": { - "target": "com.amazonaws.cloudwatchlogs#GetLogObjectResponseStream" + "target": "com.amazonaws.cloudwatchlogs#GetLogObjectResponseStream", + "traits": { + "smithy.api#documentation": "

A stream of structured log data returned by the GetLogObject operation. This stream\n contains log events with their associated metadata and extracted fields.

" + } } }, "traits": { @@ -5526,11 +5544,14 @@ "target": "com.amazonaws.cloudwatchlogs#FieldsData" }, "InternalStreamingException": { - "target": "com.amazonaws.cloudwatchlogs#InternalStreamingException" + "target": "com.amazonaws.cloudwatchlogs#InternalStreamingException", + "traits": { + "smithy.api#documentation": "

An internal error occurred during the streaming of log data. This exception is thrown when\n there's an issue with the internal streaming mechanism used by the GetLogObject\n operation.

" + } } }, "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#documentation": "

A stream of structured log data returned by the GetLogObject operation. This stream\n contains log events with their associated metadata and extracted fields.

", "smithy.api#streaming": {} } }, @@ -5757,13 +5778,13 @@ "match": { "target": "com.amazonaws.cloudwatchlogs#GrokMatch", "traits": { - "smithy.api#documentation": "

The grok pattern to match against the log event. For a list of supported grok patterns,\n see Supported grok patterns.

", + "smithy.api#documentation": "

The grok pattern to match against the log event. For a list of supported grok patterns,\n see Supported grok patterns.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

This processor uses pattern matching to parse and structure unstructured data. This\n processor can also extract fields from log messages.

\n

For more information about this processor including examples, see grok in the CloudWatch Logs User Guide.

" + "smithy.api#documentation": "

This processor uses pattern matching to parse and structure unstructured data. This\n processor can also extract fields from log messages.

\n

For more information about this processor including examples, see grok in the CloudWatch Logs User Guide.

" } }, "com.amazonaws.cloudwatchlogs#GrokMatch": { @@ -6044,7 +6065,7 @@ } }, "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#documentation": "

An internal error occurred during the streaming of log data. This exception is thrown when\n there's an issue with the internal streaming mechanism used by the GetLogObject\n operation.

", "smithy.api#error": "client" } }, @@ -8386,17 +8407,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -8410,17 +8420,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -8434,17 +8433,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -8458,17 +8446,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -8632,6 +8609,18 @@ "smithy.api#default": false, "smithy.api#documentation": "

This parameter is valid only for log groups that have an active log transformer. For more\n information about log transformers, see PutTransformer.

\n

If this value is true, the metric filter is applied on the transformed\n version of the log events instead of the original ingested log events.

" } + }, + "fieldSelectionCriteria": { + "target": "com.amazonaws.cloudwatchlogs#FieldSelectionCriteria", + "traits": { + "smithy.api#documentation": "

The filter expression that specifies which log events are processed by this metric filter based on system fields. Returns the fieldSelectionCriteria value if it was specified when the metric filter was created.

" + } + }, + "emitSystemFieldDimensions": { + "target": "com.amazonaws.cloudwatchlogs#EmitSystemFields", + "traits": { + "smithy.api#documentation": "

The list of system fields that are emitted as additional dimensions in the generated metrics. Returns the emitSystemFieldDimensions value if it was specified when the metric filter was created.

" + } } }, "traits": { @@ -9863,7 +9852,7 @@ } ], "traits": { - "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
" + "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 logs:PutAccountPolicy\n 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

CloudWatch Logs provides default field indexes for all log groups in the Standard log\n class. Default field indexes are automatically available for the following fields:

\n
    \n
  • \n

    \n @aws.region\n

    \n
  • \n
  • \n

    \n @aws.account\n

    \n
  • \n
  • \n

    \n @source.log\n

    \n
  • \n
  • \n

    \n traceId\n

    \n
  • \n
\n

Default field indexes are in addition to any custom field indexes you define within your\n policy. Default field indexes are not counted towards your field index quota.

\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\n a 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\n LogGroupName and LogGroupNamePrefix using the operators\n 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\n extraction policy with selection criteria LogGroupNamePrefix IN [\"/my-log-prod\"]\n or LogGroupNamePrefix IN [\"/my-logging\"], as the set of log groups matching these\n prefixes would be a subset of the log groups matching the first policy's prefix, creating an\n overlap.

\n

When using NOT IN, only one policy with this operator is allowed per\n account.

\n

When combining policies with IN and NOT IN operators, the\n overlap check ensures that policies don't have conflicting effects. Two policies with\n IN and NOT IN operators do not overlap if and only if every value\n in the IN policy is completely contained within some value in the NOT\n IN policy. For example:

\n
    \n
  • \n

    If you have a NOT IN policy for prefix \"/aws/lambda\", you\n can create an IN policy for the exact log group name\n \"/aws/lambda/function1\" because the set of log groups matching\n \"/aws/lambda/function1\" is a subset of the log groups matching\n \"/aws/lambda\".

    \n
  • \n
  • \n

    If you have a NOT IN policy for prefix \"/aws/lambda\", you\n cannot create an IN policy for prefix \"/aws\" because the set of\n log groups matching \"/aws\" is not a subset of the log groups matching\n \"/aws/lambda\".

    \n
  • \n
" } }, "com.amazonaws.cloudwatchlogs#PutAccountPolicyRequest": { @@ -10027,7 +10016,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a logical delivery destination. A delivery\n destination is an Amazon Web Services resource that represents an Amazon Web Services service\n that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are\n supported as logs delivery destinations and X-Ray as the trace delivery destination.

\n

To configure logs delivery between a supported Amazon Web Services service and a\n destination, you must do the following:

\n
    \n
  • \n

    Create a delivery source, which is a logical object that represents the resource that\n is actually sending the logs. For more information, see PutDeliverySource.

    \n
  • \n
  • \n

    Use PutDeliveryDestination to create a delivery\n destination in the same account of the actual delivery destination. The\n delivery destination that you create is a logical object that represents the actual\n delivery destination.

    \n
  • \n
  • \n

    If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.\n

    \n
  • \n
  • \n

    Use CreateDelivery to create a delivery by pairing\n exactly one delivery source and one delivery destination. For more information, see CreateDelivery.

    \n
  • \n
\n

You can configure a single delivery source to send logs to multiple destinations by\n creating multiple deliveries. You can also create multiple deliveries to configure multiple\n delivery sources to send logs to the same delivery destination.

\n

Only some Amazon Web Services services support being configured as a delivery source. These\n services are listed as Supported [V2 Permissions] in the\n table at Enabling logging from\n Amazon Web Services services.\n

\n

If you use this operation to update an existing delivery destination, all the current\n delivery destination parameters are overwritten with the new parameter values that you\n specify.

" + "smithy.api#documentation": "

Creates or updates a logical delivery destination. A delivery\n destination is an Amazon Web Services resource that represents an Amazon Web Services service\n that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are\n supported as logs delivery destinations and X-Ray as the trace delivery\n destination.

\n

To configure logs delivery between a supported Amazon Web Services service and a\n destination, you must do the following:

\n
    \n
  • \n

    Create a delivery source, which is a logical object that represents the resource that\n is actually sending the logs. For more information, see PutDeliverySource.

    \n
  • \n
  • \n

    Use PutDeliveryDestination to create a delivery\n destination in the same account of the actual delivery destination. The\n delivery destination that you create is a logical object that represents the actual\n delivery destination.

    \n
  • \n
  • \n

    If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.\n

    \n
  • \n
  • \n

    Use CreateDelivery to create a delivery by pairing\n exactly one delivery source and one delivery destination. For more information, see CreateDelivery.

    \n
  • \n
\n

You can configure a single delivery source to send logs to multiple destinations by\n creating multiple deliveries. You can also create multiple deliveries to configure multiple\n delivery sources to send logs to the same delivery destination.

\n

Only some Amazon Web Services services support being configured as a delivery source. These\n services are listed as Supported [V2 Permissions] in the\n table at Enabling logging from\n Amazon Web Services services.\n

\n

If you use this operation to update an existing delivery destination, all the current\n delivery destination parameters are overwritten with the new parameter values that you\n specify.

" } }, "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicy": { @@ -10111,13 +10100,13 @@ "deliveryDestinationConfiguration": { "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration", "traits": { - "smithy.api#documentation": "

A structure that contains the ARN of the Amazon Web Services resource that will receive the\n logs.

\n \n

\n deliveryDestinationConfiguration is required for CloudWatch Logs, Amazon S3, Firehose log delivery destinations and not required for X-Ray trace delivery destinations. deliveryDestinationType is needed for X-Ray trace delivery destinations but not required for other logs delivery destinations.

\n
" + "smithy.api#documentation": "

A structure that contains the ARN of the Amazon Web Services resource that will receive the\n logs.

\n \n

\n deliveryDestinationConfiguration is required for CloudWatch Logs,\n Amazon S3, Firehose log delivery destinations and not required for\n X-Ray trace delivery destinations. deliveryDestinationType is\n needed for X-Ray trace delivery destinations but not required for other logs\n delivery destinations.

\n
" } }, "deliveryDestinationType": { "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", "traits": { - "smithy.api#documentation": "

The type of delivery destination. This parameter specifies the target service where log data will be delivered. Valid values include:

\n
    \n
  • \n

    \n S3 - Amazon S3 for long-term storage and analytics

    \n
  • \n
  • \n

    \n CWL - CloudWatch Logs for centralized log management

    \n
  • \n
  • \n

    \n FH - Amazon Kinesis Data Firehose for real-time data streaming

    \n
  • \n
  • \n

    \n XRAY - Amazon Web Services X-Ray for distributed tracing and application monitoring

    \n
  • \n
\n

The delivery destination type determines the format and configuration options available for log delivery.

" + "smithy.api#documentation": "

The type of delivery destination. This parameter specifies the target service where log\n data will be delivered. Valid values include:

\n
    \n
  • \n

    \n S3 - Amazon S3 for long-term storage and analytics

    \n
  • \n
  • \n

    \n CWL - CloudWatch Logs for centralized log management

    \n
  • \n
  • \n

    \n FH - Amazon Kinesis Data Firehose for real-time data streaming

    \n
  • \n
  • \n

    \n XRAY - Amazon Web Services\n X-Ray for distributed tracing and application monitoring

    \n
  • \n
\n

The delivery destination type determines the format and configuration options available\n for log delivery.

" } }, "tags": { @@ -10197,7 +10186,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\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#documentation": "

Defines the type of log that the source is sending.

\n
    \n
  • \n

    For Amazon Bedrock, the valid value is APPLICATION_LOGS and\n 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": {} } }, @@ -10375,7 +10364,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a field index policy for the specified log group.\n Only log groups in the Standard log class support field index policies. For more information\n about log classes, see Log\n classes.

\n

You can use field index policies to create field indexes on fields\n found in log events in the log group. Creating field indexes speeds up and lowers the costs\n for CloudWatch Logs Insights queries that reference those field indexes, because these\n queries attempt to skip the processing of log events that are known to not match the indexed\n field. Good fields to index are fields that you often need to query for and fields or values\n that match only a small fraction of the total log events. Common examples of indexes include\n request ID, session ID, userID, and instance IDs. For more information, see Create field indexes to improve query performance and reduce costs.

\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 process fewer log events to reduce costs, and\n have improved performance.

\n

Each index policy has the following quotas and restrictions:

\n
    \n
  • \n

    As many as 20 fields can be included in the policy.

    \n
  • \n
  • \n

    Each field name can include as many as 100 characters.

    \n
  • \n
\n

Matches of log events to the names of indexed fields are case-sensitive. For example, a\n field index of RequestId won't match a log event containing\n requestId.

\n

Log group-level field index policies created with PutIndexPolicy override\n account-level field index policies created with PutAccountPolicy. If you use PutIndexPolicy to create a field index\n policy for a log group, that log group uses only that policy. The log group ignores any\n account-wide field index policy that you might have created.

" + "smithy.api#documentation": "

Creates or updates a field index policy for the specified log group.\n Only log groups in the Standard log class support field index policies. For more information\n about log classes, see Log\n classes.

\n

You can use field index policies to create field indexes on fields\n found in log events in the log group. Creating field indexes speeds up and lowers the costs\n for CloudWatch Logs Insights queries that reference those field indexes, because these\n queries attempt to skip the processing of log events that are known to not match the indexed\n field. Good fields to index are fields that you often need to query for and fields or values\n that match only a small fraction of the total log events. Common examples of indexes include\n request ID, session ID, userID, and instance IDs. For more information, see Create field indexes to improve query performance and reduce costs.

\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 process fewer log events to reduce costs, and\n have improved performance.

\n

CloudWatch Logs provides default field indexes for all log groups in the Standard log\n class. Default field indexes are automatically available for the following fields:

\n
    \n
  • \n

    \n @aws.region\n

    \n
  • \n
  • \n

    \n @aws.account\n

    \n
  • \n
  • \n

    \n @source.log\n

    \n
  • \n
  • \n

    \n traceId\n

    \n
  • \n
\n

Default field indexes are in addition to any custom field indexes you define within your\n policy. Default field indexes are not counted towards your field index quota.

\n

Each index policy has the following quotas and restrictions:

\n
    \n
  • \n

    As many as 20 fields can be included in the policy.

    \n
  • \n
  • \n

    Each field name can include as many as 100 characters.

    \n
  • \n
\n

Matches of log events to the names of indexed fields are case-sensitive. For example, a\n field index of RequestId won't match a log event containing\n requestId.

\n

Log group-level field index policies created with PutIndexPolicy override\n account-level field index policies created with PutAccountPolicy. If you use PutIndexPolicy to create a field index\n policy for a log group, that log group uses only that policy. The log group ignores any\n account-wide field index policy that you might have created.

" } }, "com.amazonaws.cloudwatchlogs#PutIndexPolicyRequest": { @@ -10657,6 +10646,18 @@ "smithy.api#default": false, "smithy.api#documentation": "

This parameter is valid only for log groups that have an active log transformer. For more\n information about log transformers, see PutTransformer.

\n

If the log group uses either a log-group level or account-level transformer, and you\n specify true, the metric filter will be applied on the transformed version of the\n log events instead of the original ingested log events.

" } + }, + "fieldSelectionCriteria": { + "target": "com.amazonaws.cloudwatchlogs#FieldSelectionCriteria", + "traits": { + "smithy.api#documentation": "

A filter expression that specifies which log events should be processed by this metric filter based on system fields such as source account and source region. Uses selection criteria syntax with operators like =, !=, AND, OR, IN, NOT IN. Example: @aws.region = \"us-east-1\" or @aws.account IN [\"123456789012\", \"987654321098\"]. Maximum length: 2000 characters.

" + } + }, + "emitSystemFieldDimensions": { + "target": "com.amazonaws.cloudwatchlogs#EmitSystemFields", + "traits": { + "smithy.api#documentation": "

A list of system fields to emit as additional dimensions in the generated metrics. Valid values are @aws.account and @aws.region. These dimensions help identify the source of centralized log data and count toward the total dimension limit for metric filters.

" + } } }, "traits": { @@ -10797,13 +10798,13 @@ "resourceArn": { "target": "com.amazonaws.cloudwatchlogs#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch Logs resource to which the resource policy needs to be added or attached. Currently only supports LogGroup ARN.

" + "smithy.api#documentation": "

The ARN of the CloudWatch Logs resource to which the resource policy needs to be added\n or attached. Currently only supports LogGroup ARN.

" } }, "expectedRevisionId": { "target": "com.amazonaws.cloudwatchlogs#ExpectedRevisionId", "traits": { - "smithy.api#documentation": "

The expected revision ID of the resource policy. Required when resourceArn is provided to prevent concurrent modifications. Use null when creating a resource policy for the first time.

" + "smithy.api#documentation": "

The expected revision ID of the resource policy. Required when resourceArn is\n provided to prevent concurrent modifications. Use null when creating a resource\n policy for the first time.

" } } }, @@ -10823,7 +10824,7 @@ "revisionId": { "target": "com.amazonaws.cloudwatchlogs#ExpectedRevisionId", "traits": { - "smithy.api#documentation": "

The revision ID of the created or updated resource policy. Only returned for resource-scoped policies.

" + "smithy.api#documentation": "

The revision ID of the created or updated resource policy. Only returned for\n resource-scoped policies.

" } } }, @@ -10959,6 +10960,18 @@ "smithy.api#default": false, "smithy.api#documentation": "

This parameter is valid only for log groups that have an active log transformer. For more\n information about log transformers, see PutTransformer.

\n

If the log group uses either a log-group level or account-level transformer, and you\n specify true, the subscription filter will be applied on the transformed version\n of the log events instead of the original ingested log events.

" } + }, + "fieldSelectionCriteria": { + "target": "com.amazonaws.cloudwatchlogs#FieldSelectionCriteria", + "traits": { + "smithy.api#documentation": "

A filter expression that specifies which log events should be processed by this subscription filter based on system fields such as source account and source region. Uses selection criteria syntax with operators like =, !=, AND, OR, IN, NOT IN. Example: @aws.region NOT IN [\"cn-north-1\"] or @aws.account = \"123456789012\" AND @aws.region = \"us-east-1\". Maximum length: 2000 characters.

" + } + }, + "emitSystemFields": { + "target": "com.amazonaws.cloudwatchlogs#EmitSystemFields", + "traits": { + "smithy.api#documentation": "

A list of system fields to include in the log events sent to the subscription destination. Valid values are @aws.account and @aws.region. These fields provide source information for centralized log data in the forwarded payload.

" + } } }, "traits": { @@ -11579,13 +11592,13 @@ "resourceArn": { "target": "com.amazonaws.cloudwatchlogs#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch Logs resource to which the resource policy is attached. Only populated for resource-scoped policies.

" + "smithy.api#documentation": "

The ARN of the CloudWatch Logs resource to which the resource policy is attached. Only\n populated for resource-scoped policies.

" } }, "revisionId": { "target": "com.amazonaws.cloudwatchlogs#ExpectedRevisionId", "traits": { - "smithy.api#documentation": "

The revision ID of the resource policy. Only populated for resource-scoped policies.

" + "smithy.api#documentation": "

The revision ID of the resource policy. Only populated for resource-scoped\n policies.

" } } }, @@ -12390,6 +12403,18 @@ "traits": { "smithy.api#documentation": "

The creation time of the subscription filter, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC.

" } + }, + "fieldSelectionCriteria": { + "target": "com.amazonaws.cloudwatchlogs#FieldSelectionCriteria", + "traits": { + "smithy.api#documentation": "

The filter expression that specifies which log events are processed by this subscription filter based on system fields. Returns the fieldSelectionCriteria value if it was specified when the subscription filter was created.

" + } + }, + "emitSystemFields": { + "target": "com.amazonaws.cloudwatchlogs#EmitSystemFields", + "traits": { + "smithy.api#documentation": "

The list of system fields that are included in the log events sent to the subscription destination. Returns the emitSystemFields value if it was specified when the subscription filter was created.

" + } } }, "traits": { @@ -12542,6 +12567,9 @@ } } }, + "com.amazonaws.cloudwatchlogs#SystemField": { + "type": "string" + }, "com.amazonaws.cloudwatchlogs#TagKey": { "type": "string", "traits": { @@ -13110,7 +13138,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

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.

" + "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\n to restrict which tags users can assign.

" } }, "com.amazonaws.cloudwatchlogs#UntagLogGroupRequest": { diff --git a/codegen/sdk/aws-models/cloudwatch.json b/codegen/sdk/aws-models/cloudwatch.json index 785867ed189..c4548edc594 100644 --- a/codegen/sdk/aws-models/cloudwatch.json +++ b/codegen/sdk/aws-models/cloudwatch.json @@ -25,6 +25,10 @@ { "id": "Service", "namespace": "*" + }, + { + "id": "QueryErrorCode", + "namespace": "*" } ] }, @@ -91,6 +95,50 @@ } } }, + "com.amazonaws.cloudwatch#AlarmContributor": { + "type": "structure", + "members": { + "ContributorId": { + "target": "com.amazonaws.cloudwatch#ContributorId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier for this alarm contributor.

", + "smithy.api#required": {} + } + }, + "ContributorAttributes": { + "target": "com.amazonaws.cloudwatch#ContributorAttributes", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A map of attributes that describe the contributor, such as metric dimensions and other identifying characteristics.

", + "smithy.api#required": {} + } + }, + "StateReason": { + "target": "com.amazonaws.cloudwatch#StateReason", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

An explanation for the contributor's current state, providing context about why it is in its current condition.

", + "smithy.api#required": {} + } + }, + "StateTransitionedTimestamp": { + "target": "com.amazonaws.cloudwatch#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the contributor last transitioned to its current state.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an individual contributor to a multi-timeseries alarm, containing information about a specific time series and its contribution to the alarm's state.

" + } + }, + "com.amazonaws.cloudwatch#AlarmContributors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatch#AlarmContributor" + } + }, "com.amazonaws.cloudwatch#AlarmDescription": { "type": "string", "traits": { @@ -109,6 +157,12 @@ "smithy.api#documentation": "

The descriptive name for the alarm.

" } }, + "AlarmContributorId": { + "target": "com.amazonaws.cloudwatch#ContributorId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the alarm contributor associated with this history item, if applicable.

" + } + }, "AlarmType": { "target": "com.amazonaws.cloudwatch#AlarmType", "traits": { @@ -138,6 +192,12 @@ "traits": { "smithy.api#documentation": "

Data about the alarm, in JSON format.

" } + }, + "AlarmContributorAttributes": { + "target": "com.amazonaws.cloudwatch#ContributorAttributes", + "traits": { + "smithy.api#documentation": "

A map of attributes that describe the alarm contributor associated with this history item, providing context about the contributor's characteristics at the time of the event.

" + } } }, "traits": { @@ -399,6 +459,24 @@ "target": "com.amazonaws.cloudwatch#AnomalyDetector" } }, + "com.amazonaws.cloudwatch#AttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.cloudwatch#AttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.cloudwatch#AwsQueryErrorMessage": { "type": "string" }, @@ -613,6 +691,30 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.cloudwatch#ContributorAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatch#AttributeName" + }, + "value": { + "target": "com.amazonaws.cloudwatch#AttributeValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.cloudwatch#ContributorId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.cloudwatch#Counts": { "type": "list", "member": { @@ -1102,6 +1204,70 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudwatch#DescribeAlarmContributors": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatch#DescribeAlarmContributorsInput" + }, + "output": { + "target": "com.amazonaws.cloudwatch#DescribeAlarmContributorsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatch#InvalidNextToken" + }, + { + "target": "com.amazonaws.cloudwatch#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the information of the current alarm contributors that are in ALARM state. This operation returns details about the individual time series that contribute to the alarm's state.

" + } + }, + "com.amazonaws.cloudwatch#DescribeAlarmContributorsInput": { + "type": "structure", + "members": { + "AlarmName": { + "target": "com.amazonaws.cloudwatch#AlarmName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the alarm for which to retrieve contributor information.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudwatch#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to indicate that there is more data available.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatch#DescribeAlarmContributorsOutput": { + "type": "structure", + "members": { + "AlarmContributors": { + "target": "com.amazonaws.cloudwatch#AlarmContributors", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of alarm contributors that provide details about the individual time series contributing to the alarm's state.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudwatch#NextToken", + "traits": { + "smithy.api#documentation": "

The token that marks the start of the next batch of returned results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudwatch#DescribeAlarmHistory": { "type": "operation", "input": { @@ -1134,6 +1300,12 @@ "smithy.api#documentation": "

The name of the alarm.

" } }, + "AlarmContributorId": { + "target": "com.amazonaws.cloudwatch#ContributorId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a specific alarm contributor to filter the alarm history results.

" + } + }, "AlarmTypes": { "target": "com.amazonaws.cloudwatch#AlarmTypes", "traits": { @@ -2617,6 +2789,9 @@ { "target": "com.amazonaws.cloudwatch#DeleteMetricStream" }, + { + "target": "com.amazonaws.cloudwatch#DescribeAlarmContributors" + }, { "target": "com.amazonaws.cloudwatch#DescribeAlarmHistory" }, @@ -2738,12 +2913,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, @@ -2763,6 +2932,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": [ @@ -2794,152 +2969,115 @@ "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": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ { - "ref": "UseDualStack" - }, - true - ] + "ref": "Region" + } + ], + "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] - } + }, + "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } + "ref": "UseFIPS" + }, + true ] - } - ], - "rules": [ + }, { - "conditions": [], - "endpoint": { - "url": "https://monitoring-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] } ], - "type": "tree" + "endpoint": { + "url": "https://monitoring.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "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": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ { "fn": "getAttr", @@ -2947,380 +3085,307 @@ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] }, - true + "aws-us-gov" ] - } - ], - "rules": [ + }, { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "stringEquals", + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://monitoring.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ + true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "name" + "supportsFIPS" ] - }, - "aws-us-gov" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } ] } ], - "endpoint": { - "url": "https://monitoring.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://monitoring-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" }, { "conditions": [], - "endpoint": { - "url": "https://monitoring-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://monitoring-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "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://monitoring.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, { "conditions": [], - "endpoint": { - "url": "https://monitoring.{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://monitoring.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ], "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://monitoring.{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 af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { - "url": "https://monitoring.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.eu-west-3.amazonaws.com" + "url": "https://example.com" } }, "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false + "Endpoint": "https://example.com", + "UseFIPS": false } }, { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with fips enabled", "expect": { - "endpoint": { - "url": "https://monitoring.me-south-1.amazonaws.com" - } + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false + "Endpoint": "https://example.com", + "UseFIPS": true } }, { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { - "endpoint": { - "url": "https://monitoring.sa-east-1.amazonaws.com" - } + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "sa-east-1", + "Endpoint": "https://example.com", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://monitoring.us-east-1.amazonaws.com" + "url": "https://monitoring-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false + "UseFIPS": true, + "UseDualStack": true } }, { @@ -3337,122 +3402,70 @@ } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://monitoring.us-east-2.amazonaws.com" + "url": "https://monitoring.us-east-1.api.aws" } }, "params": { - "Region": "us-east-2", + "Region": "us-east-1", "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://monitoring.us-west-1.amazonaws.com" + "url": "https://monitoring.us-east-1.amazonaws.com" } }, "params": { - "Region": "us-west-1", + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://monitoring-fips.us-west-1.amazonaws.com" + "url": "https://monitoring-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { - "Region": "us-west-1", + "Region": "cn-northwest-1", "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://monitoring-fips.us-west-2.amazonaws.com" + "url": "https://monitoring-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { - "Region": "us-west-2", + "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://monitoring-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://monitoring.us-east-1.api.aws" + "url": "https://monitoring.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { - "Region": "us-east-1", + "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3467,70 +3480,44 @@ } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://monitoring-fips.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://monitoring.us-gov-west-1.api.aws" } }, "params": { - "Region": "cn-north-1", + "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://monitoring-fips.cn-north-1.amazonaws.com.cn" + "url": "https://monitoring.us-gov-west-1.amazonaws.com" } }, "params": { - "Region": "cn-north-1", + "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://monitoring.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://monitoring.us-gov-west-1.api.aws" } }, "params": { - "Region": "cn-north-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://monitoring.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3545,44 +3532,18 @@ } }, { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://monitoring.us-gov-west-1.amazonaws.com" + "url": "https://monitoring-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "Region": "us-gov-west-1", + "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://monitoring-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://monitoring.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3597,53 +3558,18 @@ } }, { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://monitoring.us-iso-west-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://monitoring-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://monitoring-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "Region": "us-iso-east-1", + "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3658,89 +3584,81 @@ } }, { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://monitoring-fips.us-isob-east-1.sc2s.sgov.gov" + "url": "https://monitoring-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { - "Region": "us-isob-east-1", + "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://monitoring.eu-isoe-west-1.cloud.adc-e.uk" + } }, "params": { - "Region": "us-isob-east-1", + "Region": "eu-isoe-west-1", "UseFIPS": false, - "UseDualStack": true + "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 disabled", "expect": { "endpoint": { - "url": "https://example.com" + "url": "https://monitoring-fips.us-isof-south-1.csp.hci.ic.gov" } }, "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" + "Region": "us-isof-south-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://example.com" + "url": "https://monitoring.us-isof-south-1.csp.hci.ic.gov" } }, "params": { + "Region": "us-isof-south-1", "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + "endpoint": { + "url": "https://monitoring-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-east-1", + "Region": "eusc-de-east-1", "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + "endpoint": { + "url": "https://monitoring.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-east-1", + "Region": "eusc-de-east-1", "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" + "UseDualStack": false } }, { @@ -3783,6 +3701,18 @@ "traits": { "smithy.api#enumValue": "Action" } + }, + "AlarmContributorStateUpdate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AlarmContributorStateUpdate" + } + }, + "AlarmContributorAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AlarmContributorAction" + } } } }, @@ -5894,7 +5824,7 @@ "ApplyOnTransformedLogs": { "target": "com.amazonaws.cloudwatch#InsightRuleOnTransformedLogs", "traits": { - "smithy.api#documentation": "

Specify true to have this rule evalute log events after they have been transformed by \n Log transformation. If you specify true, then the log events in log groups that have transformers will \n be evaluated by Contributor Insights after being transformed. Log groups that don't have\n transformers will still have their original log events evaluated by Contributor Insights.

\n

The default is false\n

\n \n

If a log group has a transformer, and transformation fails for some log events, those log events won't be evaluated by\n Contributor Insights. For information about investigating log transformation failures, see\n Transformation metrics and errors.

\n
" + "smithy.api#documentation": "

Specify true to have this rule evaluate log events after they have been transformed by \n Log transformation. If you specify true, then the log events in log groups that have transformers will \n be evaluated by Contributor Insights after being transformed. Log groups that don't have\n transformers will still have their original log events evaluated by Contributor Insights.

\n

The default is false\n

\n \n

If a log group has a transformer, and transformation fails for some log events, those log events won't be evaluated by\n Contributor Insights. For information about investigating log transformation failures, see\n Transformation metrics and errors.

\n
" } } }, diff --git a/codegen/sdk/aws-models/codeartifact.json b/codegen/sdk/aws-models/codeartifact.json index 487ad11dc47..8a3c87f490b 100644 --- a/codegen/sdk/aws-models/codeartifact.json +++ b/codegen/sdk/aws-models/codeartifact.json @@ -1091,17 +1091,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1115,17 +1104,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1139,17 +1117,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1163,17 +1130,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/codebuild.json b/codegen/sdk/aws-models/codebuild.json index 62a1db7dacf..81a9d3227bd 100644 --- a/codegen/sdk/aws-models/codebuild.json +++ b/codegen/sdk/aws-models/codebuild.json @@ -2686,17 +2686,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2710,17 +2699,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2734,17 +2712,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2758,17 +2725,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3632,6 +3588,12 @@ "traits": { "smithy.api#documentation": "

The scope configuration for global or organization webhooks.

\n \n

Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

\n
" } + }, + "pullRequestBuildPolicy": { + "target": "com.amazonaws.codebuild#PullRequestBuildPolicy", + "traits": { + "smithy.api#documentation": "

A PullRequestBuildPolicy object that defines comment-based approval requirements for triggering builds on pull requests. This policy helps control when automated builds are executed based on contributor permissions and approval workflows.

" + } } }, "traits": { @@ -7421,6 +7383,145 @@ "smithy.api#documentation": "

Information about the proxy configurations that apply network access control to your reserved capacity instances.

" } }, + "com.amazonaws.codebuild#PullRequestBuildApproverRole": { + "type": "enum", + "members": { + "GITHUB_READ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITHUB_READ" + } + }, + "GITHUB_TRIAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITHUB_TRIAGE" + } + }, + "GITHUB_WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITHUB_WRITE" + } + }, + "GITHUB_MAINTAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITHUB_MAINTAIN" + } + }, + "GITHUB_ADMIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITHUB_ADMIN" + } + }, + "GITLAB_GUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITLAB_GUEST" + } + }, + "GITLAB_PLANNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITLAB_PLANNER" + } + }, + "GITLAB_REPORTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITLAB_REPORTER" + } + }, + "GITLAB_DEVELOPER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITLAB_DEVELOPER" + } + }, + "GITLAB_MAINTAINER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITLAB_MAINTAINER" + } + }, + "GITLAB_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITLAB_OWNER" + } + }, + "BITBUCKET_READ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BITBUCKET_READ" + } + }, + "BITBUCKET_WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BITBUCKET_WRITE" + } + }, + "BITBUCKET_ADMIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BITBUCKET_ADMIN" + } + } + } + }, + "com.amazonaws.codebuild#PullRequestBuildApproverRoles": { + "type": "list", + "member": { + "target": "com.amazonaws.codebuild#PullRequestBuildApproverRole" + } + }, + "com.amazonaws.codebuild#PullRequestBuildCommentApproval": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ALL_PULL_REQUESTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_PULL_REQUESTS" + } + }, + "FORK_PULL_REQUESTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORK_PULL_REQUESTS" + } + } + } + }, + "com.amazonaws.codebuild#PullRequestBuildPolicy": { + "type": "structure", + "members": { + "requiresCommentApproval": { + "target": "com.amazonaws.codebuild#PullRequestBuildCommentApproval", + "traits": { + "smithy.api#documentation": "

Specifies when comment-based approval is required before triggering a build on pull requests. This setting determines whether builds run automatically or require explicit approval through comments.

\n
    \n
  • \n

    \n DISABLED: Builds trigger automatically without requiring comment approval

    \n
  • \n
  • \n

    \n ALL_PULL_REQUESTS: All pull requests require comment approval before builds execute (unless contributor is one of the approver roles)

    \n
  • \n
  • \n

    \n FORK_PULL_REQUESTS: Only pull requests from forked repositories require comment approval (unless contributor is one of the approver roles)

    \n
  • \n
", + "smithy.api#required": {} + } + }, + "approverRoles": { + "target": "com.amazonaws.codebuild#PullRequestBuildApproverRoles", + "traits": { + "smithy.api#documentation": "

List of repository roles that have approval privileges for pull request builds when comment approval is required. Only users with these roles can provide valid comment approvals. If a pull request contributor is one of these roles, their pull request builds will trigger automatically. This field is only applicable when requiresCommentApproval is not DISABLED.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A PullRequestBuildPolicy object that defines comment-based approval requirements for triggering builds on pull requests. This policy helps control when automated builds are executed based on contributor permissions and approval workflows.

" + } + }, "com.amazonaws.codebuild#PutResourcePolicy": { "type": "operation", "input": { @@ -9161,7 +9262,7 @@ "buildspecOverride": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A buildspec file declaration that overrides the latest one defined \n in the build project, for this build only. The buildspec defined on the project is not changed.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

\n \n

Since this property allows you to change the build commands that will run in the container, \n you should note that an IAM principal with the ability to call this API and set this parameter \n can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location \n like a file in your source repository or a Amazon S3 bucket.

\n
" + "smithy.api#documentation": "

A buildspec file declaration that overrides the latest one defined \n in the build project, for this build only. The buildspec defined on the project is not changed.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

\n \n

Since this property allows you to change the build commands that will run in the container, \n you should note that an IAM principal with the ability to call this API and set this parameter \n can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location \n like a file in your source repository or a Amazon S3 bucket. Alternatively, you can restrict overrides \n to the buildspec by using a condition key: Prevent unauthorized modifications to project buildspec.

\n
" } }, "insecureSslOverride": { @@ -10333,6 +10434,12 @@ "traits": { "smithy.api#documentation": "

Specifies the type of build this webhook will trigger.

\n \n

\n RUNNER_BUILDKITE_BUILD is only available for NO_SOURCE source type projects \n configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see Tutorial: Configure a CodeBuild-hosted Buildkite runner in the CodeBuild\n user guide.

\n
" } + }, + "pullRequestBuildPolicy": { + "target": "com.amazonaws.codebuild#PullRequestBuildPolicy", + "traits": { + "smithy.api#documentation": "

A PullRequestBuildPolicy object that defines comment-based approval requirements for triggering builds on pull requests. This policy helps control when automated builds are executed based on contributor permissions and approval workflows.

" + } } }, "traits": { @@ -10457,6 +10564,9 @@ "traits": { "smithy.api#documentation": "

A message associated with the status of a webhook.

" } + }, + "pullRequestBuildPolicy": { + "target": "com.amazonaws.codebuild#PullRequestBuildPolicy" } }, "traits": { diff --git a/codegen/sdk/aws-models/codecommit.json b/codegen/sdk/aws-models/codecommit.json index 18e1a10841d..b0af9515586 100644 --- a/codegen/sdk/aws-models/codecommit.json +++ b/codegen/sdk/aws-models/codecommit.json @@ -2675,17 +2675,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2699,17 +2688,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2723,17 +2701,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2747,17 +2714,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/codeconnections.json b/codegen/sdk/aws-models/codeconnections.json index 884c37ddfb0..5d99ed62a7c 100644 --- a/codegen/sdk/aws-models/codeconnections.json +++ b/codegen/sdk/aws-models/codeconnections.json @@ -708,17 +708,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -732,17 +721,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -756,17 +734,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -780,17 +747,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/codedeploy.json b/codegen/sdk/aws-models/codedeploy.json index fd15084baf2..ff6c251a58e 100644 --- a/codegen/sdk/aws-models/codedeploy.json +++ b/codegen/sdk/aws-models/codedeploy.json @@ -2120,17 +2120,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2144,17 +2133,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2168,17 +2146,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2192,17 +2159,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/codeguru-reviewer.json b/codegen/sdk/aws-models/codeguru-reviewer.json index 3b721827be2..dd1d203a1b6 100644 --- a/codegen/sdk/aws-models/codeguru-reviewer.json +++ b/codegen/sdk/aws-models/codeguru-reviewer.json @@ -81,7 +81,7 @@ "sdkId": "CodeGuru Reviewer", "arnNamespace": "codeguru-reviewer", "cloudFormationName": "CodeGuruReviewer", - "cloudTrailEventSource": "codegurureviewer.amazonaws.com", + "cloudTrailEventSource": "codeguru-reviewer.amazonaws.com", "endpointPrefix": "codeguru-reviewer" }, "aws.auth#sigv4": { @@ -679,17 +679,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -703,17 +692,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -727,17 +705,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -751,17 +718,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/codeguru-security.json b/codegen/sdk/aws-models/codeguru-security.json index e9ed31793ce..a633ba105fc 100644 --- a/codegen/sdk/aws-models/codeguru-security.json +++ b/codegen/sdk/aws-models/codeguru-security.json @@ -67,7 +67,7 @@ "meanTimeToClose": { "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", "traits": { - "smithy.api#documentation": "

The average time in days it takes to close findings of each severity as of a specified\n date.

" + "smithy.api#documentation": "

The average time in days it takes to close findings of each severity as of a specified date.

" } } }, @@ -167,7 +167,7 @@ ], "origin": "*" }, - "smithy.api#documentation": "\n

Amazon CodeGuru Security is in preview release and is subject to change.

\n
\n

This section provides documentation for the Amazon CodeGuru Security API operations.\n CodeGuru Security is a service that uses program analysis and machine learning to detect\n security policy violations and vulnerabilities, and recommends ways to address these security\n risks.

\n

By proactively detecting and providing recommendations for addressing security risks,\n CodeGuru Security improves the overall security of your application code. For more information\n about CodeGuru Security, see the \n Amazon CodeGuru Security User Guide.

", + "smithy.api#documentation": "

On November 20, 2025, AWS will discontinue support for Amazon CodeGuru Security. After November 20, 2025, you will no longer be able to access the /codeguru/security console, service resources, or documentation. For more information, see https://docs.aws.amazon.com/codeguru/latest/security-ug/end-of-support.html.

This section provides documentation for the Amazon CodeGuru Security API operations. CodeGuru Security is a service that uses program analysis and machine learning to detect security policy violations and vulnerabilities, and recommends ways to address these security risks.

By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the Amazon CodeGuru Security User Guide.

", "smithy.api#title": "Amazon CodeGuru Security", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -677,17 +677,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -701,17 +690,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -725,17 +703,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -749,17 +716,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -915,7 +871,7 @@ "findingIdentifiers": { "target": "com.amazonaws.codegurusecurity#FindingIdentifiers", "traits": { - "smithy.api#documentation": "

A list of finding identifiers. Each identifier consists of a scanName and a\n findingId. You retrieve the findingId when you call\n GetFindings.

", + "smithy.api#documentation": "

A list of finding identifiers. Each identifier consists of a scanName and a findingId. You retrieve the findingId when you call GetFindings.

", "smithy.api#required": {} } } @@ -937,7 +893,7 @@ "failedFindings": { "target": "com.amazonaws.codegurusecurity#BatchGetFindingsErrors", "traits": { - "smithy.api#documentation": "

A list of errors for individual findings which were not fetched. Each\n BatchGetFindingsError contains the scanName, findingId,\n errorCode and error message.

", + "smithy.api#documentation": "

A list of errors for individual findings which were not fetched. Each BatchGetFindingsError contains the scanName, findingId, errorCode and error message.

", "smithy.api#required": {} } } @@ -963,7 +919,7 @@ "categoryName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the finding category. A finding category is determined by the detector that\n detected the finding.

" + "smithy.api#documentation": "

The name of the finding category. A finding category is determined by the detector that detected the finding.

" } }, "findingNumber": { @@ -1046,7 +1002,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation would cause a conflict with the current state of a service\n resource associated with the request. Resolve the conflict before retrying this\n request.

", + "smithy.api#documentation": "

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1094,7 +1050,7 @@ "clientToken": { "target": "com.amazonaws.codegurusecurity#ClientToken", "traits": { - "smithy.api#documentation": "

The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent\n the accidental creation of duplicate scans if there are failures and retries.

", + "smithy.api#documentation": "

The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.

", "smithy.api#idempotencyToken": {} } }, @@ -1108,26 +1064,26 @@ "scanName": { "target": "com.amazonaws.codegurusecurity#ScanName", "traits": { - "smithy.api#documentation": "

The unique name that CodeGuru Security uses to track revisions across multiple scans of\n the same resource. Only allowed for a STANDARD scan type.

", + "smithy.api#documentation": "

The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD scan type.

", "smithy.api#required": {} } }, "scanType": { "target": "com.amazonaws.codegurusecurity#ScanType", "traits": { - "smithy.api#documentation": "

The type of scan, either Standard or Express. Defaults to\n Standard type if missing.

\n

\n Express scans run on limited resources and use a limited set of detectors to\n analyze your code in near-real time. Standard scans have standard resource limits\n and use the full set of detectors to analyze your code.

" + "smithy.api#documentation": "

The type of scan, either Standard or Express. Defaults to Standard type if missing.

Express scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard scans have standard resource limits and use the full set of detectors to analyze your code.

" } }, "analysisType": { "target": "com.amazonaws.codegurusecurity#AnalysisType", "traits": { - "smithy.api#documentation": "

The type of analysis you want CodeGuru Security to perform in the scan, either\n Security or All. The Security type only generates\n findings related to security. The All type generates both security findings and\n quality findings. Defaults to Security type if missing.

" + "smithy.api#documentation": "

The type of analysis you want CodeGuru Security to perform in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings. Defaults to Security type if missing.

" } }, "tags": { "target": "com.amazonaws.codegurusecurity#TagMap", "traits": { - "smithy.api#documentation": "

An array of key-value pairs used to tag a scan. A tag is a custom attribute\n label with two parts:

\n
    \n
  • \n

    A tag key. For example, CostCenter, Environment, or\n Secret. Tag keys are case sensitive.

    \n
  • \n
  • \n

    An optional tag value field. For example, 111122223333,\n Production, or a team name. Omitting the tag value is the same as using an\n empty string. Tag values are case sensitive.

    \n
  • \n
" + "smithy.api#documentation": "

An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:

  • A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.

  • An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.

" } } }, @@ -1162,7 +1118,7 @@ "scanState": { "target": "com.amazonaws.codegurusecurity#ScanState", "traits": { - "smithy.api#documentation": "

The current state of the scan. Returns either InProgress,\n Successful, or Failed.

", + "smithy.api#documentation": "

The current state of the scan. Returns either InProgress, Successful, or Failed.

", "smithy.api#required": {} } }, @@ -1200,7 +1156,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a pre-signed URL, request headers used to upload a code resource, and code\n artifact identifier for the uploaded resource.

\n

You can upload your code resource to the URL with the request headers using any HTTP\n client.

", + "smithy.api#documentation": "

Generates a pre-signed URL, request headers used to upload a code resource, and code artifact identifier for the uploaded resource.

You can upload your code resource to the URL with the request headers using any HTTP client.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1214,7 +1170,7 @@ "scanName": { "target": "com.amazonaws.codegurusecurity#ScanName", "traits": { - "smithy.api#documentation": "

The name of the scan that will use the uploaded resource. CodeGuru Security uses the\n unique scan name to track revisions across multiple scans of the same resource. Use this \n scanName when you call CreateScan on the code resource you upload to this URL.

", + "smithy.api#documentation": "

The name of the scan that will use the uploaded resource. CodeGuru Security uses the unique scan name to track revisions across multiple scans of the same resource. Use this scanName when you call CreateScan on the code resource you upload to this URL.

", "smithy.api#required": {} } } @@ -1229,21 +1185,21 @@ "s3Url": { "target": "com.amazonaws.codegurusecurity#S3Url", "traits": { - "smithy.api#documentation": "

A pre-signed S3 URL. You can upload the code file you want to scan with the required\n requestHeaders using any HTTP client.

", + "smithy.api#documentation": "

A pre-signed S3 URL. You can upload the code file you want to scan with the required requestHeaders using any HTTP client.

", "smithy.api#required": {} } }, "requestHeaders": { "target": "com.amazonaws.codegurusecurity#RequestHeaderMap", "traits": { - "smithy.api#documentation": "

A set of key-value pairs that contain the required headers when uploading your\n resource.

", + "smithy.api#documentation": "

A set of key-value pairs that contain the required headers when uploading your resource.

", "smithy.api#required": {} } }, "codeArtifactId": { "target": "com.amazonaws.codegurusecurity#Uuid", "traits": { - "smithy.api#documentation": "

The identifier for the uploaded code resource. Pass this to CreateScan to use\n the uploaded resources.

", + "smithy.api#documentation": "

The identifier for the uploaded code resource. Pass this to CreateScan to use the uploaded resources.

", "smithy.api#required": {} } } @@ -1264,12 +1220,12 @@ "kmsKeyArn": { "target": "com.amazonaws.codegurusecurity#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption,\n returns empty.

" + "smithy.api#documentation": "

The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption, returns empty.

" } } }, "traits": { - "smithy.api#documentation": "

Information about the encryption configuration for an account. Required to call\n UpdateAccountConfiguration.

" + "smithy.api#documentation": "

Information about the encryption configuration for an account. Required to call UpdateAccountConfiguration.

" } }, "com.amazonaws.codegurusecurity#ErrorCode": { @@ -1339,18 +1295,18 @@ "endLine": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The last line number of the code snippet where the security vulnerability appears in your\n code.

" + "smithy.api#documentation": "

The last line number of the code snippet where the security vulnerability appears in your code.

" } }, "codeSnippet": { "target": "com.amazonaws.codegurusecurity#CodeSnippet", "traits": { - "smithy.api#documentation": "

A list of CodeLine objects that describe where the security vulnerability\n appears in your code.

" + "smithy.api#documentation": "

A list of CodeLine objects that describe where the security vulnerability appears in your code.

" } } }, "traits": { - "smithy.api#documentation": "

Information about the location of security vulnerabilities that Amazon CodeGuru Security\n detected in your code.

" + "smithy.api#documentation": "

Information about the location of security vulnerabilities that Amazon CodeGuru Security detected in your code.

" } }, "com.amazonaws.codegurusecurity#Finding": { @@ -1383,7 +1339,7 @@ "updatedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time when the finding was last updated. Findings are updated when you remediate them\n or when the finding code location changes.

" + "smithy.api#documentation": "

The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes.

" } }, "type": { @@ -1413,7 +1369,7 @@ "severity": { "target": "com.amazonaws.codegurusecurity#Severity", "traits": { - "smithy.api#documentation": "

The severity of the finding. Severity can be critical, high, medium, low, or\n informational. For information on severity levels, see \n Finding severity in the \n Amazon CodeGuru Security User Guide.

" + "smithy.api#documentation": "

The severity of the finding. Severity can be critical, high, medium, low, or informational. For information on severity levels, see Finding severity in the Amazon CodeGuru Security User Guide.

" } }, "remediation": { @@ -1431,13 +1387,13 @@ "detectorTags": { "target": "com.amazonaws.codegurusecurity#DetectorTags", "traits": { - "smithy.api#documentation": "

One or more tags or categorizations that are associated with a detector. These tags are\n defined by type, programming language, or other classification such as maintainability or\n consistency.

" + "smithy.api#documentation": "

One or more tags or categorizations that are associated with a detector. These tags are defined by type, programming language, or other classification such as maintainability or consistency.

" } }, "detectorId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The identifier for the detector that detected the finding in your code. A detector is a\n defined rule based on industry standards and AWS best practices.

" + "smithy.api#documentation": "

The identifier for the detector that detected the finding in your code. A detector is a defined rule based on industry standards and AWS best practices.

" } }, "detectorName": { @@ -1526,7 +1482,7 @@ } }, "traits": { - "smithy.api#documentation": "

A numeric value corresponding to the severity of a finding, such as the number of open\n findings or the average time it takes to close findings of a given severity.

" + "smithy.api#documentation": "

A numeric value corresponding to the severity of a finding, such as the number of open findings or the average time it takes to close findings of a given severity.

" } }, "com.amazonaws.codegurusecurity#Findings": { @@ -1586,7 +1542,7 @@ "encryptionConfig": { "target": "com.amazonaws.codegurusecurity#EncryptionConfig", "traits": { - "smithy.api#documentation": "

An EncryptionConfig object that contains the KMS key ARN that is used for\n encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify\n your own key, call UpdateAccountConfiguration. If you do not specify a\n customer-managed key, returns empty.

", + "smithy.api#documentation": "

An EncryptionConfig object that contains the KMS key ARN that is used for encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify your own key, call UpdateAccountConfiguration. If you do not specify a customer-managed key, returns empty.

", "smithy.api#required": {} } } @@ -1653,14 +1609,14 @@ "nextToken": { "target": "com.amazonaws.codegurusecurity#NextToken", "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request. For subsequent calls, use the nextToken value\n returned from the previous request to continue listing results after the first page.

", + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results. If not specified, returns 1000 results.

", + "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -1671,7 +1627,7 @@ "status": { "target": "com.amazonaws.codegurusecurity#Status", "traits": { - "smithy.api#documentation": "

The status of the findings you want to get. Pass either Open,\n Closed, or All.

", + "smithy.api#documentation": "

The status of the findings you want to get. Pass either Open, Closed, or All.

", "smithy.api#httpQuery": "status" } } @@ -1692,7 +1648,7 @@ "nextToken": { "target": "com.amazonaws.codegurusecurity#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. You can use this in future calls to GetFindings to continue listing\n results after the current page.

" + "smithy.api#documentation": "

A pagination token. You can use this in future calls to GetFindings to continue listing results after the current page.

" } } }, @@ -1723,7 +1679,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a summary of metrics for an account from a specified date, including number of open\n findings, the categories with most findings, the scans with most open findings, and scans with\n most open critical findings.

", + "smithy.api#documentation": "

Returns a summary of metrics for an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -1738,7 +1694,7 @@ "date": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date you want to retrieve summary metrics from, rounded to the nearest day. The date\n must be within the past two years.

", + "smithy.api#documentation": "

The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years.

", "smithy.api#httpQuery": "date", "smithy.api#required": {} } @@ -1811,7 +1767,7 @@ "runId": { "target": "com.amazonaws.codegurusecurity#Uuid", "traits": { - "smithy.api#documentation": "

UUID that identifies the individual scan run you want to view details about. You retrieve\n this when you call the CreateScan operation. Defaults to the latest scan run if missing.

", + "smithy.api#documentation": "

UUID that identifies the individual scan run you want to view details about. You retrieve this when you call the CreateScan operation. Defaults to the latest scan run if missing.

", "smithy.api#httpQuery": "runId" } } @@ -1840,7 +1796,7 @@ "scanState": { "target": "com.amazonaws.codegurusecurity#ScanState", "traits": { - "smithy.api#documentation": "

The current state of the scan. Returns either InProgress,\n Successful, or Failed.

", + "smithy.api#documentation": "

The current state of the scan. Returns either InProgress, Successful, or Failed.

", "smithy.api#required": {} } }, @@ -1854,7 +1810,7 @@ "analysisType": { "target": "com.amazonaws.codegurusecurity#AnalysisType", "traits": { - "smithy.api#documentation": "

The type of analysis CodeGuru Security performed in the scan, either\n Security or All. The Security type only generates\n findings related to security. The All type generates both security findings and\n quality findings.

", + "smithy.api#documentation": "

The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.

", "smithy.api#required": {} } }, @@ -1980,14 +1936,14 @@ "nextToken": { "target": "com.amazonaws.codegurusecurity#NextToken", "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the\n value of this parameter to null for the first request. For subsequent calls, use the nextToken\n value returned from the previous request to continue listing results after the first\n page.

", + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results. If not specified, returns 1000 results.

", + "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -1998,7 +1954,7 @@ "startDate": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The start date of the interval which you want to retrieve metrics from. Rounds to the\n nearest day.

", + "smithy.api#documentation": "

The start date of the interval which you want to retrieve metrics from. Rounds to the nearest day.

", "smithy.api#httpQuery": "startDate", "smithy.api#required": {} } @@ -2006,7 +1962,7 @@ "endDate": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The end date of the interval which you want to retrieve metrics from. Round to the nearest\n day.

", + "smithy.api#documentation": "

The end date of the interval which you want to retrieve metrics from. Round to the nearest day.

", "smithy.api#httpQuery": "endDate", "smithy.api#required": {} } @@ -2028,7 +1984,7 @@ "nextToken": { "target": "com.amazonaws.codegurusecurity#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. You can use this in future calls to ListFindingMetrics to continue\n listing results after the current page.

" + "smithy.api#documentation": "

A pagination token. You can use this in future calls to ListFindingMetrics to continue listing results after the current page.

" } } }, @@ -2059,7 +2015,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all scans in an account. Does not return EXPRESS\n scans.

", + "smithy.api#documentation": "

Returns a list of all scans in an account. Does not return EXPRESS scans.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2080,14 +2036,14 @@ "nextToken": { "target": "com.amazonaws.codegurusecurity#NextToken", "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request. For subsequent calls, use the nextToken value\n returned from the previous request to continue listing results after the first page.

", + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results. If not specified, returns 100 results.

", + "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 100 results.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -2112,7 +2068,7 @@ "nextToken": { "target": "com.amazonaws.codegurusecurity#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. You can use this in future calls to ListScans to continue listing\n results after the current page.

" + "smithy.api#documentation": "

A pagination token. You can use this in future calls to ListScans to continue listing results after the current page.

" } } }, @@ -2164,7 +2120,7 @@ "resourceArn": { "target": "com.amazonaws.codegurusecurity#ScanNameArn", "traits": { - "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n CreateScan, ListScans, or GetScan.

", + "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2180,7 +2136,7 @@ "tags": { "target": "com.amazonaws.codegurusecurity#TagMap", "traits": { - "smithy.api#documentation": "

An array of key-value pairs used to tag an existing scan. A tag is a custom attribute\n label with two parts:

\n
    \n
  • \n

    A tag key. For example, CostCenter, Environment, or\n Secret. Tag keys are case sensitive.

    \n
  • \n
  • \n

    An optional tag value field. For example, 111122223333,\n Production, or a team name. Omitting the tag value is the same as using an\n empty string. Tag values are case sensitive.

    \n
  • \n
" + "smithy.api#documentation": "

An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:

  • A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.

  • An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.

" } } }, @@ -2206,19 +2162,19 @@ "categoriesWithMostFindings": { "target": "com.amazonaws.codegurusecurity#CategoriesWithMostFindings", "traits": { - "smithy.api#documentation": "

A list of CategoryWithFindingNum objects for the top 5 finding categories\n with the most findings.

" + "smithy.api#documentation": "

A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings.

" } }, "scansWithMostOpenFindings": { "target": "com.amazonaws.codegurusecurity#ScansWithMostOpenFindings", "traits": { - "smithy.api#documentation": "

A list of ScanNameWithFindingNum objects for the top 3 scans with the most\n number of open findings.

" + "smithy.api#documentation": "

A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings.

" } }, "scansWithMostOpenCriticalFindings": { "target": "com.amazonaws.codegurusecurity#ScansWithMostOpenCriticalFindings", "traits": { - "smithy.api#documentation": "

A list of ScanNameWithFindingNum objects for the top 3 scans with the most\n number of open critical findings.

" + "smithy.api#documentation": "

A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings.

" } } }, @@ -2280,7 +2236,7 @@ "suggestedFixes": { "target": "com.amazonaws.codegurusecurity#SuggestedFixes", "traits": { - "smithy.api#documentation": "

A list of SuggestedFix objects. Each object contains information about a suggested code\n fix to remediate the finding.

" + "smithy.api#documentation": "

A list of SuggestedFix objects. Each object contains information about a suggested code fix to remediate the finding.

" } } }, @@ -2326,12 +2282,12 @@ "codeArtifactId": { "target": "com.amazonaws.codegurusecurity#Uuid", "traits": { - "smithy.api#documentation": "

The identifier for the code file uploaded to the resource object. Returned by\n CreateUploadUrl when you upload resources to be scanned.

" + "smithy.api#documentation": "

The identifier for the code file uploaded to the resource object. Returned by CreateUploadUrl when you upload resources to be scanned.

" } } }, "traits": { - "smithy.api#documentation": "

The identifier for a resource object that contains resources to scan. Specifying a\n codeArtifactId is required to create a scan.

" + "smithy.api#documentation": "

The identifier for a resource object that contains resources to scan. Specifying a codeArtifactId is required to create a scan.

" } }, "com.amazonaws.codegurusecurity#ResourceNotFoundException": { @@ -2456,7 +2412,7 @@ "scanState": { "target": "com.amazonaws.codegurusecurity#ScanState", "traits": { - "smithy.api#documentation": "

The state of the scan. A scan can be In Progress, \n Complete, or Failed.

", + "smithy.api#documentation": "

The state of the scan. A scan can be In Progress, Complete, or Failed.

", "smithy.api#required": {} } }, @@ -2700,7 +2656,7 @@ "resourceArn": { "target": "com.amazonaws.codegurusecurity#ScanNameArn", "traits": { - "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n CreateScan, ListScans, or GetScan.

", + "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2708,7 +2664,7 @@ "tags": { "target": "com.amazonaws.codegurusecurity#TagMap", "traits": { - "smithy.api#documentation": "

An array of key-value pairs used to tag an existing scan. A tag is a custom attribute\n label with two parts:

\n
    \n
  • \n

    A tag key. For example, CostCenter, Environment, or\n Secret. Tag keys are case sensitive.

    \n
  • \n
  • \n

    An optional tag value field. For example, 111122223333,\n Production, or a team name. Omitting the tag value is the same as using an\n empty string. Tag values are case sensitive.

    \n
  • \n
", + "smithy.api#documentation": "

An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:

  • A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.

  • An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.

", "smithy.api#required": {} } } @@ -2816,7 +2772,7 @@ "resourceArn": { "target": "com.amazonaws.codegurusecurity#ScanNameArn", "traits": { - "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n CreateScan, ListScans, or GetScan.

", + "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2881,7 +2837,7 @@ "encryptionConfig": { "target": "com.amazonaws.codegurusecurity#EncryptionConfig", "traits": { - "smithy.api#documentation": "

The customer-managed KMS key ARN you want to use for encryption. If not specified,\n CodeGuru Security will use an AWS-managed key for encryption. If you previously specified a\n customer-managed KMS key and want CodeGuru Security to use an AWS-managed key for encryption\n instead, pass nothing.

", + "smithy.api#documentation": "

The customer-managed KMS key ARN you want to use for encryption. If not specified, CodeGuru Security will use an AWS-managed key for encryption. If you previously specified a customer-managed KMS key and want CodeGuru Security to use an AWS-managed key for encryption instead, pass nothing.

", "smithy.api#required": {} } } @@ -2896,7 +2852,7 @@ "encryptionConfig": { "target": "com.amazonaws.codegurusecurity#EncryptionConfig", "traits": { - "smithy.api#documentation": "

An EncryptionConfig object that contains the KMS key ARN that is used for\n encryption. If you did not specify a customer-managed KMS key in the request, returns empty.\n

", + "smithy.api#documentation": "

An EncryptionConfig object that contains the KMS key ARN that is used for encryption. If you did not specify a customer-managed KMS key in the request, returns empty.

", "smithy.api#required": {} } } @@ -3035,7 +2991,7 @@ "filePath": { "target": "com.amazonaws.codegurusecurity#FilePath", "traits": { - "smithy.api#documentation": "

An object that describes the location of the detected security vulnerability in your\n code.

" + "smithy.api#documentation": "

An object that describes the location of the detected security vulnerability in your code.

" } }, "itemCount": { diff --git a/codegen/sdk/aws-models/codeguruprofiler.json b/codegen/sdk/aws-models/codeguruprofiler.json index 0f79d331135..ee0d80e1cb1 100644 --- a/codegen/sdk/aws-models/codeguruprofiler.json +++ b/codegen/sdk/aws-models/codeguruprofiler.json @@ -1011,17 +1011,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1035,17 +1024,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1059,17 +1037,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1083,17 +1050,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/codepipeline.json b/codegen/sdk/aws-models/codepipeline.json index 8fe7e9bc8ec..3d25f09b211 100644 --- a/codegen/sdk/aws-models/codepipeline.json +++ b/codegen/sdk/aws-models/codepipeline.json @@ -2756,17 +2756,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2780,17 +2769,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2804,17 +2782,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2828,17 +2795,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/codestar-connections.json b/codegen/sdk/aws-models/codestar-connections.json index b7c573a9672..ef11686e136 100644 --- a/codegen/sdk/aws-models/codestar-connections.json +++ b/codegen/sdk/aws-models/codestar-connections.json @@ -867,17 +867,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -891,17 +880,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -915,17 +893,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -939,17 +906,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1076,7 +1032,7 @@ "ConnectionArn": { "target": "com.amazonaws.codestarconnections#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 Services.

\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": { diff --git a/codegen/sdk/aws-models/codestar-notifications.json b/codegen/sdk/aws-models/codestar-notifications.json index 60f3ce1a2d5..a1975a995f4 100644 --- a/codegen/sdk/aws-models/codestar-notifications.json +++ b/codegen/sdk/aws-models/codestar-notifications.json @@ -582,17 +582,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -606,17 +595,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -630,17 +608,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -654,17 +621,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -795,7 +751,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a notification rule for a resource. The rule specifies the events you want\n notifications about and the targets (such as Chatbot topics or Chatbot clients configured for Slack) where you want to receive\n them.

", + "smithy.api#documentation": "

Creates a notification rule for a resource. The rule specifies the events you want\n notifications about and the targets (such as Amazon Q Developer in chat applications topics or Amazon Q Developer in chat applications clients configured for Slack) where you want to receive\n them.

", "smithy.api#http": { "method": "POST", "uri": "/createNotificationRule", @@ -830,7 +786,7 @@ "Targets": { "target": "com.amazonaws.codestarnotifications#Targets", "traits": { - "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the\n notification rule.

", + "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Amazon Q Developer in chat applications clients to associate with the\n notification rule.

", "smithy.api#required": {} } }, @@ -967,7 +923,7 @@ "TargetAddress": { "target": "com.amazonaws.codestarnotifications#TargetAddress", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client to delete.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client to delete.

", "smithy.api#required": {} } }, @@ -975,7 +931,7 @@ "target": "com.amazonaws.codestarnotifications#ForceUnsubscribeAll", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that can be used to delete all associations with this Chatbot topic. The\n default value is FALSE. If set to TRUE, all associations between that target and every\n notification rule in your Amazon Web Services account are deleted.

" + "smithy.api#documentation": "

A Boolean value that can be used to delete all associations with this Amazon Q Developer in chat applications topic. The\n default value is FALSE. If set to TRUE, all associations between that target and every\n notification rule in your Amazon Web Services account are deleted.

" } } }, @@ -1061,7 +1017,7 @@ "Targets": { "target": "com.amazonaws.codestarnotifications#TargetsBatch", "traits": { - "smithy.api#documentation": "

A list of the Chatbot topics and Chatbot clients associated with the notification rule.

" + "smithy.api#documentation": "

A list of the Amazon Q Developer in chat applications topics and Amazon Q Developer in chat applications clients associated with the notification rule.

" } }, "DetailType": { @@ -1585,7 +1541,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about a filter to apply to the list of returned targets. You can filter by\n target type, address, or status. For example, to filter results to notification rules\n that have active Chatbot topics as targets, you could specify a ListTargetsFilter\n Name as TargetType and a Value of SNS, and a Name of TARGET_STATUS and a Value of\n ACTIVE.

" + "smithy.api#documentation": "

Information about a filter to apply to the list of returned targets. You can filter by\n target type, address, or status. For example, to filter results to notification rules\n that have active Amazon Q Developer in chat applications topics as targets, you could specify a ListTargetsFilter\n Name as TargetType and a Value of SNS, and a Name of TARGET_STATUS and a Value of\n ACTIVE.

" } }, "com.amazonaws.codestarnotifications#ListTargetsFilterName": { @@ -1836,7 +1792,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the\n associated target can receive notifications when the events described in the rule are\n triggered.

", + "smithy.api#documentation": "

Creates an association between a notification rule and an Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client so that the\n associated target can receive notifications when the events described in the rule are\n triggered.

", "smithy.api#http": { "method": "POST", "uri": "/subscribe", @@ -1993,18 +1949,18 @@ "TargetType": { "target": "com.amazonaws.codestarnotifications#TargetType", "traits": { - "smithy.api#documentation": "

The target type. Can be an Chatbot topic or Chatbot client.

\n
    \n
  • \n

    Chatbot topics are specified as SNS.

    \n
  • \n
  • \n

    Chatbot clients are specified as AWSChatbotSlack.

    \n
  • \n
" + "smithy.api#documentation": "

The target type. Can be an Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client.

\n
    \n
  • \n

    Amazon Q Developer in chat applications topics are specified as SNS.

    \n
  • \n
  • \n

    Amazon Q Developer in chat applications clients are specified as AWSChatbotSlack.

    \n
  • \n
" } }, "TargetAddress": { "target": "com.amazonaws.codestarnotifications#TargetAddress", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client.

" } } }, "traits": { - "smithy.api#documentation": "

Information about the Chatbot topics or Chatbot clients associated with a notification rule.

" + "smithy.api#documentation": "

Information about the Amazon Q Developer in chat applications topics or Amazon Q Developer in chat applications clients associated with a notification rule.

" } }, "com.amazonaws.codestarnotifications#TargetAddress": { @@ -2058,13 +2014,13 @@ "TargetAddress": { "target": "com.amazonaws.codestarnotifications#TargetAddress", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client.

" } }, "TargetType": { "target": "com.amazonaws.codestarnotifications#TargetType", "traits": { - "smithy.api#documentation": "

The type of the target (for example, SNS).

\n
    \n
  • \n

    Chatbot topics are specified as SNS.

    \n
  • \n
  • \n

    Chatbot clients are specified as AWSChatbotSlack.

    \n
  • \n
" + "smithy.api#documentation": "

The type of the target (for example, SNS).

\n
    \n
  • \n

    Amazon Q Developer in chat applications topics are specified as SNS.

    \n
  • \n
  • \n

    Amazon Q Developer in chat applications clients are specified as AWSChatbotSlack.

    \n
  • \n
" } }, "TargetStatus": { @@ -2116,7 +2072,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes an association between a notification rule and an Chatbot topic so that\n subscribers to that topic stop receiving notifications when the events described in the\n rule are triggered.

", + "smithy.api#documentation": "

Removes an association between a notification rule and an Amazon Q Developer in chat applications topic so that\n subscribers to that topic stop receiving notifications when the events described in the\n rule are triggered.

", "smithy.api#http": { "method": "POST", "uri": "/unsubscribe", @@ -2137,7 +2093,7 @@ "TargetAddress": { "target": "com.amazonaws.codestarnotifications#TargetAddress", "traits": { - "smithy.api#documentation": "

The ARN of the Chatbot topic to unsubscribe from the notification rule.

", + "smithy.api#documentation": "

The ARN of the Amazon Q Developer in chat applications topic to unsubscribe from the notification rule.

", "smithy.api#required": {} } } diff --git a/codegen/sdk/aws-models/cognito-identity-provider.json b/codegen/sdk/aws-models/cognito-identity-provider.json index d5952111c03..d05ece5c2ca 100644 --- a/codegen/sdk/aws-models/cognito-identity-provider.json +++ b/codegen/sdk/aws-models/cognito-identity-provider.json @@ -154,6 +154,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#CreateResourceServer" }, + { + "target": "com.amazonaws.cognitoidentityprovider#CreateTerms" + }, { "target": "com.amazonaws.cognitoidentityprovider#CreateUserImportJob" }, @@ -178,6 +181,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#DeleteResourceServer" }, + { + "target": "com.amazonaws.cognitoidentityprovider#DeleteTerms" + }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteUser" }, @@ -211,6 +217,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#DescribeRiskConfiguration" }, + { + "target": "com.amazonaws.cognitoidentityprovider#DescribeTerms" + }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeUserImportJob" }, @@ -286,6 +295,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#ListTagsForResource" }, + { + "target": "com.amazonaws.cognitoidentityprovider#ListTerms" + }, { "target": "com.amazonaws.cognitoidentityprovider#ListUserImportJobs" }, @@ -367,6 +379,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#UpdateResourceServer" }, + { + "target": "com.amazonaws.cognitoidentityprovider#UpdateTerms" + }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateUserAttributes" }, @@ -1445,17 +1460,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1469,17 +1473,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1493,17 +1486,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1517,17 +1499,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2846,7 +2817,7 @@ "AuthParameters": { "target": "com.amazonaws.cognitoidentityprovider#AuthParametersType", "traits": { - "smithy.api#documentation": "

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you're invoking. The required values depend on the value\n of AuthFlow for example:

\n
    \n
  • \n

    For USER_AUTH: USERNAME (required),\n PREFERRED_CHALLENGE. If you don't provide a value for\n PREFERRED_CHALLENGE, Amazon Cognito responds with the\n AvailableChallenges parameter that specifies the available\n sign-in methods.

    \n
  • \n
  • \n

    For USER_SRP_AUTH: USERNAME (required),\n SRP_A (required), SECRET_HASH (required if the app\n client is configured with a client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    For ADMIN_USER_PASSWORD_AUTH: USERNAME (required),\n PASSWORD (required), SECRET_HASH (required if the\n app client is configured with a client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN\n (required), SECRET_HASH (required if the app client is configured\n with a client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    For CUSTOM_AUTH: USERNAME (required),\n SECRET_HASH (if app client is configured with client secret),\n DEVICE_KEY. To start the authentication flow with password\n verification, include ChallengeName: SRP_A and SRP_A: (The\n SRP_A Value).

    \n
  • \n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" + "smithy.api#documentation": "

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you're invoking.

\n

The following are some authentication flows and their parameters. Add a\n SECRET_HASH parameter if your app client has a client secret. Add\n DEVICE_KEY if you want to bypass multi-factor authentication with a\n remembered device.

\n
\n
USER_AUTH
\n
\n
    \n
  • \n

    \n USERNAME (required)

    \n
  • \n
  • \n

    \n PREFERRED_CHALLENGE. If you don't provide a\n value for PREFERRED_CHALLENGE, Amazon Cognito responds with the\n AvailableChallenges parameter that specifies the\n available sign-in methods.

    \n
  • \n
\n
\n
USER_SRP_AUTH
\n
\n
    \n
  • \n

    \n USERNAME (required)

    \n
  • \n
  • \n

    \n SRP_A (required)

    \n
  • \n
\n
\n
ADMIN_USER_PASSWORD_AUTH
\n
\n
    \n
  • \n

    \n USERNAME (required)

    \n
  • \n
  • \n

    \n PASSWORD (required)

    \n
  • \n
\n
\n
REFRESH_TOKEN_AUTH/REFRESH_TOKEN
\n
\n
    \n
  • \n

    \n REFRESH_TOKEN(required)

    \n
  • \n
\n
\n
CUSTOM_AUTH
\n
\n
    \n
  • \n

    \n USERNAME (required)

    \n
  • \n
  • \n

    \n ChallengeName: SRP_A (when preceding custom\n authentication with SRP authentication)

    \n
  • \n
  • \n

    \n SRP_A: (An SRP_A value) (when preceding custom\n authentication with SRP authentication)

    \n
  • \n
\n
\n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" } }, "ClientMetadata": { @@ -2885,7 +2856,7 @@ "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "

The name of the challenge that you're responding to with this call. This is returned\n in the AdminInitiateAuth response if you must pass another\n challenge.

\n

Possible challenges include the following:

\n \n

All of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters.

\n
\n
    \n
  • \n

    \n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey. Examples \n of WebAuthn authenticators include biometric devices and security keys.

    \n
  • \n
  • \n

    \n PASSWORD: Respond with USER_PASSWORD_AUTH\n parameters: USERNAME (required), PASSWORD (required),\n SECRET_HASH (required if the app client is configured with a\n client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    \n PASSWORD_SRP: Respond with USER_SRP_AUTH parameters:\n USERNAME (required), SRP_A (required),\n SECRET_HASH (required if the app client is configured with a\n client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    \n SELECT_CHALLENGE: Respond to the challenge with\n USERNAME and an ANSWER that matches one of the\n challenge types in the AvailableChallenges response\n parameter.

    \n
  • \n
  • \n

    \n SMS_MFA: Respond with an\n SMS_MFA_CODE that your user pool delivered in an SMS message.

    \n
  • \n
  • \n

    \n EMAIL_OTP: Respond with an\n EMAIL_OTP_CODE that your user pool delivered in an email\n message.

    \n
  • \n
  • \n

    \n PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations.

    \n
  • \n
  • \n

    \n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function.

    \n
  • \n
  • \n

    \n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.

    \n

    Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.

    \n \n

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

    \n
    \n
  • \n
  • \n

    \n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.

    \n

    To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n

    \n

    To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n

    \n
  • \n
" + "smithy.api#documentation": "

The name of the challenge that you're responding to with this call. This is returned\n in the AdminInitiateAuth response if you must pass another\n challenge.

\n

Possible challenges include the following:

\n \n

All of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters. Include a \n DEVICE_KEY for device authentication.

\n
\n
    \n
  • \n

    \n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey, as \n CREDENTIAL. Examples of WebAuthn authenticators include \n biometric devices and security keys.

    \n
  • \n
  • \n

    \n PASSWORD: Respond with the user's password as PASSWORD.

    \n
  • \n
  • \n

    \n PASSWORD_SRP: Respond with the initial SRP secret as SRP_A.

    \n
  • \n
  • \n

    \n SELECT_CHALLENGE: Respond with a challenge selection as ANSWER. \n It must be one of the challenge types in the AvailableChallenges response \n parameter. Add the parameters of the selected challenge, for example USERNAME\n and SMS_OTP.

    \n
  • \n
  • \n

    \n SMS_MFA: Respond with the code that your user pool delivered in an SMS\n message, as SMS_MFA_CODE\n

    \n
  • \n
  • \n

    \n EMAIL_MFA: Respond with the code that your user pool delivered in an email\n message, as EMAIL_MFA_CODE\n

    \n
  • \n
  • \n

    \n EMAIL_OTP: Respond with the code that your user pool delivered in an email\n message, as EMAIL_OTP_CODE .

    \n
  • \n
  • \n

    \n SMS_OTP: Respond with the code that your user pool delivered in an SMS\n message, as SMS_OTP_CODE.

    \n
  • \n
  • \n

    \n PASSWORD_VERIFIER: Respond with the second stage of SRP secrets as\n PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, \n and TIMESTAMP.

    \n
  • \n
  • \n

    \n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function\n and issued in the ChallengeParameters of a challenge response.

    \n
  • \n
  • \n

    \n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.

    \n

    Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.

    \n \n

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

    \n
    \n
  • \n
  • \n

    \n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.

    \n

    To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n

    \n

    To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n

    \n
  • \n
" } }, "Session": { @@ -3378,7 +3349,7 @@ } ], "traits": { - "smithy.api#documentation": "

Resets the specified user's password in a user pool. This operation doesn't\n change the user's password, but sends a password-reset code.

\n

To use this API operation, your user pool must have self-service account recovery\n configured.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n
\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n
" + "smithy.api#documentation": "

Begins the password reset process. Sets the requested user’s account into a\n RESET_REQUIRED status, and sends them a password-reset code. Your user\n pool also sends the user a notification with a reset code and the information that their\n password has been reset. At sign-in, your application or the managed login session\n receives a challenge to complete the reset by confirming the code and setting a new\n password.

\n

To use this API operation, your user pool must have self-service account recovery\n configured.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n
\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n
" } }, "com.amazonaws.cognitoidentityprovider#AdminResetUserPasswordRequest": { @@ -3518,14 +3489,14 @@ "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "

The name of the challenge that you are responding to.

\n

Possible challenges include the following:

\n \n

All of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters.

\n
\n
    \n
  • \n

    \n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey. Examples \n of WebAuthn authenticators include biometric devices and security keys.

    \n
  • \n
  • \n

    \n PASSWORD: Respond with USER_PASSWORD_AUTH\n parameters: USERNAME (required), PASSWORD (required),\n SECRET_HASH (required if the app client is configured with a\n client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    \n PASSWORD_SRP: Respond with USER_SRP_AUTH parameters:\n USERNAME (required), SRP_A (required),\n SECRET_HASH (required if the app client is configured with a\n client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    \n SELECT_CHALLENGE: Respond to the challenge with\n USERNAME and an ANSWER that matches one of the\n challenge types in the AvailableChallenges response\n parameter.

    \n
  • \n
  • \n

    \n SMS_MFA: Respond with an\n SMS_MFA_CODE that your user pool delivered in an SMS message.

    \n
  • \n
  • \n

    \n EMAIL_OTP: Respond with an\n EMAIL_OTP_CODE that your user pool delivered in an email\n message.

    \n
  • \n
  • \n

    \n PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations.

    \n
  • \n
  • \n

    \n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function.

    \n
  • \n
  • \n

    \n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.

    \n

    Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.

    \n \n

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

    \n
    \n
  • \n
  • \n

    \n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.

    \n

    To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n

    \n

    To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n

    \n
  • \n
", + "smithy.api#documentation": "

The name of the challenge that you are responding to.

\n

Possible challenges include the following:

\n \n

All of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters. Include a \n DEVICE_KEY for device authentication.

\n
\n
    \n
  • \n

    \n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey, as \n CREDENTIAL. Examples of WebAuthn authenticators include \n biometric devices and security keys.

    \n
  • \n
  • \n

    \n PASSWORD: Respond with the user's password as PASSWORD.

    \n
  • \n
  • \n

    \n PASSWORD_SRP: Respond with the initial SRP secret as SRP_A.

    \n
  • \n
  • \n

    \n SELECT_CHALLENGE: Respond with a challenge selection as ANSWER. \n It must be one of the challenge types in the AvailableChallenges response \n parameter. Add the parameters of the selected challenge, for example USERNAME\n and SMS_OTP.

    \n
  • \n
  • \n

    \n SMS_MFA: Respond with the code that your user pool delivered in an SMS\n message, as SMS_MFA_CODE\n

    \n
  • \n
  • \n

    \n EMAIL_MFA: Respond with the code that your user pool delivered in an email\n message, as EMAIL_MFA_CODE\n

    \n
  • \n
  • \n

    \n EMAIL_OTP: Respond with the code that your user pool delivered in an email\n message, as EMAIL_OTP_CODE .

    \n
  • \n
  • \n

    \n SMS_OTP: Respond with the code that your user pool delivered in an SMS\n message, as SMS_OTP_CODE.

    \n
  • \n
  • \n

    \n PASSWORD_VERIFIER: Respond with the second stage of SRP secrets as\n PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, \n and TIMESTAMP.

    \n
  • \n
  • \n

    \n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function\n and issued in the ChallengeParameters of a challenge response.

    \n
  • \n
  • \n

    \n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.

    \n

    Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.

    \n \n

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

    \n
    \n
  • \n
  • \n

    \n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.

    \n

    To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n

    \n

    To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n

    \n
  • \n
", "smithy.api#required": {} } }, "ChallengeResponses": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponsesType", "traits": { - "smithy.api#documentation": "

The responses to the challenge that you received in the previous request. Each\n challenge has its own required response parameters. The following examples are partial\n JSON request bodies that highlight challenge-response parameters.

\n \n

You must provide a SECRET_HASH parameter in all challenge responses to an app\n client that has a client secret. Include a DEVICE_KEY for device\n authentication.

\n
\n
\n
SELECT_CHALLENGE
\n
\n

\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"ANSWER\": \"[Challenge name]\"}\n

\n

Available challenges are PASSWORD, PASSWORD_SRP, \n EMAIL_OTP, SMS_OTP, and WEB_AUTHN.

\n

Complete authentication in the SELECT_CHALLENGE response for\n PASSWORD, PASSWORD_SRP, and WEB_AUTHN:

\n
    \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"WEB_AUTHN\",\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n

    \n

    See \n AuthenticationResponseJSON.

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD\",\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD_SRP\",\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n

    \n
  • \n
\n

For SMS_OTP and EMAIL_OTP, respond with the\n username and answer. Your user pool will send a code for the user to submit in\n the next challenge response.

\n
    \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"SMS_OTP\",\n \"USERNAME\": \"[username]\"}\n

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"EMAIL_OTP\",\n \"USERNAME\": \"[username]\"}\n

    \n
  • \n
\n
\n
SMS_OTP
\n
\n

\n \"ChallengeName\": \"SMS_OTP\", \"ChallengeResponses\": \n {\"SMS_OTP_CODE\": \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
EMAIL_OTP
\n
\n

\n \"ChallengeName\": \"EMAIL_OTP\", \"ChallengeResponses\": {\"EMAIL_OTP_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
SMS_MFA
\n
\n

\n \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
PASSWORD_VERIFIER
\n
\n

This challenge response is part of the SRP flow. Amazon Cognito requires \n that your application respond to this challenge within a few seconds. When\n the response time exceeds this period, your user pool returns a\n NotAuthorizedException error.

\n

\n \"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\",\n \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\":\n [timestamp], \"USERNAME\": \"[username]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
CUSTOM_CHALLENGE
\n
\n

\n \"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
NEW_PASSWORD_REQUIRED
\n
\n

\n \"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\":\n {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\":\n \"[username]\"}\n

\n

To set any required attributes that InitiateAuth returned in\n an requiredAttributes parameter, add\n \"userAttributes.[attribute_name]\": \"[attribute_value]\".\n This parameter can also set values for writable attributes that aren't\n required by your user pool.

\n \n

In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

\n
\n
\n
SOFTWARE_TOKEN_MFA
\n
\n

\n \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":\n [authenticator_code]}\n

\n
\n
DEVICE_SRP_AUTH
\n
\n

\n \"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\":\n \"[srp_a]\"}\n

\n
\n
DEVICE_PASSWORD_VERIFIER
\n
\n

\n \"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\":\n \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\",\n \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}\n

\n
\n
MFA_SETUP
\n
\n

\n \"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\"}, \"SESSION\": \"[Session ID from\n VerifySoftwareToken]\"\n

\n
\n
SELECT_MFA_TYPE
\n
\n

\n \"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"ANSWER\": \"[SMS_MFA or SOFTWARE_TOKEN_MFA]\"}\n

\n
\n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" + "smithy.api#documentation": "

The responses to the challenge that you received in the previous request. Each\n challenge has its own required response parameters. The following examples are partial\n JSON request bodies that highlight challenge-response parameters.

\n \n

You must provide a SECRET_HASH parameter in all challenge responses to an app\n client that has a client secret. Include a DEVICE_KEY for device\n authentication.

\n
\n
\n
SELECT_CHALLENGE
\n
\n

\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"ANSWER\": \"[Challenge name]\"}\n

\n

Available challenges are PASSWORD, PASSWORD_SRP, \n EMAIL_OTP, SMS_OTP, and WEB_AUTHN.

\n

Complete authentication in the SELECT_CHALLENGE response for\n PASSWORD, PASSWORD_SRP, and WEB_AUTHN:

\n
    \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"WEB_AUTHN\",\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n

    \n

    See \n AuthenticationResponseJSON.

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD\",\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD_SRP\",\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n

    \n
  • \n
\n

For SMS_OTP and EMAIL_OTP, respond with the\n username and answer. Your user pool will send a code for the user to submit in\n the next challenge response.

\n
    \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"SMS_OTP\",\n \"USERNAME\": \"[username]\"}\n

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"EMAIL_OTP\",\n \"USERNAME\": \"[username]\"}\n

    \n
  • \n
\n
\n
WEB_AUTHN
\n
\n

\n \"ChallengeName\": \"WEB_AUTHN\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n

\n

See \n AuthenticationResponseJSON.

\n
\n
PASSWORD
\n
\n

\n \"ChallengeName\": \"PASSWORD\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n

\n
\n
PASSWORD_SRP
\n
\n

\n \"ChallengeName\": \"PASSWORD_SRP\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n

\n
\n
SMS_OTP
\n
\n

\n \"ChallengeName\": \"SMS_OTP\", \"ChallengeResponses\": \n {\"SMS_OTP_CODE\": \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
EMAIL_OTP
\n
\n

\n \"ChallengeName\": \"EMAIL_OTP\", \"ChallengeResponses\": {\"EMAIL_OTP_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
SMS_MFA
\n
\n

\n \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
PASSWORD_VERIFIER
\n
\n

This challenge response is part of the SRP flow. Amazon Cognito requires \n that your application respond to this challenge within a few seconds. When\n the response time exceeds this period, your user pool returns a\n NotAuthorizedException error.

\n

\n \"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\",\n \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\":\n [timestamp], \"USERNAME\": \"[username]\"}\n

\n
\n
CUSTOM_CHALLENGE
\n
\n

\n \"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}\n

\n
\n
NEW_PASSWORD_REQUIRED
\n
\n

\n \"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\":\n {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\":\n \"[username]\"}\n

\n

To set any required attributes that InitiateAuth returned in\n an requiredAttributes parameter, add\n \"userAttributes.[attribute_name]\": \"[attribute_value]\".\n This parameter can also set values for writable attributes that aren't\n required by your user pool.

\n \n

In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

\n
\n
\n
SOFTWARE_TOKEN_MFA
\n
\n

\n \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":\n [authenticator_code]}\n

\n
\n
DEVICE_SRP_AUTH
\n
\n

\n \"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\":\n \"[srp_a]\"}\n

\n
\n
DEVICE_PASSWORD_VERIFIER
\n
\n

\n \"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\":\n \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\",\n \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}\n

\n
\n
MFA_SETUP
\n
\n

\n \"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\"}, \"SESSION\": \"[Session ID from\n VerifySoftwareToken]\"\n

\n
\n
SELECT_MFA_TYPE
\n
\n

\n \"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"ANSWER\": \"[SMS_MFA|EMAIL_MFA|SOFTWARE_TOKEN_MFA]\"}\n

\n
\n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" } }, "Session": { @@ -3564,7 +3535,7 @@ "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "

The name of the next challenge that you must respond to.

\n

Possible challenges include the following:

\n \n

All of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters.

\n
\n
    \n
  • \n

    \n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey. Examples \n of WebAuthn authenticators include biometric devices and security keys.

    \n
  • \n
  • \n

    \n PASSWORD: Respond with USER_PASSWORD_AUTH\n parameters: USERNAME (required), PASSWORD (required),\n SECRET_HASH (required if the app client is configured with a\n client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    \n PASSWORD_SRP: Respond with USER_SRP_AUTH parameters:\n USERNAME (required), SRP_A (required),\n SECRET_HASH (required if the app client is configured with a\n client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    \n SELECT_CHALLENGE: Respond to the challenge with\n USERNAME and an ANSWER that matches one of the\n challenge types in the AvailableChallenges response\n parameter.

    \n
  • \n
  • \n

    \n SMS_MFA: Respond with an\n SMS_MFA_CODE that your user pool delivered in an SMS message.

    \n
  • \n
  • \n

    \n EMAIL_OTP: Respond with an\n EMAIL_OTP_CODE that your user pool delivered in an email\n message.

    \n
  • \n
  • \n

    \n PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations.

    \n
  • \n
  • \n

    \n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function.

    \n
  • \n
  • \n

    \n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.

    \n

    Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.

    \n \n

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

    \n
    \n
  • \n
  • \n

    \n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.

    \n

    To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n

    \n

    To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n

    \n
  • \n
" + "smithy.api#documentation": "

The name of the next challenge that you must respond to.

\n

Possible challenges include the following:

\n \n

All of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters. Include a \n DEVICE_KEY for device authentication.

\n
\n
    \n
  • \n

    \n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey, as \n CREDENTIAL. Examples of WebAuthn authenticators include \n biometric devices and security keys.

    \n
  • \n
  • \n

    \n PASSWORD: Respond with the user's password as PASSWORD.

    \n
  • \n
  • \n

    \n PASSWORD_SRP: Respond with the initial SRP secret as SRP_A.

    \n
  • \n
  • \n

    \n SELECT_CHALLENGE: Respond with a challenge selection as ANSWER. \n It must be one of the challenge types in the AvailableChallenges response \n parameter. Add the parameters of the selected challenge, for example USERNAME\n and SMS_OTP.

    \n
  • \n
  • \n

    \n SMS_MFA: Respond with the code that your user pool delivered in an SMS\n message, as SMS_MFA_CODE\n

    \n
  • \n
  • \n

    \n EMAIL_MFA: Respond with the code that your user pool delivered in an email\n message, as EMAIL_MFA_CODE\n

    \n
  • \n
  • \n

    \n EMAIL_OTP: Respond with the code that your user pool delivered in an email\n message, as EMAIL_OTP_CODE .

    \n
  • \n
  • \n

    \n SMS_OTP: Respond with the code that your user pool delivered in an SMS\n message, as SMS_OTP_CODE.

    \n
  • \n
  • \n

    \n PASSWORD_VERIFIER: Respond with the second stage of SRP secrets as\n PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, \n and TIMESTAMP.

    \n
  • \n
  • \n

    \n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function\n and issued in the ChallengeParameters of a challenge response.

    \n
  • \n
  • \n

    \n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.

    \n

    Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.

    \n \n

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

    \n
    \n
  • \n
  • \n

    \n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.

    \n

    To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n

    \n

    To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n

    \n
  • \n
" } }, "Session": { @@ -5112,7 +5083,7 @@ } }, "traits": { - "smithy.api#documentation": "

The responses to the challenge that you received in the previous request. Each\n challenge has its own required response parameters. The following examples are partial\n JSON request bodies that highlight challenge-response parameters.

\n \n

You must provide a SECRET_HASH parameter in all challenge responses to an app\n client that has a client secret. Include a DEVICE_KEY for device\n authentication.

\n
\n
\n
SELECT_CHALLENGE
\n
\n

\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"ANSWER\": \"[Challenge name]\"}\n

\n

Available challenges are PASSWORD, PASSWORD_SRP, \n EMAIL_OTP, SMS_OTP, and WEB_AUTHN.

\n

Complete authentication in the SELECT_CHALLENGE response for\n PASSWORD, PASSWORD_SRP, and WEB_AUTHN:

\n
    \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"WEB_AUTHN\",\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n

    \n

    See \n AuthenticationResponseJSON.

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD\",\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD_SRP\",\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n

    \n
  • \n
\n

For SMS_OTP and EMAIL_OTP, respond with the\n username and answer. Your user pool will send a code for the user to submit in\n the next challenge response.

\n
    \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"SMS_OTP\",\n \"USERNAME\": \"[username]\"}\n

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"EMAIL_OTP\",\n \"USERNAME\": \"[username]\"}\n

    \n
  • \n
\n
\n
SMS_OTP
\n
\n

\n \"ChallengeName\": \"SMS_OTP\", \"ChallengeResponses\": \n {\"SMS_OTP_CODE\": \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
EMAIL_OTP
\n
\n

\n \"ChallengeName\": \"EMAIL_OTP\", \"ChallengeResponses\": {\"EMAIL_OTP_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
SMS_MFA
\n
\n

\n \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
PASSWORD_VERIFIER
\n
\n

This challenge response is part of the SRP flow. Amazon Cognito requires \n that your application respond to this challenge within a few seconds. When\n the response time exceeds this period, your user pool returns a\n NotAuthorizedException error.

\n

\n \"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\",\n \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\":\n [timestamp], \"USERNAME\": \"[username]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
CUSTOM_CHALLENGE
\n
\n

\n \"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
NEW_PASSWORD_REQUIRED
\n
\n

\n \"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\":\n {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\":\n \"[username]\"}\n

\n

To set any required attributes that InitiateAuth returned in\n an requiredAttributes parameter, add\n \"userAttributes.[attribute_name]\": \"[attribute_value]\".\n This parameter can also set values for writable attributes that aren't\n required by your user pool.

\n \n

In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

\n
\n
\n
SOFTWARE_TOKEN_MFA
\n
\n

\n \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":\n [authenticator_code]}\n

\n
\n
DEVICE_SRP_AUTH
\n
\n

\n \"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\":\n \"[srp_a]\"}\n

\n
\n
DEVICE_PASSWORD_VERIFIER
\n
\n

\n \"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\":\n \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\",\n \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}\n

\n
\n
MFA_SETUP
\n
\n

\n \"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\"}, \"SESSION\": \"[Session ID from\n VerifySoftwareToken]\"\n

\n
\n
SELECT_MFA_TYPE
\n
\n

\n \"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"ANSWER\": \"[SMS_MFA or SOFTWARE_TOKEN_MFA]\"}\n

\n
\n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" + "smithy.api#documentation": "

The responses to the challenge that you received in the previous request. Each\n challenge has its own required response parameters. The following examples are partial\n JSON request bodies that highlight challenge-response parameters.

\n \n

You must provide a SECRET_HASH parameter in all challenge responses to an app\n client that has a client secret. Include a DEVICE_KEY for device\n authentication.

\n
\n
\n
SELECT_CHALLENGE
\n
\n

\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"ANSWER\": \"[Challenge name]\"}\n

\n

Available challenges are PASSWORD, PASSWORD_SRP, \n EMAIL_OTP, SMS_OTP, and WEB_AUTHN.

\n

Complete authentication in the SELECT_CHALLENGE response for\n PASSWORD, PASSWORD_SRP, and WEB_AUTHN:

\n
    \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"WEB_AUTHN\",\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n

    \n

    See \n AuthenticationResponseJSON.

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD\",\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD_SRP\",\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n

    \n
  • \n
\n

For SMS_OTP and EMAIL_OTP, respond with the\n username and answer. Your user pool will send a code for the user to submit in\n the next challenge response.

\n
    \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"SMS_OTP\",\n \"USERNAME\": \"[username]\"}\n

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"EMAIL_OTP\",\n \"USERNAME\": \"[username]\"}\n

    \n
  • \n
\n
\n
WEB_AUTHN
\n
\n

\n \"ChallengeName\": \"WEB_AUTHN\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n

\n

See \n AuthenticationResponseJSON.

\n
\n
PASSWORD
\n
\n

\n \"ChallengeName\": \"PASSWORD\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n

\n
\n
PASSWORD_SRP
\n
\n

\n \"ChallengeName\": \"PASSWORD_SRP\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n

\n
\n
SMS_OTP
\n
\n

\n \"ChallengeName\": \"SMS_OTP\", \"ChallengeResponses\": \n {\"SMS_OTP_CODE\": \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
EMAIL_OTP
\n
\n

\n \"ChallengeName\": \"EMAIL_OTP\", \"ChallengeResponses\": {\"EMAIL_OTP_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
SMS_MFA
\n
\n

\n \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
PASSWORD_VERIFIER
\n
\n

This challenge response is part of the SRP flow. Amazon Cognito requires \n that your application respond to this challenge within a few seconds. When\n the response time exceeds this period, your user pool returns a\n NotAuthorizedException error.

\n

\n \"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\",\n \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\":\n [timestamp], \"USERNAME\": \"[username]\"}\n

\n
\n
CUSTOM_CHALLENGE
\n
\n

\n \"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}\n

\n
\n
NEW_PASSWORD_REQUIRED
\n
\n

\n \"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\":\n {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\":\n \"[username]\"}\n

\n

To set any required attributes that InitiateAuth returned in\n an requiredAttributes parameter, add\n \"userAttributes.[attribute_name]\": \"[attribute_value]\".\n This parameter can also set values for writable attributes that aren't\n required by your user pool.

\n \n

In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

\n
\n
\n
SOFTWARE_TOKEN_MFA
\n
\n

\n \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":\n [authenticator_code]}\n

\n
\n
DEVICE_SRP_AUTH
\n
\n

\n \"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\":\n \"[srp_a]\"}\n

\n
\n
DEVICE_PASSWORD_VERIFIER
\n
\n

\n \"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\":\n \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\",\n \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}\n

\n
\n
MFA_SETUP
\n
\n

\n \"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\"}, \"SESSION\": \"[Session ID from\n VerifySoftwareToken]\"\n

\n
\n
SELECT_MFA_TYPE
\n
\n

\n \"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"ANSWER\": \"[SMS_MFA|EMAIL_MFA|SOFTWARE_TOKEN_MFA]\"}\n

\n
\n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" } }, "com.amazonaws.cognitoidentityprovider#ChallengeResponsesType": { @@ -6207,7 +6178,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new set of branding settings for a user pool style and associates it with an\n app client. This operation is the programmatic option for the creation of a new style in\n the branding designer.

\n

Provides values for UI customization in a Settings JSON object and image\n files in an Assets array. To send the JSON object Document\n type parameter in Settings, you might need to update to the most recent\n version of your Amazon Web Services SDK. To create a new style with default settings, set\n UseCognitoProvidedValues to true and don't provide\n values for any other options.

\n

This operation has a 2-megabyte request-size limit and include the CSS settings and\n image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito\n doesn't require that you pass all parameters in one request and preserves existing\n style settings that you don't specify. If your request is larger than 2MB, separate it\n into multiple requests, each with a size smaller than the limit.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n
" + "smithy.api#documentation": "

Creates a new set of branding settings for a user pool style and associates it with an\n app client. This operation is the programmatic option for the creation of a new style in\n the branding editor.

\n

Provides values for UI customization in a Settings JSON object and image\n files in an Assets array. To send the JSON object Document\n type parameter in Settings, you might need to update to the most recent\n version of your Amazon Web Services SDK. To create a new style with default settings, set\n UseCognitoProvidedValues to true and don't provide\n values for any other options.

\n

This operation has a 2-megabyte request-size limit and include the CSS settings and\n image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito\n doesn't require that you pass all parameters in one request and preserves existing\n style settings that you don't specify. If your request is larger than 2MB, separate it\n into multiple requests, each with a size smaller than the limit.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n
" } }, "com.amazonaws.cognitoidentityprovider#CreateManagedLoginBrandingRequest": { @@ -6231,13 +6202,13 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

When true, applies the default branding style options. These default options are\n managed by Amazon Cognito. You can modify them later in the branding designer.

\n

When you specify true for this option, you must also omit values for\n Settings and Assets in the request.

" + "smithy.api#documentation": "

When true, applies the default branding style options. These default options are\n managed by Amazon Cognito. You can modify them later in the branding editor.

\n

When you specify true for this option, you must also omit values for\n Settings and Assets in the request.

" } }, "Settings": { "target": "com.amazonaws.cognitoidentityprovider#Document", "traits": { - "smithy.api#documentation": "

A JSON file, encoded as a Document type, with the the settings that you\n want to apply to your style.

" + "smithy.api#documentation": "

A JSON file, encoded as a Document type, with the the settings that you\n want to apply to your style.

\n

The following components are not currently implemented and reserved for future\n use:

\n
    \n
  • \n

    \n signUp\n

    \n
  • \n
  • \n

    \n instructions\n

    \n
  • \n
  • \n

    \n sessionTimerDisplay\n

    \n
  • \n
  • \n

    \n languageSelector (for localization, see Managed login localization)\n

    \n
  • \n
" } }, "Assets": { @@ -6347,6 +6318,107 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#CreateTerms": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#CreateTermsRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#CreateTermsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TermsExistsException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates terms documents for the requested app client. When Terms and conditions and\n Privacy policy documents are configured, the app client displays links to them in the\n sign-up page of managed login for the app client.

\n

You can provide URLs for terms documents in the languages that are supported by managed login localization. Amazon Cognito directs users to the terms documents for\n their current language, with fallback to default if no document exists for\n the language.

\n

Each request accepts one type of terms document and a map of language-to-link for that\n document type. You must provide both types of terms documents in at least one language\n before Amazon Cognito displays your terms documents. Supply each type in separate\n requests.

\n

For more information, see Terms documents.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n
" + } + }, + "com.amazonaws.cognitoidentityprovider#CreateTermsRequest": { + "type": "structure", + "members": { + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the user pool where you want to create terms documents.

", + "smithy.api#required": {} + } + }, + "ClientId": { + "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "traits": { + "smithy.api#documentation": "

The ID of the app client where you want to create terms documents. Must be an app\n client in the requested user pool.

", + "smithy.api#required": {} + } + }, + "TermsName": { + "target": "com.amazonaws.cognitoidentityprovider#TermsNameType", + "traits": { + "smithy.api#documentation": "

A friendly name for the document that you want to create in the current request. Must\n begin with terms-of-use or privacy-policy as identification of\n the document type. Provide URLs for both terms-of-use and\n privacy-policy in separate requests.

", + "smithy.api#required": {} + } + }, + "TermsSource": { + "target": "com.amazonaws.cognitoidentityprovider#TermsSourceType", + "traits": { + "smithy.api#documentation": "

This parameter is reserved for future use and currently accepts only one value.

", + "smithy.api#required": {} + } + }, + "Enforcement": { + "target": "com.amazonaws.cognitoidentityprovider#TermsEnforcementType", + "traits": { + "smithy.api#documentation": "

This parameter is reserved for future use and currently accepts only one value.

", + "smithy.api#required": {} + } + }, + "Links": { + "target": "com.amazonaws.cognitoidentityprovider#LinksType", + "traits": { + "smithy.api#documentation": "

A map of URLs to languages. For each localized language that will view the requested\n TermsName, assign a URL. A selection of cognito:default\n displays for all languages that don't have a language-specific URL.

\n

For example, \"cognito:default\": \"https://terms.example.com\", \"cognito:spanish\":\n \"https://terms.example.com/es\".

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#CreateTermsResponse": { + "type": "structure", + "members": { + "Terms": { + "target": "com.amazonaws.cognitoidentityprovider#TermsType", + "traits": { + "smithy.api#documentation": "

A summary of your terms documents. Includes a unique identifier for later changes to\n the terms documents.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cognitoidentityprovider#CreateUserImportJob": { "type": "operation", "input": { @@ -7852,6 +7924,60 @@ "smithy.api#input": {} } }, + "com.amazonaws.cognitoidentityprovider#DeleteTerms": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#DeleteTermsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the terms documents with the requested ID from your app client.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n
" + } + }, + "com.amazonaws.cognitoidentityprovider#DeleteTermsRequest": { + "type": "structure", + "members": { + "TermsId": { + "target": "com.amazonaws.cognitoidentityprovider#TermsIdType", + "traits": { + "smithy.api#documentation": "

The ID of the terms documents that you want to delete.

", + "smithy.api#required": {} + } + }, + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the user pool that contains the terms documents that you want to\n delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.cognitoidentityprovider#DeleteUser": { "type": "operation", "input": { @@ -8596,6 +8722,71 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#DescribeTerms": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#DescribeTermsRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#DescribeTermsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details for the requested terms documents ID. For more information, see Terms documents.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n
" + } + }, + "com.amazonaws.cognitoidentityprovider#DescribeTermsRequest": { + "type": "structure", + "members": { + "TermsId": { + "target": "com.amazonaws.cognitoidentityprovider#TermsIdType", + "traits": { + "smithy.api#documentation": "

The ID of the terms documents that you want to describe.

", + "smithy.api#required": {} + } + }, + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the user pool that contains the terms documents that you want to\n describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#DescribeTermsResponse": { + "type": "structure", + "members": { + "Terms": { + "target": "com.amazonaws.cognitoidentityprovider#TermsType", + "traits": { + "smithy.api#documentation": "

A summary of the requested terms documents. Includes a unique identifier for later\n changes to the terms documents.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cognitoidentityprovider#DescribeUserImportJob": { "type": "operation", "input": { @@ -9821,7 +10012,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Sends a password-reset confirmation code for the currently signed-in user.

\n

For the Username parameter, you can use the username or user\n alias.

\n

If neither a verified phone number nor a verified email exists, Amazon Cognito responds with an\n InvalidParameterException error . If your app client has a client\n secret and you don't provide a SECRET_HASH parameter, this API returns\n NotAuthorizedException.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n
\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n
", + "smithy.api#documentation": "

Sends a password-reset confirmation code to the email address or phone number of the\n requested username. The message delivery method is determined by the user's\n available attributes and the AccountRecoverySetting configuration of the\n user pool.

\n

For the Username parameter, you can use the username or an email, phone,\n or preferred username alias.

\n

If neither a verified phone number nor a verified email exists, Amazon Cognito responds with an\n InvalidParameterException error . If your app client has a client\n secret and you don't provide a SECRET_HASH parameter, this API returns\n NotAuthorizedException.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n
\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n
", "smithy.api#optionalAuth": {} } }, @@ -10330,7 +10521,9 @@ } ], "traits": { - "smithy.api#documentation": "

Given a refresh token, issues new ID, access, and optionally refresh tokens for the\n user who owns the submitted token. This operation issues a new refresh token and\n invalidates the original refresh token after an optional grace period when refresh token\n rotation is enabled. If refresh token rotation is disabled, issues new ID and access\n tokens only.

" + "smithy.api#auth": [], + "smithy.api#documentation": "

Given a refresh token, issues new ID, access, and optionally refresh tokens for the\n user who owns the submitted token. This operation issues a new refresh token and\n invalidates the original refresh token after an optional grace period when refresh token\n rotation is enabled. If refresh token rotation is disabled, issues new ID and access\n tokens only.

", + "smithy.api#optionalAuth": {} } }, "com.amazonaws.cognitoidentityprovider#GetTokensFromRefreshTokenRequest": { @@ -10339,7 +10532,7 @@ "RefreshToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "

A valid refresh token that can authorize the request for new tokens. When refresh\n token rotation is active in the requested app client, this token is invalidated after\n the request is complete.

", + "smithy.api#documentation": "

A valid refresh token that can authorize the request for new tokens. When refresh\n token rotation is active in the requested app client, this token is invalidated after\n the request is complete and after an optional grace period.

", "smithy.api#required": {} } }, @@ -10359,7 +10552,7 @@ "DeviceKey": { "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", "traits": { - "smithy.api#documentation": "

When you enable device remembering, Amazon Cognito issues a device key that you can use for\n device authentication that bypasses multi-factor authentication (MFA). To implement\n GetTokensFromRefreshToken in a user pool with device remembering, you\n must capture the device key from the initial authentication request. If your application\n doesn't provide the key of a registered device, Amazon Cognito issues a new one. You must\n provide the confirmed device key in this request if device remembering is\n enabled in your user pool.

\n

For more information about device remembering, see Working with devices.

" + "smithy.api#documentation": "

When you enable device remembering, Amazon Cognito issues a device key that you can use for\n device authentication that bypasses multi-factor authentication (MFA). To implement\n GetTokensFromRefreshToken in a user pool with device remembering, you\n must capture the device key from the initial authentication request. If your application\n doesn't provide the key of a registered device, Amazon Cognito issues a new one. You must\n provide the confirmed device key in this request if device remembering is enabled in\n your user pool.

\n

For more information about device remembering, see Working with devices.

" } }, "ClientMetadata": { @@ -11261,7 +11454,7 @@ "AuthParameters": { "target": "com.amazonaws.cognitoidentityprovider#AuthParametersType", "traits": { - "smithy.api#documentation": "

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you're invoking.

\n

The required values are specific to the InitiateAuthRequest$AuthFlow.

\n

The following are some authentication flows and their parameters. Add a\n SECRET_HASH parameter if your app client has a client secret.

\n
    \n
  • \n

    \n USER_AUTH: USERNAME (required),\n PREFERRED_CHALLENGE. If you don't provide a value for\n PREFERRED_CHALLENGE, Amazon Cognito responds with the\n AvailableChallenges parameter that specifies the available\n sign-in methods.

    \n
  • \n
  • \n

    \n USER_SRP_AUTH: USERNAME (required),\n SRP_A (required), DEVICE_KEY.

    \n
  • \n
  • \n

    \n USER_PASSWORD_AUTH: USERNAME (required),\n PASSWORD (required), DEVICE_KEY.

    \n
  • \n
  • \n

    \n REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN\n (required), DEVICE_KEY.

    \n
  • \n
  • \n

    \n CUSTOM_AUTH: USERNAME (required),\n SECRET_HASH (if app client is configured with client secret),\n DEVICE_KEY. To start the authentication flow with password\n verification, include ChallengeName: SRP_A and SRP_A: (The\n SRP_A Value).

    \n
  • \n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" + "smithy.api#documentation": "

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you're invoking.

\n

The following are some authentication flows and their parameters. Add a\n SECRET_HASH parameter if your app client has a client secret. Add\n DEVICE_KEY if you want to bypass multi-factor authentication with a\n remembered device.

\n
\n
USER_AUTH
\n
\n
    \n
  • \n

    \n USERNAME (required)

    \n
  • \n
  • \n

    \n PREFERRED_CHALLENGE. If you don't provide a\n value for PREFERRED_CHALLENGE, Amazon Cognito responds with the\n AvailableChallenges parameter that specifies the\n available sign-in methods.

    \n
  • \n
\n
\n
USER_SRP_AUTH
\n
\n
    \n
  • \n

    \n USERNAME (required)

    \n
  • \n
  • \n

    \n SRP_A (required)

    \n
  • \n
\n
\n
USER_PASSWORD_AUTH
\n
\n
    \n
  • \n

    \n USERNAME (required)

    \n
  • \n
  • \n

    \n PASSWORD (required)

    \n
  • \n
\n
\n
REFRESH_TOKEN_AUTH/REFRESH_TOKEN
\n
\n
    \n
  • \n

    \n REFRESH_TOKEN(required)

    \n
  • \n
\n
\n
CUSTOM_AUTH
\n
\n
    \n
  • \n

    \n USERNAME (required)

    \n
  • \n
  • \n

    \n ChallengeName: SRP_A (when doing SRP authentication\n before custom challenges)

    \n
  • \n
  • \n

    \n SRP_A: (An SRP_A value) (when doing SRP\n authentication before custom challenges)

    \n
  • \n
\n
\n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" } }, "ClientMetadata": { @@ -11307,7 +11500,7 @@ "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "

The name of an additional authentication challenge that you must respond to.

\n

Possible challenges include the following:

\n \n

All of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters.

\n
\n
    \n
  • \n

    \n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey. Examples \n of WebAuthn authenticators include biometric devices and security keys.

    \n
  • \n
  • \n

    \n PASSWORD: Respond with USER_PASSWORD_AUTH\n parameters: USERNAME (required), PASSWORD (required),\n SECRET_HASH (required if the app client is configured with a\n client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    \n PASSWORD_SRP: Respond with USER_SRP_AUTH parameters:\n USERNAME (required), SRP_A (required),\n SECRET_HASH (required if the app client is configured with a\n client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    \n SELECT_CHALLENGE: Respond to the challenge with\n USERNAME and an ANSWER that matches one of the\n challenge types in the AvailableChallenges response\n parameter.

    \n
  • \n
  • \n

    \n SMS_MFA: Respond with an\n SMS_MFA_CODE that your user pool delivered in an SMS message.

    \n
  • \n
  • \n

    \n EMAIL_OTP: Respond with an\n EMAIL_OTP_CODE that your user pool delivered in an email\n message.

    \n
  • \n
  • \n

    \n PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations.

    \n
  • \n
  • \n

    \n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function.

    \n
  • \n
  • \n

    \n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.

    \n

    Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.

    \n \n

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

    \n
    \n
  • \n
  • \n

    \n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.

    \n

    To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n

    \n

    To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n

    \n
  • \n
" + "smithy.api#documentation": "

The name of an additional authentication challenge that you must respond to.

\n

Possible challenges include the following:

\n \n

All of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters. Include a \n DEVICE_KEY for device authentication.

\n
\n
    \n
  • \n

    \n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey, as \n CREDENTIAL. Examples of WebAuthn authenticators include \n biometric devices and security keys.

    \n
  • \n
  • \n

    \n PASSWORD: Respond with the user's password as PASSWORD.

    \n
  • \n
  • \n

    \n PASSWORD_SRP: Respond with the initial SRP secret as SRP_A.

    \n
  • \n
  • \n

    \n SELECT_CHALLENGE: Respond with a challenge selection as ANSWER. \n It must be one of the challenge types in the AvailableChallenges response \n parameter. Add the parameters of the selected challenge, for example USERNAME\n and SMS_OTP.

    \n
  • \n
  • \n

    \n SMS_MFA: Respond with the code that your user pool delivered in an SMS\n message, as SMS_MFA_CODE\n

    \n
  • \n
  • \n

    \n EMAIL_MFA: Respond with the code that your user pool delivered in an email\n message, as EMAIL_MFA_CODE\n

    \n
  • \n
  • \n

    \n EMAIL_OTP: Respond with the code that your user pool delivered in an email\n message, as EMAIL_OTP_CODE .

    \n
  • \n
  • \n

    \n SMS_OTP: Respond with the code that your user pool delivered in an SMS\n message, as SMS_OTP_CODE.

    \n
  • \n
  • \n

    \n PASSWORD_VERIFIER: Respond with the second stage of SRP secrets as\n PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, \n and TIMESTAMP.

    \n
  • \n
  • \n

    \n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function\n and issued in the ChallengeParameters of a challenge response.

    \n
  • \n
  • \n

    \n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.

    \n

    Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.

    \n \n

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

    \n
    \n
  • \n
  • \n

    \n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.

    \n

    To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n

    \n

    To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n

    \n
  • \n
" } }, "Session": { @@ -11587,6 +11780,12 @@ "smithy.api#documentation": "

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible\n stages of user pool operations. Triggers can modify the outcome of the operations that\n invoked them.

" } }, + "com.amazonaws.cognitoidentityprovider#LanguageIdType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^cognito:(default|english|french|spanish|german|bahasa-indonesia|italian|japanese|korean|portuguese-brazil|chinese-(simplified|traditional))$" + } + }, "com.amazonaws.cognitoidentityprovider#LimitExceededException": { "type": "structure", "members": { @@ -11603,6 +11802,31 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cognitoidentityprovider#LinkUrlType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$" + } + }, + "com.amazonaws.cognitoidentityprovider#LinksType": { + "type": "map", + "key": { + "target": "com.amazonaws.cognitoidentityprovider#LanguageIdType" + }, + "value": { + "target": "com.amazonaws.cognitoidentityprovider#LinkUrlType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 12 + } + } + }, "com.amazonaws.cognitoidentityprovider#ListDevices": { "type": "operation", "input": { @@ -12028,6 +12252,92 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#ListTerms": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#ListTermsRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#ListTermsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details about all terms documents for the requested user pool.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n
" + } + }, + "com.amazonaws.cognitoidentityprovider#ListTermsRequest": { + "type": "structure", + "members": { + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the user pool where you want to list terms documents.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.cognitoidentityprovider#ListTermsRequestMaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of terms documents that you want Amazon Cognito to return in the\n response.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#ListTermsRequestMaxResultsInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 60 + } + } + }, + "com.amazonaws.cognitoidentityprovider#ListTermsResponse": { + "type": "structure", + "members": { + "Terms": { + "target": "com.amazonaws.cognitoidentityprovider#TermsDescriptionListType", + "traits": { + "smithy.api#documentation": "

A summary of the requested terms documents. Includes unique identifiers for later\n changes to the terms documents.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cognitoidentityprovider#ListUserImportJobs": { "type": "operation", "input": { @@ -12809,13 +13119,13 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

When true, applies the default branding style options. This option reverts to default\n style options that are managed by Amazon Cognito. You can modify them later in the branding\n designer.

\n

When you specify true for this option, you must also omit values for\n Settings and Assets in the request.

" + "smithy.api#documentation": "

When true, applies the default branding style options. This option reverts to default\n style options that are managed by Amazon Cognito. You can modify them later in the branding\n editor.

\n

When you specify true for this option, you must also omit values for\n Settings and Assets in the request.

" } }, "Settings": { "target": "com.amazonaws.cognitoidentityprovider#Document", "traits": { - "smithy.api#documentation": "

A JSON file, encoded as a Document type, with the the settings that you\n want to apply to your style.

" + "smithy.api#documentation": "

A JSON file, encoded as a Document type, with the the settings that you\n want to apply to your style.

\n

The following components are not currently implemented and reserved for future\n use:

\n
    \n
  • \n

    \n signUp\n

    \n
  • \n
  • \n

    \n instructions\n

    \n
  • \n
  • \n

    \n sessionTimerDisplay\n

    \n
  • \n
  • \n

    \n languageSelector (for localization, see Managed login localization)\n

    \n
  • \n
" } }, "Assets": { @@ -13899,7 +14209,7 @@ "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "

The name of the challenge that you are responding to.

\n \n

You can't respond to an ADMIN_NO_SRP_AUTH challenge with this\n operation.

\n
\n

Possible challenges include the following:

\n \n

All of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters.

\n
\n
    \n
  • \n

    \n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey. Examples \n of WebAuthn authenticators include biometric devices and security keys.

    \n
  • \n
  • \n

    \n PASSWORD: Respond with USER_PASSWORD_AUTH\n parameters: USERNAME (required), PASSWORD (required),\n SECRET_HASH (required if the app client is configured with a\n client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    \n PASSWORD_SRP: Respond with USER_SRP_AUTH parameters:\n USERNAME (required), SRP_A (required),\n SECRET_HASH (required if the app client is configured with a\n client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    \n SELECT_CHALLENGE: Respond to the challenge with\n USERNAME and an ANSWER that matches one of the\n challenge types in the AvailableChallenges response\n parameter.

    \n
  • \n
  • \n

    \n SMS_MFA: Respond with an\n SMS_MFA_CODE that your user pool delivered in an SMS message.

    \n
  • \n
  • \n

    \n EMAIL_OTP: Respond with an\n EMAIL_OTP_CODE that your user pool delivered in an email\n message.

    \n
  • \n
  • \n

    \n PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations.

    \n
  • \n
  • \n

    \n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function.

    \n
  • \n
  • \n

    \n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.

    \n

    Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.

    \n \n

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

    \n
    \n
  • \n
  • \n

    \n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.

    \n

    To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n

    \n

    To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n

    \n
  • \n
", + "smithy.api#documentation": "

The name of the challenge that you are responding to.

\n \n

You can't respond to an ADMIN_NO_SRP_AUTH challenge with this\n operation.

\n
\n

Possible challenges include the following:

\n \n

All of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters. Include a \n DEVICE_KEY for device authentication.

\n
\n
    \n
  • \n

    \n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey, as \n CREDENTIAL. Examples of WebAuthn authenticators include \n biometric devices and security keys.

    \n
  • \n
  • \n

    \n PASSWORD: Respond with the user's password as PASSWORD.

    \n
  • \n
  • \n

    \n PASSWORD_SRP: Respond with the initial SRP secret as SRP_A.

    \n
  • \n
  • \n

    \n SELECT_CHALLENGE: Respond with a challenge selection as ANSWER. \n It must be one of the challenge types in the AvailableChallenges response \n parameter. Add the parameters of the selected challenge, for example USERNAME\n and SMS_OTP.

    \n
  • \n
  • \n

    \n SMS_MFA: Respond with the code that your user pool delivered in an SMS\n message, as SMS_MFA_CODE\n

    \n
  • \n
  • \n

    \n EMAIL_MFA: Respond with the code that your user pool delivered in an email\n message, as EMAIL_MFA_CODE\n

    \n
  • \n
  • \n

    \n EMAIL_OTP: Respond with the code that your user pool delivered in an email\n message, as EMAIL_OTP_CODE .

    \n
  • \n
  • \n

    \n SMS_OTP: Respond with the code that your user pool delivered in an SMS\n message, as SMS_OTP_CODE.

    \n
  • \n
  • \n

    \n PASSWORD_VERIFIER: Respond with the second stage of SRP secrets as\n PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, \n and TIMESTAMP.

    \n
  • \n
  • \n

    \n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function\n and issued in the ChallengeParameters of a challenge response.

    \n
  • \n
  • \n

    \n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.

    \n

    Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.

    \n \n

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

    \n
    \n
  • \n
  • \n

    \n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.

    \n

    To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n

    \n

    To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n

    \n
  • \n
", "smithy.api#required": {} } }, @@ -13912,7 +14222,7 @@ "ChallengeResponses": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponsesType", "traits": { - "smithy.api#documentation": "

The responses to the challenge that you received in the previous request. Each\n challenge has its own required response parameters. The following examples are partial\n JSON request bodies that highlight challenge-response parameters.

\n \n

You must provide a SECRET_HASH parameter in all challenge responses to an app\n client that has a client secret. Include a DEVICE_KEY for device\n authentication.

\n
\n
\n
SELECT_CHALLENGE
\n
\n

\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"ANSWER\": \"[Challenge name]\"}\n

\n

Available challenges are PASSWORD, PASSWORD_SRP, \n EMAIL_OTP, SMS_OTP, and WEB_AUTHN.

\n

Complete authentication in the SELECT_CHALLENGE response for\n PASSWORD, PASSWORD_SRP, and WEB_AUTHN:

\n
    \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"WEB_AUTHN\",\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n

    \n

    See \n AuthenticationResponseJSON.

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD\",\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD_SRP\",\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n

    \n
  • \n
\n

For SMS_OTP and EMAIL_OTP, respond with the\n username and answer. Your user pool will send a code for the user to submit in\n the next challenge response.

\n
    \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"SMS_OTP\",\n \"USERNAME\": \"[username]\"}\n

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"EMAIL_OTP\",\n \"USERNAME\": \"[username]\"}\n

    \n
  • \n
\n
\n
SMS_OTP
\n
\n

\n \"ChallengeName\": \"SMS_OTP\", \"ChallengeResponses\": \n {\"SMS_OTP_CODE\": \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
EMAIL_OTP
\n
\n

\n \"ChallengeName\": \"EMAIL_OTP\", \"ChallengeResponses\": {\"EMAIL_OTP_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
SMS_MFA
\n
\n

\n \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
PASSWORD_VERIFIER
\n
\n

This challenge response is part of the SRP flow. Amazon Cognito requires \n that your application respond to this challenge within a few seconds. When\n the response time exceeds this period, your user pool returns a\n NotAuthorizedException error.

\n

\n \"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\",\n \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\":\n [timestamp], \"USERNAME\": \"[username]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
CUSTOM_CHALLENGE
\n
\n

\n \"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}\n

\n

Add \"DEVICE_KEY\" when you sign in with a remembered\n device.

\n
\n
NEW_PASSWORD_REQUIRED
\n
\n

\n \"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\":\n {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\":\n \"[username]\"}\n

\n

To set any required attributes that InitiateAuth returned in\n an requiredAttributes parameter, add\n \"userAttributes.[attribute_name]\": \"[attribute_value]\".\n This parameter can also set values for writable attributes that aren't\n required by your user pool.

\n \n

In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

\n
\n
\n
SOFTWARE_TOKEN_MFA
\n
\n

\n \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":\n [authenticator_code]}\n

\n
\n
DEVICE_SRP_AUTH
\n
\n

\n \"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\":\n \"[srp_a]\"}\n

\n
\n
DEVICE_PASSWORD_VERIFIER
\n
\n

\n \"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\":\n \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\",\n \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}\n

\n
\n
MFA_SETUP
\n
\n

\n \"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\"}, \"SESSION\": \"[Session ID from\n VerifySoftwareToken]\"\n

\n
\n
SELECT_MFA_TYPE
\n
\n

\n \"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"ANSWER\": \"[SMS_MFA or SOFTWARE_TOKEN_MFA]\"}\n

\n
\n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" + "smithy.api#documentation": "

The responses to the challenge that you received in the previous request. Each\n challenge has its own required response parameters. The following examples are partial\n JSON request bodies that highlight challenge-response parameters.

\n \n

You must provide a SECRET_HASH parameter in all challenge responses to an app\n client that has a client secret. Include a DEVICE_KEY for device\n authentication.

\n
\n
\n
SELECT_CHALLENGE
\n
\n

\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"ANSWER\": \"[Challenge name]\"}\n

\n

Available challenges are PASSWORD, PASSWORD_SRP, \n EMAIL_OTP, SMS_OTP, and WEB_AUTHN.

\n

Complete authentication in the SELECT_CHALLENGE response for\n PASSWORD, PASSWORD_SRP, and WEB_AUTHN:

\n
    \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"WEB_AUTHN\",\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n

    \n

    See \n AuthenticationResponseJSON.

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD\",\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD_SRP\",\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n

    \n
  • \n
\n

For SMS_OTP and EMAIL_OTP, respond with the\n username and answer. Your user pool will send a code for the user to submit in\n the next challenge response.

\n
    \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"SMS_OTP\",\n \"USERNAME\": \"[username]\"}\n

    \n
  • \n
  • \n

    \n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"EMAIL_OTP\",\n \"USERNAME\": \"[username]\"}\n

    \n
  • \n
\n
\n
WEB_AUTHN
\n
\n

\n \"ChallengeName\": \"WEB_AUTHN\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n

\n

See \n AuthenticationResponseJSON.

\n
\n
PASSWORD
\n
\n

\n \"ChallengeName\": \"PASSWORD\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n

\n
\n
PASSWORD_SRP
\n
\n

\n \"ChallengeName\": \"PASSWORD_SRP\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n

\n
\n
SMS_OTP
\n
\n

\n \"ChallengeName\": \"SMS_OTP\", \"ChallengeResponses\": \n {\"SMS_OTP_CODE\": \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
EMAIL_OTP
\n
\n

\n \"ChallengeName\": \"EMAIL_OTP\", \"ChallengeResponses\": {\"EMAIL_OTP_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
SMS_MFA
\n
\n

\n \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n

\n
\n
PASSWORD_VERIFIER
\n
\n

This challenge response is part of the SRP flow. Amazon Cognito requires \n that your application respond to this challenge within a few seconds. When\n the response time exceeds this period, your user pool returns a\n NotAuthorizedException error.

\n

\n \"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\",\n \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\":\n [timestamp], \"USERNAME\": \"[username]\"}\n

\n
\n
CUSTOM_CHALLENGE
\n
\n

\n \"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}\n

\n
\n
NEW_PASSWORD_REQUIRED
\n
\n

\n \"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\":\n {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\":\n \"[username]\"}\n

\n

To set any required attributes that InitiateAuth returned in\n an requiredAttributes parameter, add\n \"userAttributes.[attribute_name]\": \"[attribute_value]\".\n This parameter can also set values for writable attributes that aren't\n required by your user pool.

\n \n

In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

\n
\n
\n
SOFTWARE_TOKEN_MFA
\n
\n

\n \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":\n [authenticator_code]}\n

\n
\n
DEVICE_SRP_AUTH
\n
\n

\n \"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\":\n \"[srp_a]\"}\n

\n
\n
DEVICE_PASSWORD_VERIFIER
\n
\n

\n \"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\":\n \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\",\n \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}\n

\n
\n
MFA_SETUP
\n
\n

\n \"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\"}, \"SESSION\": \"[Session ID from\n VerifySoftwareToken]\"\n

\n
\n
SELECT_MFA_TYPE
\n
\n

\n \"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"ANSWER\": \"[SMS_MFA|EMAIL_MFA|SOFTWARE_TOKEN_MFA]\"}\n

\n
\n
\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" } }, "AnalyticsMetadata": { @@ -13945,7 +14255,7 @@ "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "

The name of the next challenge that you must respond to.

\n

Possible challenges include the following:

\n \n

All of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters.

\n
\n
    \n
  • \n

    \n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey. Examples \n of WebAuthn authenticators include biometric devices and security keys.

    \n
  • \n
  • \n

    \n PASSWORD: Respond with USER_PASSWORD_AUTH\n parameters: USERNAME (required), PASSWORD (required),\n SECRET_HASH (required if the app client is configured with a\n client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    \n PASSWORD_SRP: Respond with USER_SRP_AUTH parameters:\n USERNAME (required), SRP_A (required),\n SECRET_HASH (required if the app client is configured with a\n client secret), DEVICE_KEY.

    \n
  • \n
  • \n

    \n SELECT_CHALLENGE: Respond to the challenge with\n USERNAME and an ANSWER that matches one of the\n challenge types in the AvailableChallenges response\n parameter.

    \n
  • \n
  • \n

    \n SMS_MFA: Respond with an\n SMS_MFA_CODE that your user pool delivered in an SMS message.

    \n
  • \n
  • \n

    \n EMAIL_OTP: Respond with an\n EMAIL_OTP_CODE that your user pool delivered in an email\n message.

    \n
  • \n
  • \n

    \n PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations.

    \n
  • \n
  • \n

    \n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function.

    \n
  • \n
  • \n

    \n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.

    \n

    Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.

    \n \n

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

    \n
    \n
  • \n
  • \n

    \n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.

    \n

    To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n

    \n

    To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n

    \n
  • \n
" + "smithy.api#documentation": "

The name of the next challenge that you must respond to.

\n

Possible challenges include the following:

\n \n

All of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters. Include a \n DEVICE_KEY for device authentication.

\n
\n
    \n
  • \n

    \n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey, as \n CREDENTIAL. Examples of WebAuthn authenticators include \n biometric devices and security keys.

    \n
  • \n
  • \n

    \n PASSWORD: Respond with the user's password as PASSWORD.

    \n
  • \n
  • \n

    \n PASSWORD_SRP: Respond with the initial SRP secret as SRP_A.

    \n
  • \n
  • \n

    \n SELECT_CHALLENGE: Respond with a challenge selection as ANSWER. \n It must be one of the challenge types in the AvailableChallenges response \n parameter. Add the parameters of the selected challenge, for example USERNAME\n and SMS_OTP.

    \n
  • \n
  • \n

    \n SMS_MFA: Respond with the code that your user pool delivered in an SMS\n message, as SMS_MFA_CODE\n

    \n
  • \n
  • \n

    \n EMAIL_MFA: Respond with the code that your user pool delivered in an email\n message, as EMAIL_MFA_CODE\n

    \n
  • \n
  • \n

    \n EMAIL_OTP: Respond with the code that your user pool delivered in an email\n message, as EMAIL_OTP_CODE .

    \n
  • \n
  • \n

    \n SMS_OTP: Respond with the code that your user pool delivered in an SMS\n message, as SMS_OTP_CODE.

    \n
  • \n
  • \n

    \n PASSWORD_VERIFIER: Respond with the second stage of SRP secrets as\n PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, \n and TIMESTAMP.

    \n
  • \n
  • \n

    \n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function\n and issued in the ChallengeParameters of a challenge response.

    \n
  • \n
  • \n

    \n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.

    \n
  • \n
  • \n

    \n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.

    \n

    Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.

    \n \n

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.

    \n
    \n
  • \n
  • \n

    \n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.

    \n

    To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n

    \n

    To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n

    \n
  • \n
" } }, "Session": { @@ -15554,6 +15864,173 @@ } } }, + "com.amazonaws.cognitoidentityprovider#TermsDescriptionListType": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentityprovider#TermsDescriptionType" + } + }, + "com.amazonaws.cognitoidentityprovider#TermsDescriptionType": { + "type": "structure", + "members": { + "TermsId": { + "target": "com.amazonaws.cognitoidentityprovider#TermsIdType", + "traits": { + "smithy.api#documentation": "

The ID of the requested terms documents.

", + "smithy.api#required": {} + } + }, + "TermsName": { + "target": "com.amazonaws.cognitoidentityprovider#TermsNameType", + "traits": { + "smithy.api#documentation": "

The type and friendly name of the requested terms documents.

", + "smithy.api#required": {} + } + }, + "Enforcement": { + "target": "com.amazonaws.cognitoidentityprovider#TermsEnforcementType", + "traits": { + "smithy.api#documentation": "

This parameter is reserved for future use and currently accepts one value.

", + "smithy.api#required": {} + } + }, + "CreationDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", + "traits": { + "smithy.api#documentation": "

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.

", + "smithy.api#required": {} + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", + "traits": { + "smithy.api#documentation": "

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of a set of terms documents. For more information, see Terms documents.

" + } + }, + "com.amazonaws.cognitoidentityprovider#TermsEnforcementType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.cognitoidentityprovider#TermsExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentityprovider#MessageType" + } + }, + "traits": { + "smithy.api#documentation": "

Terms document names must be unique to the app client. This exception is thrown when\n you attempt to create terms documents with a duplicate TermsName.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentityprovider#TermsIdType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.cognitoidentityprovider#TermsNameType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(terms-of-use|privacy-policy)$" + } + }, + "com.amazonaws.cognitoidentityprovider#TermsSourceType": { + "type": "enum", + "members": { + "LINK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINK" + } + } + } + }, + "com.amazonaws.cognitoidentityprovider#TermsType": { + "type": "structure", + "members": { + "TermsId": { + "target": "com.amazonaws.cognitoidentityprovider#TermsIdType", + "traits": { + "smithy.api#documentation": "

The ID of the terms documents.

", + "smithy.api#required": {} + } + }, + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the user pool that contains the terms documents.

", + "smithy.api#required": {} + } + }, + "ClientId": { + "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", + "traits": { + "smithy.api#documentation": "

The ID of the app client that the terms documents are assigned to.

", + "smithy.api#required": {} + } + }, + "TermsName": { + "target": "com.amazonaws.cognitoidentityprovider#TermsNameType", + "traits": { + "smithy.api#documentation": "

The type and friendly name of the terms documents.

", + "smithy.api#required": {} + } + }, + "TermsSource": { + "target": "com.amazonaws.cognitoidentityprovider#TermsSourceType", + "traits": { + "smithy.api#documentation": "

This parameter is reserved for future use and currently accepts one value.

", + "smithy.api#required": {} + } + }, + "Enforcement": { + "target": "com.amazonaws.cognitoidentityprovider#TermsEnforcementType", + "traits": { + "smithy.api#documentation": "

This parameter is reserved for future use and currently accepts one value.

", + "smithy.api#required": {} + } + }, + "Links": { + "target": "com.amazonaws.cognitoidentityprovider#LinksType", + "traits": { + "smithy.api#documentation": "

A map of URLs to languages. For each localized language that will view the requested\n TermsName, assign a URL. A selection of cognito:default\n displays for all languages that don't have a language-specific URL.

\n

For example, \"cognito:default\": \"https://terms.example.com\", \"cognito:spanish\":\n \"https://terms.example.com/es\".

", + "smithy.api#required": {} + } + }, + "CreationDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", + "traits": { + "smithy.api#documentation": "

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.

", + "smithy.api#required": {} + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.cognitoidentityprovider#DateType", + "traits": { + "smithy.api#documentation": "

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of a set of terms documents. For more information, see Terms documents.

" + } + }, "com.amazonaws.cognitoidentityprovider#TierChangeNotAllowedException": { "type": "structure", "members": { @@ -15886,7 +16363,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Provides the feedback for an authentication event generated by threat protection\n features. The user's response indicates that you think that the event either was from a\n valid user or was an unwanted authentication attempt. This feedback improves the risk\n evaluation decision for the user pool as part of Amazon Cognito threat protection.\n To activate this setting, your user pool must be on the \n Plus tier.

\n

This operation requires a FeedbackToken that Amazon Cognito generates and adds to\n notification emails when users have potentially suspicious authentication events. Users\n invoke this operation when they select the link that corresponds to\n {one-click-link-valid} or {one-click-link-invalid} in your\n notification template. Because FeedbackToken is a required parameter, you\n can' make requests to UpdateAuthEventFeedback without the contents of\n the notification email message.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n
", + "smithy.api#documentation": "

Provides the feedback for an authentication event generated by threat protection\n features. The user's response indicates that you think that the event either was from a\n valid user or was an unwanted authentication attempt. This feedback improves the risk\n evaluation decision for the user pool as part of Amazon Cognito threat protection.\n To activate this setting, your user pool must be on the \n Plus tier.

\n

This operation requires a FeedbackToken that Amazon Cognito generates and adds to\n notification emails when users have potentially suspicious authentication events. Users\n invoke this operation when they select the link that corresponds to\n {one-click-link-valid} or {one-click-link-invalid} in your\n notification template. Because FeedbackToken is a required parameter, you\n can't make requests to UpdateAuthEventFeedback without the contents of\n the notification email message.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

\n
", "smithy.api#optionalAuth": {} } }, @@ -16225,7 +16702,7 @@ } ], "traits": { - "smithy.api#documentation": "

Configures the branding settings for a user pool style. This operation is the\n programmatic option for the configuration of a style in the branding designer.

\n

Provides values for UI customization in a Settings JSON object and image\n files in an Assets array.

\n

This operation has a 2-megabyte request-size limit and include the CSS settings and\n image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito\n doesn't require that you pass all parameters in one request and preserves existing\n style settings that you don't specify. If your request is larger than 2MB, separate it\n into multiple requests, each with a size smaller than the limit.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n
" + "smithy.api#documentation": "

Configures the branding settings for a user pool style. This operation is the\n programmatic option for the configuration of a style in the branding editor.

\n

Provides values for UI customization in a Settings JSON object and image\n files in an Assets array.

\n

This operation has a 2-megabyte request-size limit and include the CSS settings and\n image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito\n doesn't require that you pass all parameters in one request and preserves existing\n style settings that you don't specify. If your request is larger than 2MB, separate it\n into multiple requests, each with a size smaller than the limit.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n
" } }, "com.amazonaws.cognitoidentityprovider#UpdateManagedLoginBrandingRequest": { @@ -16247,13 +16724,13 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

When true, applies the default branding style options. This option\n reverts to default style options that are managed by Amazon Cognito. You can modify them later in\n the branding designer.

\n

When you specify true for this option, you must also omit values for\n Settings and Assets in the request.

" + "smithy.api#documentation": "

When true, applies the default branding style options. This option\n reverts to default style options that are managed by Amazon Cognito. You can modify them later in\n the branding editor.

\n

When you specify true for this option, you must also omit values for\n Settings and Assets in the request.

" } }, "Settings": { "target": "com.amazonaws.cognitoidentityprovider#Document", "traits": { - "smithy.api#documentation": "

A JSON file, encoded as a Document type, with the the settings that you\n want to apply to your style.

" + "smithy.api#documentation": "

A JSON file, encoded as a Document type, with the the settings that you\n want to apply to your style.

\n

The following components are not currently implemented and reserved for future\n use:

\n
    \n
  • \n

    \n signUp\n

    \n
  • \n
  • \n

    \n instructions\n

    \n
  • \n
  • \n

    \n sessionTimerDisplay\n

    \n
  • \n
  • \n

    \n languageSelector (for localization, see Managed login localization)\n

    \n
  • \n
" } }, "Assets": { @@ -16360,6 +16837,101 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#UpdateTerms": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#UpdateTermsRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#UpdateTermsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TermsExistsException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies existing terms documents for the requested app client. When Terms and\n conditions and Privacy policy documents are configured, the app client displays links to\n them in the sign-up page of managed login for the app client.

\n

You can provide URLs for terms documents in the languages that are supported by managed login localization. Amazon Cognito directs users to the terms documents for\n their current language, with fallback to default if no document exists for\n the language.

\n

Each request accepts one type of terms document and a map of language-to-link for that\n document type. You must provide both types of terms documents in at least one language\n before Amazon Cognito displays your terms documents. Supply each type in separate\n requests.

\n

For more information, see Terms documents.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n
" + } + }, + "com.amazonaws.cognitoidentityprovider#UpdateTermsRequest": { + "type": "structure", + "members": { + "TermsId": { + "target": "com.amazonaws.cognitoidentityprovider#TermsIdType", + "traits": { + "smithy.api#documentation": "

The ID of the terms document that you want to update.

", + "smithy.api#required": {} + } + }, + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the user pool that contains the terms that you want to update.

", + "smithy.api#required": {} + } + }, + "TermsName": { + "target": "com.amazonaws.cognitoidentityprovider#TermsNameType", + "traits": { + "smithy.api#documentation": "

The new name that you want to apply to the requested terms documents.

" + } + }, + "TermsSource": { + "target": "com.amazonaws.cognitoidentityprovider#TermsSourceType", + "traits": { + "smithy.api#documentation": "

This parameter is reserved for future use and currently accepts only one value.

" + } + }, + "Enforcement": { + "target": "com.amazonaws.cognitoidentityprovider#TermsEnforcementType", + "traits": { + "smithy.api#documentation": "

This parameter is reserved for future use and currently accepts only one value.

" + } + }, + "Links": { + "target": "com.amazonaws.cognitoidentityprovider#LinksType", + "traits": { + "smithy.api#documentation": "

A map of URLs to languages. For each localized language that will view the requested\n TermsName, assign a URL. A selection of cognito:default\n displays for all languages that don't have a language-specific URL.

\n

For example, \"cognito:default\": \"https://terms.example.com\", \"cognito:spanish\":\n \"https://terms.example.com/es\".

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#UpdateTermsResponse": { + "type": "structure", + "members": { + "Terms": { + "target": "com.amazonaws.cognitoidentityprovider#TermsType", + "traits": { + "smithy.api#documentation": "

A summary of the updates to your terms documents.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cognitoidentityprovider#UpdateUserAttributes": { "type": "operation", "input": { @@ -16792,7 +17364,7 @@ "ManagedLoginVersion": { "target": "com.amazonaws.cognitoidentityprovider#WrappedIntegerType", "traits": { - "smithy.api#documentation": "

A version number that indicates the state of managed login for your domain. Version\n 1 is hosted UI (classic). Version 2 is the newer managed\n login with the branding designer. For more information, see Managed login.

" + "smithy.api#documentation": "

A version number that indicates the state of managed login for your domain. Version\n 1 is hosted UI (classic). Version 2 is the newer managed\n login with the branding editor. For more information, see Managed login.

" } }, "CustomDomainConfig": { @@ -16813,7 +17385,7 @@ "ManagedLoginVersion": { "target": "com.amazonaws.cognitoidentityprovider#WrappedIntegerType", "traits": { - "smithy.api#documentation": "

A version number that indicates the state of managed login for your domain. Version\n 1 is hosted UI (classic). Version 2 is the newer managed\n login with the branding designer. For more information, see Managed login.

" + "smithy.api#documentation": "

A version number that indicates the state of managed login for your domain. Version\n 1 is hosted UI (classic). Version 2 is the newer managed\n login with the branding editor. For more information, see Managed login.

" } }, "CloudFrontDomain": { diff --git a/codegen/sdk/aws-models/cognito-identity.json b/codegen/sdk/aws-models/cognito-identity.json index 72ed562da1b..b5a931d3f41 100644 --- a/codegen/sdk/aws-models/cognito-identity.json +++ b/codegen/sdk/aws-models/cognito-identity.json @@ -884,17 +884,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -908,17 +897,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -932,17 +910,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -956,17 +923,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/cognito-sync.json b/codegen/sdk/aws-models/cognito-sync.json index 6a27b5daa52..c9e85eaa2d4 100644 --- a/codegen/sdk/aws-models/cognito-sync.json +++ b/codegen/sdk/aws-models/cognito-sync.json @@ -704,17 +704,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -728,17 +717,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -752,17 +730,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -776,17 +743,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/comprehend.json b/codegen/sdk/aws-models/comprehend.json index 55f66b0a72f..19eab509c2f 100644 --- a/codegen/sdk/aws-models/comprehend.json +++ b/codegen/sdk/aws-models/comprehend.json @@ -2094,17 +2094,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2118,28 +2107,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2153,17 +2120,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/comprehendmedical.json b/codegen/sdk/aws-models/comprehendmedical.json index 6f0de6afd15..da9ac4e3718 100644 --- a/codegen/sdk/aws-models/comprehendmedical.json +++ b/codegen/sdk/aws-models/comprehendmedical.json @@ -1027,17 +1027,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1051,17 +1040,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1075,17 +1053,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1099,17 +1066,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/compute-optimizer.json b/codegen/sdk/aws-models/compute-optimizer.json index 7a9e3c5a635..0a5937fbf10 100644 --- a/codegen/sdk/aws-models/compute-optimizer.json +++ b/codegen/sdk/aws-models/compute-optimizer.json @@ -1202,17 +1202,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1226,17 +1215,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1250,17 +1228,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1274,17 +1241,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/config-service.json b/codegen/sdk/aws-models/config-service.json index e3f6e81063a..21573ec4f5d 100644 --- a/codegen/sdk/aws-models/config-service.json +++ b/codegen/sdk/aws-models/config-service.json @@ -11709,6 +11709,12 @@ "traits": { "smithy.api#enumValue": "FAILED" } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } } } }, @@ -11811,6 +11817,24 @@ "traits": { "smithy.api#enumValue": "FAILED" } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "EXITED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXITED" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } } } }, @@ -16688,17 +16712,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -16712,17 +16725,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -16736,17 +16738,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -16760,17 +16751,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/connect-contact-lens.json b/codegen/sdk/aws-models/connect-contact-lens.json index d453e5aac1c..702f84d96d8 100644 --- a/codegen/sdk/aws-models/connect-contact-lens.json +++ b/codegen/sdk/aws-models/connect-contact-lens.json @@ -631,17 +631,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -655,17 +644,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -679,17 +657,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -703,17 +670,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/connect.json b/codegen/sdk/aws-models/connect.json index 005ee0b27f4..c1655f1b056 100644 --- a/codegen/sdk/aws-models/connect.json +++ b/codegen/sdk/aws-models/connect.json @@ -632,6 +632,26 @@ "com.amazonaws.connect#AgentStatusId": { "type": "string" }, + "com.amazonaws.connect#AgentStatusIdentifier": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent status.

" + } + }, + "Id": { + "target": "com.amazonaws.connect#AgentStatusId", + "traits": { + "smithy.api#documentation": "

The identifier of the agent status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the agent status assigned to the user.

" + } + }, "com.amazonaws.connect#AgentStatusList": { "type": "list", "member": { @@ -830,6 +850,12 @@ } } }, + "com.amazonaws.connect#AgentStatuses": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#AgentStatusId" + } + }, "com.amazonaws.connect#AgentUsername": { "type": "string", "traits": { @@ -937,6 +963,9 @@ { "target": "com.amazonaws.connect#AssociateBot" }, + { + "target": "com.amazonaws.connect#AssociateContactWithUser" + }, { "target": "com.amazonaws.connect#AssociateDefaultVocabulary" }, @@ -1291,6 +1320,9 @@ { "target": "com.amazonaws.connect#GetContactAttributes" }, + { + "target": "com.amazonaws.connect#GetContactMetrics" + }, { "target": "com.amazonaws.connect#GetCurrentMetricData" }, @@ -1420,6 +1452,9 @@ { "target": "com.amazonaws.connect#ListRealtimeContactAnalysisSegmentsV2" }, + { + "target": "com.amazonaws.connect#ListRoutingProfileManualAssignmentQueues" + }, { "target": "com.amazonaws.connect#ListRoutingProfileQueues" }, @@ -2426,17 +2461,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2450,17 +2474,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2474,17 +2487,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2498,17 +2500,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3109,6 +3100,81 @@ "smithy.api#input": {} } }, + "com.amazonaws.connect#AssociateContactWithUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateContactWithUserRequest" + }, + "output": { + "target": "com.amazonaws.connect#AssociateContactWithUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a queued contact with an agent.

\n

\n Use cases\n

\n

Following are common uses cases for this API:

\n
    \n
  • \n

    Custom contact routing. You can build custom contact routing mechanisms beyond the default\n system routing in Amazon Connect. You can create tailored contact distribution logic that\n offers queued contacts directly to specific agents.

    \n
  • \n
  • \n

    Manual contact assignment. You can programmatically assign queued contacts to available users. This \n provides flexibility to contact centers that require manual oversight or specialized routing\n workflows outside of standard queue management.

    \n

    For information about how manual contact assignment works in the agent workspace, see the Access the Worklist app in the Amazon Connect agent workspace in the Amazon Connect Administrator\n Guide.

    \n
  • \n
\n

\n Important things to know\n

\n
    \n
  • \n

    Use this API chat/SMS, email, and task contacts. It does not support voice\n contacts.

    \n
  • \n
  • \n

    Use it to associate contacts with users regardless of their current state, including\n custom states. Ensure your application logic accounts for user availability before making\n associations.

    \n
  • \n
  • \n

    It honors the IAM context key connect:PreferredUserArn to prevent\n unauthorized contact associations.

    \n
  • \n
  • \n

    It respects the IAM context key connect:PreferredUserArn to enforce\n authorization controls and prevent unauthorized contact associations. Verify that your IAM\n policies are properly configured to support your intended use cases.

    \n
  • \n
\n

\n Endpoints: See Amazon Connect endpoints and\n quotas.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contacts/{InstanceId}/{ContactId}/associate-user", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociateContactWithUserRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.connect#AgentResourceId", + "traits": { + "smithy.api#documentation": "

The identifier for the user. This can be the ID or the ARN of the user.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#AssociateContactWithUserResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#AssociateDefaultVocabulary": { "type": "operation", "input": { @@ -3582,7 +3648,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates a set of quick connects with a queue.

", + "smithy.api#documentation": "

Associates a set of quick connects with a queue.

", "smithy.api#http": { "method": "POST", "uri": "/queues/{InstanceId}/{QueueId}/associate-quick-connects", @@ -3677,8 +3743,13 @@ "QueueConfigs": { "target": "com.amazonaws.connect#RoutingProfileQueueConfigList", "traits": { - "smithy.api#documentation": "

The queues to associate with this routing profile.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The queues to associate with this routing profile.

" + } + }, + "ManualAssignmentQueueConfigs": { + "target": "com.amazonaws.connect#RoutingProfileManualAssignmentQueueConfigList", + "traits": { + "smithy.api#documentation": "

The manual assignment queues to associate with this routing profile.

" } } }, @@ -4470,7 +4541,7 @@ } }, "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change. To \nrequest access to this API, contact Amazon Web ServicesSupport.

\n

Information about an authentication profile. An authentication profile is a resource that\n stores the authentication settings for users in your contact center. You use authentication\n profiles to set up IP address range restrictions and session timeouts. For more information, see\n Set IP\n address restrictions or session timeouts.

" + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change. To \nrequest access to this API, contact Amazon Web Services Support.

\n

Information about an authentication profile. An authentication profile is a resource that\n stores the authentication settings for users in your contact center. You use authentication\n profiles to set up IP address range restrictions and session timeouts. For more information, see\n Set IP\n address restrictions or session timeouts.

" } }, "com.amazonaws.connect#AuthenticationProfileDescription": { @@ -4542,7 +4613,7 @@ } }, "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change. To \nrequest access to this API, contact Amazon Web ServicesSupport.

\n

A summary of a given authentication profile.

" + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change. To \nrequest access to this API, contact Amazon Web Services Support.

\n

A summary of a given authentication profile.

" } }, "com.amazonaws.connect#AuthenticationProfileSummaryList": { @@ -5211,7 +5282,7 @@ "MultiParty": { "target": "com.amazonaws.connect#NullableBoolean", "traits": { - "smithy.api#documentation": "

A boolean flag indicating whether multiparty chat or supervisor barge were enabled on this contact.

" + "smithy.api#documentation": "

A boolean flag indicating whether multiparty chat or supervisor barge were enabled on this\n contact.

" } }, "TotalMessages": { @@ -5241,7 +5312,7 @@ "ConversationTurnCount": { "target": "com.amazonaws.connect#Count", "traits": { - "smithy.api#documentation": "

The number of conversation turns in a chat contact, which represents the back-and-forth exchanges between customer and other participants.

" + "smithy.api#documentation": "

The number of conversation turns in a chat contact, which represents the back-and-forth\n exchanges between customer and other participants.

" } }, "AgentFirstResponseTimestamp": { @@ -6995,6 +7066,85 @@ } } }, + "com.amazonaws.connect#ContactMetricInfo": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ContactMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric being retrieved in type String.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The object that contains information about metric being requested.

" + } + }, + "com.amazonaws.connect#ContactMetricName": { + "type": "enum", + "members": { + "POSITION_IN_QUEUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSITION_IN_QUEUE" + } + } + } + }, + "com.amazonaws.connect#ContactMetricResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ContactMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric being retrieved in type String.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.connect#ContactMetricValue", + "traits": { + "smithy.api#documentation": "

Object result associated with the metric received.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Object containing information about metric requested for the contact.

" + } + }, + "com.amazonaws.connect#ContactMetricResults": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ContactMetricResult" + } + }, + "com.amazonaws.connect#ContactMetricValue": { + "type": "union", + "members": { + "Number": { + "target": "com.amazonaws.connect#Double", + "traits": { + "smithy.api#documentation": "

The number of type Double. This number is the contact's position in queue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Object which contains the number.

" + } + }, + "com.amazonaws.connect#ContactMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ContactMetricInfo" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.connect#ContactNotFoundException": { "type": "structure", "members": { @@ -7010,7 +7160,7 @@ "code": "ContactNotFoundException", "httpResponseCode": 410 }, - "smithy.api#documentation": "

The contact with the specified ID is not active or does not exist. Applies to Voice calls\n only, not to Chat or Task contacts.

", + "smithy.api#documentation": "

The contact with the specified ID is not active or does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 410 } @@ -7121,6 +7271,15 @@ "traits": { "smithy.api#documentation": "

Set of segment attributes for a contact.

" } + }, + "Name": { + "target": "com.amazonaws.connect#Name", + "traits": { + "smithy.api#documentation": "

Indicates name of the contact.

" + } + }, + "RoutingCriteria": { + "target": "com.amazonaws.connect#RoutingCriteria" } }, "traits": { @@ -7175,6 +7334,12 @@ "traits": { "smithy.api#documentation": "

The value of a segment attribute represented as a string.

" } + }, + "ValueMap": { + "target": "com.amazonaws.connect#SegmentAttributeValueMap", + "traits": { + "smithy.api#documentation": "

The key and value of a segment attribute.

" + } } }, "traits": { @@ -7188,6 +7353,9 @@ }, "value": { "target": "com.amazonaws.connect#ContactSearchSummarySegmentAttributeValue" + }, + "traits": { + "smithy.api#sensitive": {} } }, "com.amazonaws.connect#ContactState": { @@ -7441,7 +7609,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates an agent status for the specified Amazon Connect instance.

", + "smithy.api#documentation": "

Creates an agent status for the specified Amazon Connect instance.

", "smithy.api#http": { "method": "PUT", "uri": "/agent-status/{InstanceId}", @@ -8314,7 +8482,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates hours of operation.

", + "smithy.api#documentation": "

Creates hours of operation.

", "smithy.api#http": { "method": "PUT", "uri": "/hours-of-operations/{InstanceId}", @@ -8354,7 +8522,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an hours of operation override in an Amazon Connect hours of operation\n resource

", + "smithy.api#documentation": "

Creates an hours of operation override in an Amazon Connect hours of operation\n resource.

", "smithy.api#http": { "method": "PUT", "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}/overrides", @@ -8404,14 +8572,14 @@ "EffectiveFrom": { "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", "traits": { - "smithy.api#documentation": "

The date from when the hours of operation override would be effective.

", + "smithy.api#documentation": "

The date from when the hours of operation override is effective.

", "smithy.api#required": {} } }, "EffectiveTill": { "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", "traits": { - "smithy.api#documentation": "

The date until when the hours of operation override would be effective.

", + "smithy.api#documentation": "

The date until when the hours of operation override is effective.

", "smithy.api#required": {} } } @@ -8728,6 +8896,9 @@ "target": "com.amazonaws.connect#CreateParticipantResponse" }, "errors": [ + { + "target": "com.amazonaws.connect#ConflictException" + }, { "target": "com.amazonaws.connect#InternalServiceException" }, @@ -8745,7 +8916,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a new participant into an on-going chat contact. For more information, see Customize chat\n flow experiences by integrating custom participants.

", + "smithy.api#documentation": "

Adds a new participant into an on-going chat contact or webRTC call. For more information,\n see Customize chat flow experiences by integrating custom participants or Enable\n multi-user web, in-app, and video calling.

", "smithy.api#http": { "method": "POST", "uri": "/contact/create-participant", @@ -8766,7 +8937,7 @@ "ContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.

", + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect. Supports contacts in the CHAT channel and VOICE (WebRTC) channels. For WebRTC\n calls, this should be the initial contact ID that was generated when the contact was first\n created (from the StartWebRTCContact API) in the VOICE channel

", "smithy.api#required": {} } }, @@ -8780,7 +8951,7 @@ "ParticipantDetails": { "target": "com.amazonaws.connect#ParticipantDetailsToAdd", "traits": { - "smithy.api#documentation": "

Information identifying the participant.

\n \n

The only Valid value for ParticipantRole is CUSTOM_BOT.

\n

\n DisplayName is Required.

\n
", + "smithy.api#documentation": "

Information identifying the participant.

\n \n

The only valid value for ParticipantRole is CUSTOM_BOT for chat\n contact and CUSTOMER for voice contact.

\n
", "smithy.api#required": {} } } @@ -8936,7 +9107,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new predefined attribute for the specified Amazon Connect instance. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.

", + "smithy.api#documentation": "

Creates a new predefined attribute for the specified Amazon Connect instance. A predefined\n attribute is made up of a name and a value.

\n

For the predefined attributes per instance quota, see Amazon Connect quotas.

\n

\n Use cases\n

\n

Following are common uses cases for this API:

\n
    \n
  • \n

    Create an attribute for routing proficiency (for example, agent certification) that has\n predefined values (for example, a list of possible certifications). For more information, see\n Create\n predefined attributes for routing contacts to agents.

    \n
  • \n
  • \n

    Create an attribute for business unit name that has a list of predefined business unit\n names used in your organization. This is a use case where information for a contact varies\n between transfers or conferences. For more information, see Use contact segment\n attributes.

    \n
  • \n
\n

\n Endpoints: See Amazon Connect endpoints and\n quotas.

", "smithy.api#http": { "method": "PUT", "uri": "/predefined-attributes/{InstanceId}", @@ -8965,8 +9136,19 @@ "Values": { "target": "com.amazonaws.connect#PredefinedAttributeValues", "traits": { - "smithy.api#documentation": "

The values of the predefined attribute.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The values of the predefined attribute.

" + } + }, + "Purposes": { + "target": "com.amazonaws.connect#PredefinedAttributePurposeNameList", + "traits": { + "smithy.api#documentation": "

Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.

" + } + }, + "AttributeConfiguration": { + "target": "com.amazonaws.connect#InputPredefinedAttributeConfiguration", + "traits": { + "smithy.api#documentation": "

Custom metadata that is associated to predefined attributes to control behavior \nin upstream services, such as controlling \nhow a predefined attribute should be displayed in the Amazon Connect admin website.

" } } }, @@ -9483,6 +9665,12 @@ "smithy.api#documentation": "

The inbound queues associated with the routing profile. If no queue is added, the agent can\n make only outbound calls.

\n

The limit of 10 array members applies to the maximum number of\n RoutingProfileQueueConfig objects that can be passed during a CreateRoutingProfile\n API request. It is different from the quota of 50 queues per routing profile per instance that is\n listed in Amazon Connect service\n quotas.

" } }, + "ManualAssignmentQueueConfigs": { + "target": "com.amazonaws.connect#RoutingProfileManualAssignmentQueueConfigList", + "traits": { + "smithy.api#documentation": "

The manual assignment queues associated with the routing profile. If no queue is added,\n agents and supervisors can't pick or assign any contacts from this routing profile. The limit of\n 10 array members applies to the maximum number of RoutingProfileManualAssignmentQueueConfig\n objects that can be passed during a CreateRoutingProfile API request. It is different from the\n quota of 50 queues per routing profile per instance that is listed in Amazon Connect service\n quotas.

" + } + }, "MediaConcurrencies": { "target": "com.amazonaws.connect#MediaConcurrencies", "traits": { @@ -10147,7 +10335,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a user account for the specified Amazon Connect instance.

\n \n

Certain UserIdentityInfo parameters\n are required in some situations. For example, Email is required if you are using\n SAML for identity management. FirstName and LastName are required if\n you are using Amazon Connect or SAML for identity management.

\n
\n

For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.

", + "smithy.api#documentation": "

Creates a user account for the specified Amazon Connect instance.

\n \n

Certain UserIdentityInfo parameters\n are required in some situations. For example, Email, FirstName and\n LastName are required if you are using Amazon Connect or SAML for identity\n management.

\n
\n

For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/users/{InstanceId}", @@ -11767,7 +11955,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes an hours of operation.

", + "smithy.api#documentation": "

Deletes an hours of operation.

", "smithy.api#http": { "method": "DELETE", "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", @@ -11801,7 +11989,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an hours of operation override in an Amazon Connect hours of operation\n resource

", + "smithy.api#documentation": "

Deletes an hours of operation override in an Amazon Connect hours of operation\n resource.

", "smithy.api#http": { "method": "DELETE", "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}/overrides/{HoursOfOperationOverrideId}", @@ -13038,7 +13226,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes an agent status.

", + "smithy.api#documentation": "

Describes an agent status.

", "smithy.api#http": { "method": "GET", "uri": "/agent-status/{InstanceId}/{AgentStatusId}", @@ -13110,7 +13298,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change. To \nrequest access to this API, contact Amazon Web ServicesSupport.

\n

Describes the target authentication profile.

", + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change. To \nrequest access to this API, contact Amazon Web Services Support.

\n

Describes the target authentication profile.

", "smithy.api#http": { "method": "GET", "uri": "/authentication-profiles/{InstanceId}/{AuthenticationProfileId}", @@ -13676,7 +13864,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the hours of operation.

", + "smithy.api#documentation": "

Describes the hours of operation.

", "smithy.api#http": { "method": "GET", "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", @@ -14108,7 +14296,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a predefined attribute for the specified Amazon Connect instance. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.

", + "smithy.api#documentation": "

Describes a predefined attribute for the specified Amazon Connect instance. A predefined\n attribute is made up of a name and a value. You can use predefined attributes\n for:

\n \n

For the predefined attributes per instance quota, see Amazon Connect quotas.

\n

\n Endpoints: See Amazon Connect endpoints and\n quotas.

", "smithy.api#http": { "method": "GET", "uri": "/predefined-attributes/{InstanceId}/{Name}", @@ -14252,7 +14440,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the specified queue.

", + "smithy.api#documentation": "

Describes the specified queue.

", "smithy.api#http": { "method": "GET", "uri": "/queues/{InstanceId}/{QueueId}", @@ -15137,6 +15325,12 @@ "traits": { "smithy.api#documentation": "

The expression of a step in a routing criteria.

" } + }, + "AgentStatus": { + "target": "com.amazonaws.connect#AgentStatusIdentifier", + "traits": { + "smithy.api#documentation": "

Information about the agent status assigned to the user.

" + } } }, "traits": { @@ -15771,7 +15965,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Disassociates a set of quick connects from a queue.

", + "smithy.api#documentation": "

Disassociates a set of quick connects from a queue.

", "smithy.api#http": { "method": "POST", "uri": "/queues/{InstanceId}/{QueueId}/disassociate-quick-connects", @@ -15836,7 +16030,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates a set of queues from a routing profile.

", + "smithy.api#documentation": "

Disassociates a set of queues from a routing profile.

\n

Up to 10 queue references can be disassociated in a single API call. More than 10 queue\n references results in a single call results in an InvalidParameterException.

", "smithy.api#http": { "method": "POST", "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/disassociate-queues", @@ -15866,8 +16060,13 @@ "QueueReferences": { "target": "com.amazonaws.connect#RoutingProfileQueueReferenceList", "traits": { - "smithy.api#documentation": "

The queues to disassociate from this routing profile.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The queues to disassociate from this routing profile.

" + } + }, + "ManualAssignmentQueueReferences": { + "target": "com.amazonaws.connect#RoutingProfileQueueReferenceList", + "traits": { + "smithy.api#documentation": "

The manual assignment queues to disassociate with this routing profile.

" } } }, @@ -16593,13 +16792,13 @@ "Address": { "target": "com.amazonaws.connect#EndpointAddress", "traits": { - "smithy.api#documentation": "

Address of the email recipient.

\n

Type: String

\n

Length Constraints: Minimum length of 1. Maximum length of 256.

" + "smithy.api#documentation": "

Address of the email recipient.

" } }, "DisplayName": { "target": "com.amazonaws.connect#EndpointDisplayName", "traits": { - "smithy.api#documentation": "

Display name of the email recipient.

\n

Type: String

\n

Length Constraints: Minimum length of 1. Maximum length of 256.

" + "smithy.api#documentation": "

Display name of the email recipient.

" } } }, @@ -16640,6 +16839,12 @@ "smithy.api#documentation": "

An empty value.

" } }, + "com.amazonaws.connect#EnableValueValidationOnAssociation": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.connect#EncryptionConfig": { "type": "structure", "members": { @@ -18601,6 +18806,12 @@ "traits": { "smithy.api#documentation": "

A list of expressions as a filter, in which an expression is an object of a step in a\n routing criteria.

" } + }, + "AgentStatuses": { + "target": "com.amazonaws.connect#AgentStatuses", + "traits": { + "smithy.api#documentation": "

A list of up to 50 agent status IDs or ARNs.

" + } } }, "traits": { @@ -18939,6 +19150,98 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#GetContactMetrics": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetContactMetricsRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetContactMetricsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the position of the contact in the queue.

\n

\n Use cases\n

\n

Following are common uses cases for position in queue:

\n
    \n
  • \n

    Understand the expected wait experience of a contact.

    \n
  • \n
  • \n

    Inform customers of their position in queue and potentially offer a callback.

    \n
  • \n
  • \n

    Make data-driven routing decisions between primary and alternative queues.

    \n
  • \n
  • \n

    Enhance queue visibility and leverage agent proficiencies to streamline contact\n routing.

    \n
  • \n
\n

\n Important things to know\n

\n
    \n
  • \n

    The only way to retrieve the position of the contact in queue is by using this API. You\n can't retrieve the position by using flows and attributes.

    \n
  • \n
  • \n

    For more information, see the Position in queue metric in\n the Amazon Connect Administrator Guide.

    \n
  • \n
\n

\n Endpoints: See Amazon Connect endpoints and\n quotas.

", + "smithy.api#http": { + "method": "POST", + "uri": "/metrics/contact", + "code": 200 + } + } + }, + "com.amazonaws.connect#GetContactMetricsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceIdOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#required": {} + } + }, + "ContactId": { + "target": "com.amazonaws.connect#InstanceIdOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

", + "smithy.api#required": {} + } + }, + "Metrics": { + "target": "com.amazonaws.connect#ContactMetrics", + "traits": { + "smithy.api#documentation": "

A list of contact-level metrics to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#GetContactMetricsResponse": { + "type": "structure", + "members": { + "MetricResults": { + "target": "com.amazonaws.connect#ContactMetricResults", + "traits": { + "smithy.api#documentation": "

A list of metric results containing the calculated values for each requested metric. Each\n result includes the metric name and its corresponding calculated value.

" + } + }, + "Id": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the contact for which metrics were retrieved.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the contact for which metrics were retrieved.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#GetCurrentMetricData": { "type": "operation", "input": { @@ -18965,7 +19268,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the real-time metric data from the specified Amazon Connect instance.

\n

For a description of each metric, see Metrics definitions in the\n Amazon Connect Administrator Guide.

", + "smithy.api#documentation": "

Gets the real-time metric data from the specified Amazon Connect instance.

\n

For a description of each metric, see Metrics definitions in the\n Amazon Connect Administrator Guide.

\n \n

When you make a successful API request, you can expect the following metric values in the\n response:

\n
    \n
  1. \n

    \n Metric value is null: The calculation cannot be\n performed due to divide by zero or insufficient data

    \n
  2. \n
  3. \n

    \n Metric value is a number (including 0) of defined type:\n The number provided is the calculation result

    \n
  4. \n
  5. \n

    \n MetricResult list is empty: The request cannot find any\n data in the system

    \n
  6. \n
\n

The following guidelines can help you work with the API:

\n
    \n
  • \n

    Each dimension in the metric response must contain a value

    \n
  • \n
  • \n

    Each item in MetricResult must include all requested metrics

    \n
  • \n
  • \n

    If the response is slow due to large result sets, try these approaches:

    \n
      \n
    • \n

      Add filters to reduce the amount of data returned

      \n
    • \n
    \n
  • \n
\n
", "smithy.api#http": { "method": "POST", "uri": "/metrics/current/{InstanceId}", @@ -18992,14 +19295,14 @@ "Filters": { "target": "com.amazonaws.connect#Filters", "traits": { - "smithy.api#documentation": "

The filters to apply to returned metrics. You can filter up to the following limits:

\n
    \n
  • \n

    Queues: 100

    \n
  • \n
  • \n

    Routing profiles: 100

    \n
  • \n
  • \n

    Channels: 3 (VOICE, CHAT, and TASK channels are supported.)

    \n
  • \n
  • \n

    RoutingStepExpressions: 50

    \n
  • \n
\n

Metric data is retrieved only for the resources associated with the queues or routing\n profiles, and by any channels included in the filter. (You cannot filter by both queue AND\n routing profile.) You can include both resource IDs and resource ARNs in the same request.

\n

When using the RoutingStepExpression filter, you need to pass exactly one\n QueueId. The filter is also case sensitive so when using the\n RoutingStepExpression filter, grouping by ROUTING_STEP_EXPRESSION is\n required.

\n

Currently tagging is only supported on the resources that are passed in the filter.

", + "smithy.api#documentation": "

The filters to apply to returned metrics. You can filter up to the following limits:

\n
    \n
  • \n

    Queues: 100

    \n
  • \n
  • \n

    Routing profiles: 100

    \n
  • \n
  • \n

    Channels: 3 (VOICE, CHAT, and TASK channels are supported.)

    \n
  • \n
  • \n

    RoutingStepExpressions: 50

    \n
  • \n
  • \n

    AgentStatuses: 50

    \n
  • \n
\n

Metric data is retrieved only for the resources associated with the queues or routing\n profiles, and by any channels included in the filter. (You cannot filter by both queue AND\n routing profile.) You can include both resource IDs and resource ARNs in the same request.

\n

When using AgentStatuses as filter make sure Queues is added as primary\n filter.

\n

When using the RoutingStepExpression filter, you need to pass exactly one\n QueueId. The filter is also case sensitive so when using the\n RoutingStepExpression filter, grouping by ROUTING_STEP_EXPRESSION is\n required.

\n

Currently tagging is only supported on the resources that are passed in the filter.

", "smithy.api#required": {} } }, "Groupings": { "target": "com.amazonaws.connect#Groupings", "traits": { - "smithy.api#documentation": "

The grouping applied to the metrics returned. For example, when grouped by\n QUEUE, the metrics returned apply to each queue rather than aggregated for all\n queues.

\n
    \n
  • \n

    If you group by CHANNEL, you should include a Channels filter.\n VOICE, CHAT, and TASK channels are supported.

    \n
  • \n
  • \n

    If you group by ROUTING_PROFILE, you must include either a queue or routing\n profile filter. In addition, a routing profile filter is required for metrics\n CONTACTS_SCHEDULED, CONTACTS_IN_QUEUE, and \n OLDEST_CONTACT_AGE.

    \n
  • \n
  • \n

    If no Grouping is included in the request, a summary of metrics is\n returned.

    \n
  • \n
  • \n

    When using the RoutingStepExpression filter, group by\n ROUTING_STEP_EXPRESSION is required.

    \n
  • \n
" + "smithy.api#documentation": "

Defines the level of aggregation for metrics data by a dimension(s). Its similar to sorting\n items into buckets based on a common characteristic, then counting or calculating something for\n each bucket. For example, when grouped by QUEUE, the metrics returned apply to each\n queue rather than aggregated for all queues.

\n

The grouping list is an ordered list, with the first item in the list defined as the primary\n grouping. If no grouping is included in the request, the aggregation happens at the\n instance-level.

\n
    \n
  • \n

    If you group by CHANNEL, you should include a Channels filter.\n VOICE, CHAT, and TASK channels are supported.

    \n
  • \n
  • \n

    If you group by AGENT_STATUS, you must include the QUEUE as the\n primary grouping and use queue filter. When you group by AGENT_STATUS, the only\n metric available is the AGENTS_ONLINE metric.

    \n
  • \n
  • \n

    If you group by ROUTING_PROFILE, you must include either a queue or routing\n profile filter. In addition, a routing profile filter is required for metrics\n CONTACTS_SCHEDULED, CONTACTS_IN_QUEUE, and \n OLDEST_CONTACT_AGE.

    \n
  • \n
  • \n

    When using the RoutingStepExpression filter, group by\n ROUTING_STEP_EXPRESSION is required.

    \n
  • \n
" } }, "CurrentMetrics": { @@ -19220,7 +19523,7 @@ "FromDate": { "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", "traits": { - "smithy.api#documentation": "

The Date from when the hours of operation are listed.

", + "smithy.api#documentation": "

The date from when the hours of operation are listed.

", "smithy.api#httpQuery": "fromDate", "smithy.api#required": {} } @@ -19228,7 +19531,7 @@ "ToDate": { "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", "traits": { - "smithy.api#documentation": "

The Date until when the hours of operation are listed.

", + "smithy.api#documentation": "

The date until when the hours of operation are listed.

", "smithy.api#httpQuery": "toDate", "smithy.api#required": {} } @@ -19244,7 +19547,7 @@ "EffectiveHoursOfOperationList": { "target": "com.amazonaws.connect#EffectiveHoursOfOperationList", "traits": { - "smithy.api#documentation": "

Information about the effective hours of operations

" + "smithy.api#documentation": "

Information about the effective hours of operations.

" } }, "TimeZone": { @@ -19518,7 +19821,7 @@ "HistoricalMetrics": { "target": "com.amazonaws.connect#HistoricalMetrics", "traits": { - "smithy.api#documentation": "

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The\n following historical metrics are available. For a description of each metric, see Metrics\n definition in the Amazon Connect Administrator Guide.

\n \n

This API does not support a contacts\n incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

\n
\n
\n
ABANDON_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
AFTER_CONTACT_WORK_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
API_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CALLBACK_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_AGENT_HUNG_UP_FIRST
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_CONSULTED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_INCOMING
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_OUTBOUND
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_MISSED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
HANDLE_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_AND_HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
OCCUPANCY
\n
\n

Unit: PERCENT

\n

Statistic: AVG

\n
\n
QUEUE_ANSWER_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
QUEUED_TIME
\n
\n

Unit: SECONDS

\n

Statistic: MAX

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: PERCENT

\n

Statistic: AVG

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
", + "smithy.api#documentation": "

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The\n following historical metrics are available. For a description of each metric, see Metrics\n definition in the Amazon Connect Administrator Guide.

\n \n

This API does not support a contacts\n incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

\n
\n
\n
ABANDON_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n

UI name: Average\n queue abandon time\n

\n
\n
AFTER_CONTACT_WORK_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n

UI name: After\n contact work time\n

\n
\n
API_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: API contacts\n handled\n

\n
\n
AVG_HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n

UI name: Average\n customer hold time\n

\n
\n
CALLBACK_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Callback\n contacts handled\n

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n abandoned\n

\n
\n
CONTACTS_AGENT_HUNG_UP_FIRST
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts agent hung up first\n

\n
\n
CONTACTS_CONSULTED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n consulted\n

\n
\n
CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n handled\n

\n
\n
CONTACTS_HANDLED_INCOMING
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n handled incoming\n

\n
\n
CONTACTS_HANDLED_OUTBOUND
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n handled outbound\n

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n hold disconnect\n

\n
\n
CONTACTS_MISSED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: AGENT_NON_RESPONSE\n

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n queued\n

\n
\n
CONTACTS_TRANSFERRED_IN
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n transferred in\n

\n
\n
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts transferred out queue\n

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n transferred out\n

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts transferred out queue\n

\n
\n
HANDLE_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n

UI name: Average handle\n time\n

\n
\n
INTERACTION_AND_HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n

UI name: Average agent interaction and customer hold time\n

\n
\n
INTERACTION_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n

UI name: Average agent interaction time\n

\n
\n
OCCUPANCY
\n
\n

Unit: PERCENT

\n

Statistic: AVG

\n

UI name: Occupancy\n

\n
\n
QUEUE_ANSWER_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n

UI name: Average\n queue answer time\n

\n
\n
QUEUED_TIME
\n
\n

Unit: SECONDS

\n

Statistic: MAX

\n

UI name: Minimum flow\n time\n

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: PERCENT

\n

Statistic: AVG

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n

UI name: Average\n queue abandon time\n

\n
\n
", "smithy.api#required": {} } }, @@ -19585,7 +19888,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets metric data from the specified Amazon Connect instance.

\n

\n GetMetricDataV2 offers more features than GetMetricData, the previous\n version of this API. It has new metrics, offers filtering at a metric level, and offers the\n ability to filter and group data by channels, queues, routing profiles, agents, and agent\n hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It\n does not support agent queues.

\n

For a description of the historical metrics that are supported by\n GetMetricDataV2 and GetMetricData, see Metrics definitions in the\n Amazon Connect Administrator Guide.

", + "smithy.api#documentation": "

Gets metric data from the specified Amazon Connect instance.

\n

\n GetMetricDataV2 offers more features than GetMetricData, the previous\n version of this API. It has new metrics, offers filtering at a metric level, and offers the\n ability to filter and group data by channels, queues, routing profiles, agents, and agent\n hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It\n does not support agent queues.

\n

For a description of the historical metrics that are supported by\n GetMetricDataV2 and GetMetricData, see Metrics definitions in the\n Amazon Connect Administrator Guide.

\n \n

When you make a successful API request, you can expect the following metric values in the\n response:

\n
    \n
  1. \n

    \n Metric value is null: The calculation cannot be\n performed due to divide by zero or insufficient data

    \n
  2. \n
  3. \n

    \n Metric value is a number (including 0) of defined type:\n The number provided is the calculation result

    \n
  4. \n
  5. \n

    \n MetricResult list is empty: The request cannot find any\n data in the system

    \n
  6. \n
\n

The following guidelines can help you work with the API:

\n
    \n
  • \n

    Each dimension in the metric response must contain a value

    \n
  • \n
  • \n

    Each item in MetricResult must include all requested metrics

    \n
  • \n
  • \n

    If the response is slow due to large result sets, try these approaches:

    \n
      \n
    • \n

      Narrow the time range of your request

      \n
    • \n
    • \n

      Add filters to reduce the amount of data returned

      \n
    • \n
    \n
  • \n
\n
", "smithy.api#http": { "method": "POST", "uri": "/metrics/data", @@ -19644,7 +19947,7 @@ "Metrics": { "target": "com.amazonaws.connect#MetricsV2", "traits": { - "smithy.api#documentation": "

The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Metrics\n definition in the Amazon Connect Administrator Guide.

\n
\n
ABANDONMENT_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Abandonment\n rate\n

\n
\n
AGENT_ADHERENT_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Adherent time\n

\n
\n
AGENT_ANSWER_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent answer\n rate\n

\n
\n
AGENT_NON_ADHERENT_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Non-adherent\n time\n

\n
\n
AGENT_NON_RESPONSE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent\n non-response\n

\n
\n
AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

Data for this metric is available starting from October 1, 2023 0:00:00 GMT.

\n

UI name: Agent non-response without customer abandons\n

\n
\n
AGENT_OCCUPANCY
\n
\n

Unit: Percentage

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Occupancy\n

\n
\n
AGENT_SCHEDULE_ADHERENCE
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Adherence\n

\n
\n
AGENT_SCHEDULED_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Scheduled\n time\n

\n
\n
AVG_ABANDON_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n queue abandon time\n

\n
\n
AVG_ACTIVE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Average active\n time\n

\n
\n
AVG_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n after contact work time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_AGENT_CONNECTING_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Average agent API connecting time\n

\n \n

The Negate key in metric-level filters is not applicable for this\n metric.

\n
\n
\n
AVG_AGENT_PAUSE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Average\n agent pause time\n

\n
\n
AVG_BOT_CONVERSATION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID

\n

UI name: Average bot\n conversation time\n

\n
\n
AVG_BOT_CONVERSATION_TURNS
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID

\n

UI name: Average bot\n conversation turns\n

\n
\n
AVG_CASE_RELATED_CONTACTS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Average\n contacts per case\n

\n
\n
AVG_CASE_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Average\n case resolution time\n

\n
\n
AVG_CONTACT_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n contact duration\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_CONVERSATION_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average conversation duration\n

\n
\n
AVG_DIALS_PER_MINUTE
\n
\n

This metric is available only for outbound campaigns that use the agent assisted voice\n and automated voice delivery modes.

\n

Unit: Count

\n

Valid groupings and filters: Agent, Campaign, Queue, Routing Profile

\n

UI name: Average\n dials per minute\n

\n
\n
AVG_EVALUATION_SCORE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID,\n Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile

\n

UI name: Average\n evaluation score\n

\n
\n
AVG_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Average flow\n time\n

\n
\n
AVG_GREETING_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n agent greeting time\n

\n
\n
AVG_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression

\n

UI name: Average handle\n time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n customer hold time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_HOLD_TIME_ALL_CONTACTS
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average customer hold time all contacts\n

\n
\n
AVG_HOLDS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average holds\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent interaction and customer hold time\n

\n
\n
AVG_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent interaction time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_INTERRUPTIONS_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n agent interruptions\n

\n
\n
AVG_INTERRUPTION_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent interruption time\n

\n
\n
AVG_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n non-talk time\n

\n
\n
AVG_QUEUE_ANSWER_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n queue answer time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

UI name: Average\n resolution time\n

\n
\n
AVG_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average talk\n time\n

\n
\n
AVG_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n agent talk time\n

\n
\n
AVG_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n customer talk time\n

\n
\n
AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION
\n
\n

This metric is available only for outbound campaigns that use the agent assisted voice\n and automated voice delivery modes.

\n

Unit: Seconds

\n

Valid groupings and filters: Campaign

\n

UI name: Average wait time after customer connection\n

\n
\n
AVG_WEIGHTED_EVALUATION_SCORE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID,\n Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile

\n

UI name: Average weighted evaluation score\n

\n
\n
BOT_CONVERSATIONS_COMPLETED
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID

\n

UI name: Bot\n conversations completed\n

\n
\n
BOT_INTENTS_COMPLETED
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type,\n Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource\n type, Parent flows resource ID

\n

UI name: Bot intents\n completed\n

\n
\n
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X
\n
\n

This metric is available only for outbound campaigns using the agent assisted voice and\n automated voice delivery modes.

\n

Unit: Count

\n

Valid groupings and filters: Agent, Campaign

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter GT (for\n Greater than).

\n

UI name: Campaign contacts abandoned after X\n

\n
\n
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE
\n
\n

This metric is available only for outbound campaigns using the agent assisted voice and\n automated voice delivery modes.

\n

Unit: Percent

\n

Valid groupings and filters: Agent, Campaign

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter GT (for\n Greater than).

\n

UI name: Campaign contacts abandoned after X rate\n

\n
\n
CAMPAIGN_INTERACTIONS
\n
\n

This metric is available only for outbound campaigns using the email delivery mode.

\n

Unit: Count

\n

Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE

\n

Valid groupings and filters: Campaign

\n

UI name: Campaign\n interactions\n

\n
\n
CAMPAIGN_PROGRESS_RATE
\n
\n

This metric is only available for outbound campaigns initiated using a customer segment.\n It is not available for event triggered campaigns.

\n

Unit: Percent

\n

Valid groupings and filters: Campaign, Campaign Execution Timestamp

\n

UI name: Campaign\n progress rate\n

\n
\n
CAMPAIGN_SEND_ATTEMPTS
\n
\n

This metric is available only for outbound campaigns.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype

\n

UI name: Campaign send\n attempts\n

\n
\n
CAMPAIGN_SEND_EXCLUSIONS
\n
\n

This metric is available only for outbound campaigns.

\n

Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution\n Timestamp

\n

UI name: Campaign\n send exclusions\n

\n
\n
CASES_CREATED
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases created\n

\n
\n
CONTACTS_CREATED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts\n created\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
CONTACTS_HANDLED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect

\n

UI name: API contacts\n handled\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts handled (connected to agent timestamp)\n

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts\n hold disconnect\n

\n
\n
CONTACTS_ON_HOLD_AGENT_DISCONNECT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts hold agent disconnect\n

\n
\n
CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts hold customer disconnect\n

\n
\n
CONTACTS_PUT_ON_HOLD
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts put on\n hold\n

\n
\n
CONTACTS_TRANSFERRED_OUT_EXTERNAL
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts transferred out external\n

\n
\n
CONTACTS_TRANSFERRED_OUT_INTERNAL
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts transferred out internal\n

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts\n queued\n

\n
\n
CONTACTS_QUEUED_BY_ENQUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n

UI name: Contacts\n queued (enqueue timestamp)\n

\n
\n
CONTACTS_REMOVED_FROM_QUEUE_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts\n removed from queue in X seconds\n

\n
\n
CONTACTS_RESOLVED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts resolved\n in X\n

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts\n transferred out\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
CONTACTS_TRANSFERRED_OUT_BY_AGENT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts transferred out by agent\n

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts transferred out queue\n

\n
\n
CURRENT_CASES
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Current cases\n

\n
\n
DELIVERY_ATTEMPTS
\n
\n

This metric is available only for outbound campaigns.

\n

Unit: Count

\n

Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS,\n CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON\n

\n

Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery\n EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue,\n Routing Profile

\n

UI name: Delivery\n attempts\n

\n \n

Campaign Delivery EventType filter and grouping are only available for SMS and Email\n campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status\n and Disconnect Reason are only available for agent assisted voice and automated voice\n delivery modes.

\n
\n
\n
DELIVERY_ATTEMPT_DISPOSITION_RATE
\n
\n

This metric is available only for outbound campaigns. Dispositions for the agent assisted\n voice and automated voice delivery modes are only available with answering machine detection\n enabled.

\n

Unit: Percent

\n

Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS,\n CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON\n

\n

Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel,\n contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile

\n

UI name: Delivery attempt disposition rate\n

\n \n

Campaign Delivery Event Type filter and grouping are only available for SMS and Email\n campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status\n and Disconnect Reason are only available for agent assisted voice and automated voice\n delivery modes.

\n
\n
\n
EVALUATIONS_PERFORMED
\n
\n

Unit: Count

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form\n Version, Queue, Routing Profile

\n

UI name: Evaluations\n performed\n

\n
\n
FLOWS_OUTCOME
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows\n outcome\n

\n
\n
FLOWS_STARTED
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows\n started\n

\n
\n
HUMAN_ANSWERED_CALLS
\n
\n

This metric is available only for outbound campaigns. Dispositions for the agent assisted\n voice and automated voice delivery modes are only available with answering machine detection\n enabled.

\n

Unit: Count

\n

Valid groupings and filters: Agent, Campaign

\n

UI name: Human\n answered\n

\n
\n
MAX_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Maximum flow\n time\n

\n
\n
MAX_QUEUED_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Maximum queued\n time\n

\n
\n
MIN_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Minimum flow\n time\n

\n
\n
PERCENT_AUTOMATIC_FAILS
\n
\n

Unit: Percent

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form\n Version, Queue, Routing Profile

\n

UI name: Automatic\n fails percent\n

\n
\n
PERCENT_BOT_CONVERSATIONS_OUTCOME
\n
\n

Unit: Percent

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID

\n

UI name: Percent\n bot conversations outcome\n

\n
\n
PERCENT_BOT_INTENTS_OUTCOME
\n
\n

Unit: Percent

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type,\n Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource\n type, Parent flows resource ID

\n

UI name: Percent bot\n intents outcome\n

\n
\n
PERCENT_CASES_FIRST_CONTACT_RESOLVED
\n
\n

Unit: Percent

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases resolved on first contact\n

\n
\n
PERCENT_CONTACTS_STEP_EXPIRED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
PERCENT_CONTACTS_STEP_JOINED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
PERCENT_FLOWS_OUTCOME
\n
\n

Unit: Percent

\n

Valid metric filter key: FLOWS_OUTCOME_TYPE\n

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows\n outcome percentage.

\n \n

The FLOWS_OUTCOME_TYPE is not a valid grouping.

\n
\n
\n
PERCENT_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Non-talk time\n percent\n

\n
\n
PERCENT_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Talk time\n percent\n

\n
\n
PERCENT_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Agent talk\n time percent\n

\n
\n
PERCENT_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Customer\n talk time percent\n

\n
\n
RECIPIENTS_ATTEMPTED
\n
\n

This metric is only available for outbound campaigns initiated using a customer segment.\n It is not available for event triggered campaigns.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Campaign Execution Timestamp

\n

UI name: Recipients\n attempted\n

\n
\n
RECIPIENTS_INTERACTED
\n
\n

This metric is only available for outbound campaigns initiated using a customer segment.\n It is not available for event triggered campaigns.

\n

Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Channel,\n contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp

\n

UI name: Recipients\n interacted\n

\n
\n
RECIPIENTS_TARGETED
\n
\n

This metric is only available for outbound campaigns initiated using a customer segment.\n It is not available for event triggered campaigns.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Campaign Execution Timestamp

\n

UI name: Recipients\n targeted\n

\n
\n
REOPENED_CASE_ACTIONS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases\n reopened\n

\n
\n
RESOLVED_CASE_ACTIONS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases\n resolved\n

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Service level\n X\n

\n
\n
STEP_CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
SUM_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: After\n contact work time\n

\n
\n
SUM_CONNECTING_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. This metric only supports the\n following filter keys as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent API\n connecting time\n

\n \n

The Negate key in metric-level filters is not applicable for this\n metric.

\n
\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: Count

\n

Metric filter:

\n
    \n
  • \n

    Valid values: API| Incoming | Outbound |\n Transfer | Callback | Queue_Transfer|\n Disconnect\n

    \n
  • \n
\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect

\n

UI name: Contact\n abandoned\n

\n
\n
SUM_CONTACTS_ABANDONED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts abandoned in X seconds\n

\n
\n
SUM_CONTACTS_ANSWERED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts answered in X seconds\n

\n
\n
SUM_CONTACT_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contact flow\n time\n

\n
\n
SUM_CONTACT_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent on\n contact time\n

\n
\n
SUM_CONTACTS_DISCONNECTED
\n
\n

Valid metric filter key: DISCONNECT_REASON\n

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contact\n disconnected\n

\n
\n
SUM_ERROR_STATUS_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Error status\n time\n

\n
\n
SUM_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contact handle\n time\n

\n
\n
SUM_HOLD_TIME
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Customer hold\n time\n

\n
\n
SUM_IDLE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent idle\n time\n

\n
\n
SUM_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Agent interaction and hold time\n

\n
\n
SUM_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent\n interaction time\n

\n
\n
SUM_NON_PRODUCTIVE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent\n non-productive time\n

\n
\n
SUM_ONLINE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Online time\n

\n
\n
SUM_RETRY_CALLBACK_ATTEMPTS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

UI name: Callback\n attempts\n

\n
\n
", + "smithy.api#documentation": "

The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Metrics\n definition in the Amazon Connect Administrator Guide.

\n
\n
ABANDONMENT_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Abandonment\n rate\n

\n
\n
AGENT_ADHERENT_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Adherent time\n

\n
\n
AGENT_ANSWER_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent answer\n rate\n

\n
\n
AGENT_NON_ADHERENT_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Non-adherent\n time\n

\n
\n
AGENT_NON_RESPONSE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent\n non-response\n

\n
\n
AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

Data for this metric is available starting from October 1, 2023 0:00:00 GMT.

\n

UI name: Agent non-response without customer abandons\n

\n
\n
AGENT_OCCUPANCY
\n
\n

Unit: Percentage

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Occupancy\n

\n
\n
AGENT_SCHEDULE_ADHERENCE
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Adherence\n

\n
\n
AGENT_SCHEDULED_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Scheduled\n time\n

\n
\n
AVG_ABANDON_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

Valid metric filter key: INITIATION_METHOD\n

\n

UI name: Average\n queue abandon time\n

\n
\n
AVG_ACTIVE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Average active\n time\n

\n
\n
AVG_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n after contact work time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_AGENT_CONNECTING_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Average agent API connecting time\n

\n \n

The Negate key in metric-level filters is not applicable for this\n metric.

\n
\n
\n
AVG_AGENT_PAUSE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Average\n agent pause time\n

\n
\n
AVG_BOT_CONVERSATION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID

\n

UI name: Average bot\n conversation time\n

\n
\n
AVG_BOT_CONVERSATION_TURNS
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID

\n

UI name: Average bot\n conversation turns\n

\n
\n
AVG_CASE_RELATED_CONTACTS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Average\n contacts per case\n

\n
\n
AVG_CASE_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Average\n case resolution time\n

\n
\n
AVG_CONTACT_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n contact duration\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_CONTACT_FIRST_RESPONSE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,\n Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,\n Q in Connect

\n

UI name: Agent average contact first response wait time\n

\n
\n
AVG_CONVERSATION_CLOSE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,\n Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,\n Q in Connect

\n

UI name: Average conversation close time\n

\n
\n
AVG_CONVERSATION_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average conversation duration\n

\n
\n
AVG_DIALS_PER_MINUTE
\n
\n

This metric is available only for outbound campaigns that use the agent assisted voice\n and automated voice delivery modes.

\n

Unit: Count

\n

Valid groupings and filters: Agent, Campaign, Queue, Routing Profile

\n

UI name: Average\n dials per minute\n

\n
\n
AVG_EVALUATION_SCORE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID,\n Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile

\n

UI name: Average\n evaluation score\n

\n
\n
AVG_FIRST_RESPONSE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,\n Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,\n Q in Connect

\n

UI name: Average agent first response time\n

\n
\n
AVG_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Average flow\n time\n

\n
\n
AVG_GREETING_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n agent greeting time\n

\n
\n
AVG_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression

\n

UI name: Average handle\n time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n customer hold time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_HOLD_TIME_ALL_CONTACTS
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average customer hold time all contacts\n

\n
\n
AVG_HOLDS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average holds\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent interaction and customer hold time\n

\n
\n
AVG_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent interaction time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_INTERRUPTIONS_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n agent interruptions\n

\n
\n
AVG_INTERRUPTION_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent interruption time\n

\n
\n
AVG_MESSAGE_LENGTH_AGENT
\n
\n

Unit: Count

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,\n Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,\n Q in Connect

\n

UI name: Average\n agent message length\n

\n
\n
AVG_MESSAGE_LENGTH_CUSTOMER
\n
\n

Unit: Count

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,\n Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,\n Q in Connect

\n

UI name: Average customer message length\n

\n
\n
AVG_MESSAGES
\n
\n

Unit: Count

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,\n Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,\n Q in Connect

\n

UI name: Average\n messages\n

\n
\n
AVG_MESSAGES_AGENT
\n
\n

Unit: Count

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,\n Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,\n Q in Connect

\n

UI name: Average agent\n messages\n

\n
\n
AVG_MESSAGES_BOT
\n
\n

Unit: Count

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,\n Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,\n Q in Connect

\n

UI name: Average bot\n messages\n

\n
\n
AVG_MESSAGES_CUSTOMER
\n
\n

Unit: Count

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,\n Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,\n Q in Connect

\n

UI name: Average\n customer messages\n

\n
\n
AVG_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n non-talk time\n

\n
\n
AVG_QUEUE_ANSWER_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n queue answer time\n

\n

Valid metric level filters: INITIATION_METHOD, FEATURE,\n DISCONNECT_REASON\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_QUEUE_ANSWER_TIME_CUSTOMER_FIRST_CALLBACK
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect, Agent Hierarchy

\n

UI name: Avg. queue answer time - customer first callback\n

\n
\n
AVG_RESPONSE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,\n Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,\n Q in Connect

\n

UI name: Average\n agent response time\n

\n
\n
AVG_RESPONSE_TIME_CUSTOMER
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,\n Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,\n Q in Connect

\n

UI name: Average\n customer response time\n

\n
\n
AVG_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

UI name: Average\n resolution time\n

\n
\n
AVG_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average talk\n time\n

\n
\n
AVG_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n agent talk time\n

\n
\n
AVG_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average\n customer talk time\n

\n
\n
AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION
\n
\n

This metric is available only for outbound campaigns that use the agent assisted voice\n and automated voice delivery modes.

\n

Unit: Seconds

\n

Valid groupings and filters: Campaign

\n

UI name: Average wait time after customer connection\n

\n
\n
AVG_WAIT_TIME_AFTER_CUSTOMER_FIRST_CALLBACK_CONNECTION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect, Agent Hierarchy

\n

UI name: Avg. wait time after customer connection - customer first callback\n

\n
\n
AVG_WEIGHTED_EVALUATION_SCORE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID,\n Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile

\n

UI name: Average weighted evaluation score\n

\n
\n
BOT_CONVERSATIONS_COMPLETED
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID

\n

UI name: Bot\n conversations completed\n

\n
\n
BOT_INTENTS_COMPLETED
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type,\n Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource\n type, Parent flows resource ID

\n

UI name: Bot intents\n completed\n

\n
\n
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X
\n
\n

This metric is available only for outbound campaigns using the agent assisted voice and\n automated voice delivery modes.

\n

Unit: Count

\n

Valid groupings and filters: Agent, Campaign

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter GT (for\n Greater than).

\n

UI name: Campaign contacts abandoned after X\n

\n
\n
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE
\n
\n

This metric is available only for outbound campaigns using the agent assisted voice and\n automated voice delivery modes.

\n

Unit: Percent

\n

Valid groupings and filters: Agent, Campaign

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter GT (for\n Greater than).

\n

UI name: Campaign contacts abandoned after X rate\n

\n
\n
CAMPAIGN_INTERACTIONS
\n
\n

This metric is available only for outbound campaigns using the email delivery mode.

\n

Unit: Count

\n

Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE

\n

Valid groupings and filters: Campaign

\n

UI name: Campaign\n interactions\n

\n
\n
CAMPAIGN_PROGRESS_RATE
\n
\n

This metric is only available for outbound campaigns initiated using a customer segment.\n It is not available for event triggered campaigns.

\n

Unit: Percent

\n

Valid groupings and filters: Campaign, Campaign Execution Timestamp

\n

UI name: Campaign\n progress rate\n

\n
\n
CAMPAIGN_SEND_ATTEMPTS
\n
\n

This metric is available only for outbound campaigns.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype

\n

UI name: Campaign send\n attempts\n

\n
\n
CAMPAIGN_SEND_EXCLUSIONS
\n
\n

This metric is available only for outbound campaigns.

\n

Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution\n Timestamp

\n

UI name: Campaign\n send exclusions\n

\n
\n
CASES_CREATED
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases created\n

\n
\n
CONTACTS_CREATED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts\n created\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
CONTACTS_HANDLED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect

\n

UI name: Contacts\n handled\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts handled (connected to agent timestamp)\n

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts\n hold disconnect\n

\n
\n
CONTACTS_ON_HOLD_AGENT_DISCONNECT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts hold agent disconnect\n

\n
\n
CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts hold customer disconnect\n

\n
\n
CONTACTS_PUT_ON_HOLD
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts put on\n hold\n

\n
\n
CONTACTS_TRANSFERRED_OUT_EXTERNAL
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts transferred out external\n

\n
\n
CONTACTS_TRANSFERRED_OUT_INTERNAL
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts transferred out internal\n

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts\n queued\n

\n
\n
CONTACTS_QUEUED_BY_ENQUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n

UI name: Contacts\n queued (enqueue timestamp)\n

\n
\n
CONTACTS_REMOVED_FROM_QUEUE_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts\n removed from queue in X seconds\n

\n
\n
CONTACTS_RESOLVED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts resolved\n in X\n

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts\n transferred out\n

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
CONTACTS_TRANSFERRED_OUT_BY_AGENT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts transferred out by agent\n

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts transferred out queue\n

\n
\n
CURRENT_CASES
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Current cases\n

\n
\n
CONVERSATIONS_ABANDONED
\n
\n

Unit: Count

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,\n Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,\n Q in Connect

\n

UI name: Conversations abandoned\n

\n
\n
DELIVERY_ATTEMPTS
\n
\n

This metric is available only for outbound campaigns.

\n

Unit: Count

\n

Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS,\n CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON\n

\n

Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery\n EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue,\n Routing Profile

\n

UI name: Delivery\n attempts\n

\n \n

Campaign Delivery EventType filter and grouping are only available for SMS and Email\n campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status\n and Disconnect Reason are only available for agent assisted voice and automated voice\n delivery modes.

\n
\n
\n
DELIVERY_ATTEMPT_DISPOSITION_RATE
\n
\n

This metric is available only for outbound campaigns. Dispositions for the agent assisted\n voice and automated voice delivery modes are only available with answering machine detection\n enabled.

\n

Unit: Percent

\n

Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS,\n CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON\n

\n

Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel,\n contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile

\n

UI name: Delivery attempt disposition rate\n

\n \n

Campaign Delivery Event Type filter and grouping are only available for SMS and Email\n campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status\n and Disconnect Reason are only available for agent assisted voice and automated voice\n delivery modes.

\n
\n
\n
EVALUATIONS_PERFORMED
\n
\n

Unit: Count

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form\n Version, Queue, Routing Profile

\n

UI name: Evaluations\n performed\n

\n
\n
FLOWS_OUTCOME
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows\n outcome\n

\n
\n
FLOWS_STARTED
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows\n started\n

\n
\n
HUMAN_ANSWERED_CALLS
\n
\n

This metric is available only for outbound campaigns. Dispositions for the agent assisted\n voice and automated voice delivery modes are only available with answering machine detection\n enabled.

\n

Unit: Count

\n

Valid groupings and filters: Agent, Campaign

\n

UI name: Human\n answered\n

\n
\n
MAX_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Maximum flow\n time\n

\n
\n
MAX_QUEUED_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Maximum queued\n time\n

\n
\n
MIN_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Minimum flow\n time\n

\n
\n
PERCENT_AUTOMATIC_FAILS
\n
\n

Unit: Percent

\n

Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form\n Version, Queue, Routing Profile

\n

UI name: Automatic\n fails percent\n

\n
\n
PERCENT_BOT_CONVERSATIONS_OUTCOME
\n
\n

Unit: Percent

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID

\n

UI name: Percent\n bot conversations outcome\n

\n
\n
PERCENT_BOT_INTENTS_OUTCOME
\n
\n

Unit: Percent

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type,\n Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource\n type, Parent flows resource ID

\n

UI name: Percent bot\n intents outcome\n

\n
\n
PERCENT_CASES_FIRST_CONTACT_RESOLVED
\n
\n

Unit: Percent

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases resolved on first contact\n

\n
\n
PERCENT_CONTACTS_STEP_EXPIRED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
PERCENT_CONTACTS_STEP_JOINED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
PERCENT_FLOWS_OUTCOME
\n
\n

Unit: Percent

\n

Valid metric filter key: FLOWS_OUTCOME_TYPE\n

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows\n outcome percentage.

\n \n

The FLOWS_OUTCOME_TYPE is not a valid grouping.

\n
\n
\n
PERCENT_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Non-talk time\n percent\n

\n
\n
PERCENT_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Talk time\n percent\n

\n
\n
PERCENT_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Agent talk\n time percent\n

\n
\n
PERCENT_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Customer\n talk time percent\n

\n
\n
RECIPIENTS_ATTEMPTED
\n
\n

This metric is only available for outbound campaigns initiated using a customer segment.\n It is not available for event triggered campaigns.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Campaign Execution Timestamp

\n

UI name: Recipients\n attempted\n

\n
\n
RECIPIENTS_INTERACTED
\n
\n

This metric is only available for outbound campaigns initiated using a customer segment.\n It is not available for event triggered campaigns.

\n

Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Channel,\n contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp

\n

UI name: Recipients\n interacted\n

\n
\n
RECIPIENTS_TARGETED
\n
\n

This metric is only available for outbound campaigns initiated using a customer segment.\n It is not available for event triggered campaigns.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Campaign Execution Timestamp

\n

UI name: Recipients\n targeted\n

\n
\n
REOPENED_CASE_ACTIONS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases\n reopened\n

\n
\n
RESOLVED_CASE_ACTIONS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases\n resolved\n

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Service level\n X\n

\n
\n
STEP_CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
SUM_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: After\n contact work time\n

\n
\n
SUM_CONNECTING_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. This metric only supports the\n following filter keys as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API |\n CALLBACK_CUSTOMER_FIRST_DIALED\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent API\n connecting time\n

\n \n

The Negate key in metric-level filters is not applicable for this\n metric.

\n
\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: Count

\n

Metric filter:

\n
    \n
  • \n

    Valid values: API| INCOMING | OUTBOUND |\n TRANSFER | CALLBACK | QUEUE_TRANSFER|\n Disconnect | CALLBACK_CUSTOMER_FIRST_DIALED\n

    \n
  • \n
\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect

\n

UI name: Contact\n abandoned\n

\n
\n
SUM_CONTACTS_ABANDONED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts abandoned in X seconds\n

\n
\n
SUM_CONTACTS_ANSWERED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts answered in X seconds\n

\n
\n
SUM_CONTACT_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contact flow\n time\n

\n
\n
SUM_CONTACT_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent on\n contact time\n

\n
\n
SUM_CONTACTS_DISCONNECTED
\n
\n

Valid metric filter key: DISCONNECT_REASON\n

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contact\n disconnected\n

\n
\n
SUM_ERROR_STATUS_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Error status\n time\n

\n
\n
SUM_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contact handle\n time\n

\n
\n
SUM_HOLD_TIME
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Customer hold\n time\n

\n
\n
SUM_IDLE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent idle\n time\n

\n
\n
SUM_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Agent interaction and hold time\n

\n
\n
SUM_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent\n interaction time\n

\n
\n
SUM_NON_PRODUCTIVE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent\n non-productive time\n

\n
\n
SUM_ONLINE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Online time\n

\n
\n
SUM_RETRY_CALLBACK_ATTEMPTS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

UI name: Callback\n attempts\n

\n
\n
", "smithy.api#required": {} } }, @@ -19879,7 +20182,7 @@ "SelfAssignFlowId": { "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

ContactFlowId for the flow that will be run if this template is used to create a\n self-assigned task

" + "smithy.api#documentation": "

The ContactFlowId for the flow that will be run if this template is used to create a\n self-assigned task.

" } }, "Constraints": { @@ -20052,6 +20355,12 @@ "traits": { "smithy.api#enumValue": "ROUTING_STEP_EXPRESSION" } + }, + "AGENT_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_STATUS" + } } } }, @@ -20527,7 +20836,7 @@ "Name": { "target": "com.amazonaws.connect#HistoricalMetricName", "traits": { - "smithy.api#documentation": "

The name of the metric.

" + "smithy.api#documentation": "

The name of the metric. Following is a list of each supported metric mapped to the UI name,\n linked to a detailed description in the Amazon Connect Administrator\n Guide.

\n
\n
ABANDON_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n

UI name: Average\n queue abandon time\n

\n
\n
AFTER_CONTACT_WORK_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n

UI name: After\n contact work time\n

\n
\n
API_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: API contacts\n handled\n

\n
\n
AVG_HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n

UI name: Average\n customer hold time\n

\n
\n
CALLBACK_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Callback\n contacts handled\n

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n abandoned\n

\n
\n
CONTACTS_AGENT_HUNG_UP_FIRST
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts agent hung up first\n

\n
\n
CONTACTS_CONSULTED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n consulted\n

\n
\n
CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n handled\n

\n
\n
CONTACTS_HANDLED_INCOMING
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n handled incoming\n

\n
\n
CONTACTS_HANDLED_OUTBOUND
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n handled outbound\n

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n hold disconnect\n

\n
\n
CONTACTS_MISSED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: AGENT_NON_RESPONSE\n

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n queued\n

\n
\n
CONTACTS_TRANSFERRED_IN
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n transferred in\n

\n
\n
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts transferred out queue\n

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts\n transferred out\n

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n

UI name: Contacts transferred out queue\n

\n
\n
HANDLE_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n

UI name: Average handle\n time\n

\n
\n
INTERACTION_AND_HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n

UI name: Average agent interaction and customer hold time\n

\n
\n
INTERACTION_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n

UI name: Average agent interaction time\n

\n
\n
OCCUPANCY
\n
\n

Unit: PERCENT

\n

Statistic: AVG

\n

UI name: Occupancy\n

\n
\n
QUEUE_ANSWER_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n

UI name: Average\n queue answer time\n

\n
\n
QUEUED_TIME
\n
\n

Unit: SECONDS

\n

Statistic: MAX

\n

UI name: Minimum flow\n time\n

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: PERCENT

\n

Statistic: AVG

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n

UI name: Service level\n X\n

\n
\n
" } }, "Threshold": { @@ -20550,7 +20859,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about a historical metric. For a description of each metric, see Metrics\n definitions in the Amazon Connect Administrator Guide.

" + "smithy.api#documentation": "

Contains information about a historical metric.

" } }, "com.amazonaws.connect#HistoricalMetricData": { @@ -21008,7 +21317,7 @@ "EffectiveTill": { "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", "traits": { - "smithy.api#documentation": "

The date till which the hours of operation override would be effective.

" + "smithy.api#documentation": "

The date until the hours of operation override is effective.

" } } }, @@ -21266,7 +21575,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports a claimed phone number from an external service, such as Amazon Web Services End User\n Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.

\n \n

Call the DescribePhoneNumber API\n to verify the status of a previous ImportPhoneNumber operation.

\n
\n

If you plan to claim or import numbers and then release numbers frequently, contact us for a\n service quota exception. Otherwise, it is possible you will be blocked from claiming and\n releasing any more numbers until up to 180 days past the oldest number released has expired.

\n

By default you can claim or import and then release up to 200% of your maximum number of\n active phone numbers. If you claim or import and then release phone numbers using the UI or API\n during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you\n will be blocked from claiming or importing any more numbers until 180 days past the oldest number\n released has expired.

\n

For example, if you already have 99 claimed or imported numbers and a service level quota of\n 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you\n will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers\n until you open an Amazon Web ServicesSupport ticket.

", + "smithy.api#documentation": "

Imports a claimed phone number from an external service, such as Amazon Web Services End User\n Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.

\n \n

Call the DescribePhoneNumber API\n to verify the status of a previous ImportPhoneNumber operation.

\n
\n

If you plan to claim or import numbers and then release numbers frequently, contact us for a\n service quota exception. Otherwise, it is possible you will be blocked from claiming and\n releasing any more numbers until up to 180 days past the oldest number released has expired.

\n

By default you can claim or import and then release up to 200% of your maximum number of\n active phone numbers. If you claim or import and then release phone numbers using the UI or API\n during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you\n will be blocked from claiming or importing any more numbers until 180 days past the oldest number\n released has expired.

\n

For example, if you already have 99 claimed or imported numbers and a service level quota of\n 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you\n will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers\n until you open an Amazon Web Services Support ticket.

", "smithy.api#http": { "method": "POST", "uri": "/phone-number/import", @@ -21467,6 +21776,21 @@ "target": "com.amazonaws.connect#ContactInitiationMethod" } }, + "com.amazonaws.connect#InputPredefinedAttributeConfiguration": { + "type": "structure", + "members": { + "EnableValueValidationOnAssociation": { + "target": "com.amazonaws.connect#EnableValueValidationOnAssociation", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When this parameter is set to true, Amazon Connect enforces strict validation on the\n specific values, if the values are predefined in attributes. The contact will store only valid\n and predefined values for the predefined attribute key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Custom metadata that is associated to predefined attributes to control behavior in upstream\n services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.

" + } + }, "com.amazonaws.connect#Instance": { "type": "structure", "members": { @@ -22309,6 +22633,12 @@ "target": "com.amazonaws.connect#IpCidr" } }, + "com.amazonaws.connect#IsReadOnly": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.connect#IvrRecordingTrack": { "type": "enum", "members": { @@ -22598,7 +22928,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Lists agent statuses.

", + "smithy.api#documentation": "

Lists agent statuses.

", "smithy.api#http": { "method": "GET", "uri": "/agent-status/{InstanceId}", @@ -22933,7 +23263,7 @@ "MaxResults": { "target": "com.amazonaws.connect#ListAssociatedContactsRequestMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return per page.

\n

The maximum number of results to return per page. The default MaxResult size is 25.

\n

Valid Range: Minimum value of 1. Maximum value of 100.

", + "smithy.api#documentation": "

The maximum number of results to return per page.

", "smithy.api#httpQuery": "maxResults" } }, @@ -23004,7 +23334,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change. To \nrequest access to this API, contact Amazon Web ServicesSupport.

\n

Provides summary information about the authentication profiles in a specified Amazon Connect instance.

", + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change. To \nrequest access to this API, contact Amazon Web Services Support.

\n

Provides summary information about the authentication profiles in a specified Amazon Connect instance.

", "smithy.api#http": { "method": "GET", "uri": "/authentication-profiles-summary/{InstanceId}", @@ -24132,7 +24462,7 @@ "HoursOfOperationId": { "target": "com.amazonaws.connect#HoursOfOperationId", "traits": { - "smithy.api#documentation": "

The identifier for the hours of operation

", + "smithy.api#documentation": "

The identifier for the hours of operation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -24147,7 +24477,7 @@ "MaxResults": { "target": "com.amazonaws.connect#MaxResult100", "traits": { - "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100. Valid\n Range: Minimum value of 1. Maximum value of 1000.

", + "smithy.api#documentation": "

The maximum number of results to return per page.

", "smithy.api#httpQuery": "maxResults" } } @@ -24174,7 +24504,7 @@ "LastModifiedRegion": { "target": "com.amazonaws.connect#RegionName", "traits": { - "smithy.api#documentation": "

The AWS Region where this resource was last modified.

" + "smithy.api#documentation": "

The Amazon Web Services Region where this resource was last modified.

" } }, "LastModifiedTime": { @@ -25128,7 +25458,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists predefined attributes for the specified Amazon Connect instance. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.

", + "smithy.api#documentation": "

Lists predefined attributes for the specified Amazon Connect instance. A predefined\n attribute is made up of a name and a value. You can use predefined attributes\n for:

\n \n

For the predefined attributes per instance quota, see Amazon Connect quotas.

\n

\n Endpoints: See Amazon Connect endpoints and\n quotas.

", "smithy.api#http": { "method": "GET", "uri": "/predefined-attributes/{InstanceId}", @@ -25163,7 +25493,7 @@ "MaxResults": { "target": "com.amazonaws.connect#MaxResult100", "traits": { - "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#documentation": "

The maximum number of results to return per page.

", "smithy.api#httpQuery": "maxResults" } } @@ -25308,7 +25638,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Lists the quick connects associated with a queue.

", + "smithy.api#documentation": "

Lists the quick connects associated with a queue.

", "smithy.api#http": { "method": "GET", "uri": "/queues/{InstanceId}/{QueueId}/quick-connects", @@ -25713,6 +26043,116 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#ListRoutingProfileManualAssignmentQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListRoutingProfileManualAssignmentQueuesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListRoutingProfileManualAssignmentQueuesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the manual assignment queues associated with a routing profile.

\n

\n Use cases\n

\n

Following are common uses cases for this API:

\n
    \n
  • \n

    This API returns list of queues where contacts can be manually assigned or picked. The\n user can additionally filter on queues, if they have access to those queues (otherwise a\n invalid request exception will be thrown).

    \n

    For information about how manual contact assignment works in the agent workspace, see the Access the Worklist app in the Amazon Connect agent workspace in the Amazon Connect Administrator\n Guide.

    \n
  • \n
\n

\n Important things to know\n

\n
    \n
  • \n

    This API only returns the manual assignment queues associated with a routing profile. Use\n the ListRoutingProfileQueues API to list the auto assignment queues for the routing\n profile.

    \n
  • \n
\n

\n Endpoints: See Amazon Connect endpoints and\n quotas.

", + "smithy.api#http": { + "method": "GET", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/manual-assignment-queues", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RoutingProfileManualAssignmentQueueConfigSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListRoutingProfileManualAssignmentQueuesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#ListRoutingProfileManualAssignmentQueuesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + }, + "RoutingProfileManualAssignmentQueueConfigSummaryList": { + "target": "com.amazonaws.connect#RoutingProfileManualAssignmentQueueConfigSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the manual assignment queues associated with the routing profile.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when this resource was last modified.

" + } + }, + "LastModifiedRegion": { + "target": "com.amazonaws.connect#RegionName", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region where this resource was last modified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#ListRoutingProfileQueues": { "type": "operation", "input": { @@ -27970,6 +28410,28 @@ "smithy.api#pattern": "^(^[\\S].*[\\S]$)|(^[\\S]$)$" } }, + "com.amazonaws.connect#NameCriteria": { + "type": "structure", + "members": { + "SearchText": { + "target": "com.amazonaws.connect#SearchTextList", + "traits": { + "smithy.api#documentation": "

The words or phrases used to match the contact name.

", + "smithy.api#required": {} + } + }, + "MatchType": { + "target": "com.amazonaws.connect#SearchContactsMatchType", + "traits": { + "smithy.api#documentation": "

The match type combining name search criteria using multiple search texts in a name\n criteria.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The search criteria based on the contact name

" + } + }, "com.amazonaws.connect#Namespace": { "type": "string", "traits": { @@ -28614,6 +29076,9 @@ "traits": { "smithy.api#documentation": "

The display name of the participant.

" } + }, + "ParticipantCapabilities": { + "target": "com.amazonaws.connect#ParticipantCapabilities" } }, "traits": { @@ -28641,13 +29106,13 @@ "ParticipantType": { "target": "com.amazonaws.connect#ParticipantType", "traits": { - "smithy.api#documentation": "

Information about the conversation participant. Following are the participant types: [Agent, Customer, Supervisor].

" + "smithy.api#documentation": "

Information about the conversation participant. Following are the participant types: [Agent,\n Customer, Supervisor].

" } }, "ConversationAbandon": { "target": "com.amazonaws.connect#NullableBoolean", "traits": { - "smithy.api#documentation": "

A boolean flag indicating whether the chat conversation was abandoned by a Participant.

" + "smithy.api#documentation": "

A boolean flag indicating whether the chat conversation was abandoned by a\n Participant.

" } }, "MessagesSent": { @@ -29053,6 +29518,12 @@ "smithy.api#documentation": "

Enable persistent chats. For more information about enabling persistent chat, and for\n example use cases and how to configure for them, see Enable persistent chat.

" } }, + "com.amazonaws.connect#PersistentConnection": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.connect#PhoneNumber": { "type": "string", "traits": { @@ -30777,6 +31248,18 @@ "smithy.api#documentation": "

The values of the predefined attribute.

" } }, + "Purposes": { + "target": "com.amazonaws.connect#PredefinedAttributePurposeNameList", + "traits": { + "smithy.api#documentation": "

Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.

" + } + }, + "AttributeConfiguration": { + "target": "com.amazonaws.connect#PredefinedAttributeConfiguration", + "traits": { + "smithy.api#documentation": "

Custom metadata that is associated to predefined attributes to control behavior \nin upstream services, such as controlling \nhow a predefined attribute should be displayed in the Amazon Connect admin website.

" + } + }, "LastModifiedTime": { "target": "com.amazonaws.connect#Timestamp", "traits": { @@ -30794,12 +31277,55 @@ "smithy.api#documentation": "

Information about a predefined attribute.

" } }, + "com.amazonaws.connect#PredefinedAttributeConfiguration": { + "type": "structure", + "members": { + "EnableValueValidationOnAssociation": { + "target": "com.amazonaws.connect#EnableValueValidationOnAssociation", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When this parameter is set to true, Amazon Connect enforces strict validation on the\n specific values, if the values are predefined in attributes. The contact will store only valid\n and predefined values for teh predefined attribute key.

" + } + }, + "IsReadOnly": { + "target": "com.amazonaws.connect#IsReadOnly", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean flag used to indicate whether a predefined attribute should be displayed in the\n Amazon Connect admin website.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Custom metadata that is associated to predefined attributes to control behavior in upstream\n services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.

" + } + }, "com.amazonaws.connect#PredefinedAttributeName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 64 + "max": 100 + } + } + }, + "com.amazonaws.connect#PredefinedAttributePurposeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#PredefinedAttributePurposeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#PredefinedAttributePurposeName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 } } }, @@ -30843,7 +31369,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 64 + "max": 100 } } }, @@ -30854,8 +31380,8 @@ }, "traits": { "smithy.api#length": { - "min": 1, - "max": 128 + "min": 0, + "max": 500 } } }, @@ -33196,7 +33722,7 @@ } ], "traits": { - "smithy.api#documentation": "

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You\n can call this API only in the Amazon Web Services Region where the number was claimed.

\n \n

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the\n Amazon Connect admin website.

\n

After releasing a phone number, the phone number enters into a cooldown period for up to\n 180 days. It cannot be searched for or claimed again until the period has ended. If you\n accidentally release a phone number, contact Amazon Web ServicesSupport.

\n
\n

If you plan to claim and release numbers frequently,\n contact us for a service quota exception. Otherwise, it is possible you will be blocked from\n claiming and releasing any more numbers until up to 180 days past the oldest number\n released has expired.

\n

By default you can claim and release up to 200% of your maximum number of active\n phone numbers. If you claim and release phone numbers using\n the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number\n service level quota, you will be blocked from claiming any more numbers until 180\n days past the oldest number released has expired.

\n

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180\n day period you release 99, claim 99, and then release 99, you will have exceeded the\n 200% limit. At that point you are blocked from claiming any more numbers until you\n open an Amazon Web Services support ticket.

", + "smithy.api#documentation": "

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You\n can call this API only in the Amazon Web Services Region where the number was claimed.

\n \n

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the\n Amazon Connect admin website.

\n

After releasing a phone number, the phone number enters into a cooldown period for up to\n 180 days. It cannot be searched for or claimed again until the period has ended. If you\n accidentally release a phone number, contact Amazon Web Services Support.

\n
\n

If you plan to claim and release numbers frequently,\n contact us for a service quota exception. Otherwise, it is possible you will be blocked from\n claiming and releasing any more numbers until up to 180 days past the oldest number\n released has expired.

\n

By default you can claim and release up to 200% of your maximum number of active\n phone numbers. If you claim and release phone numbers using\n the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number\n service level quota, you will be blocked from claiming any more numbers until 180\n days past the oldest number released has expired.

\n

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180\n day period you release 99, claim 99, and then release 99, you will have exceeded the\n 200% limit. At that point you are blocked from claiming any more numbers until you\n open an Amazon Web Services support ticket.

", "smithy.api#http": { "method": "DELETE", "uri": "/phone-number/{PhoneNumberId}", @@ -33481,7 +34007,7 @@ } }, "traits": { - "smithy.api#documentation": "

That resource is already in use. Please try another.

", + "smithy.api#documentation": "

That resource is already in use (for example, you're trying to add a record with the same\n name as an existing record). If you are trying to delete a resource (for example,\n DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources\n and then try again.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -33928,6 +34454,12 @@ "smithy.api#documentation": "

The number of associated queues in routing profile.

" } }, + "NumberOfAssociatedManualAssignmentQueues": { + "target": "com.amazonaws.connect#Long", + "traits": { + "smithy.api#documentation": "

The number of associated manual assignment queues in routing profile.

" + } + }, "NumberOfAssociatedUsers": { "target": "com.amazonaws.connect#Long", "traits": { @@ -33964,6 +34496,12 @@ "traits": { "smithy.api#documentation": "

The IDs of the associated queue.

" } + }, + "AssociatedManualAssignmentQueueIds": { + "target": "com.amazonaws.connect#AssociatedQueueIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the associated manual assignment queues.

" + } } }, "traits": { @@ -33988,6 +34526,74 @@ "target": "com.amazonaws.connect#RoutingProfile" } }, + "com.amazonaws.connect#RoutingProfileManualAssignmentQueueConfig": { + "type": "structure", + "members": { + "QueueReference": { + "target": "com.amazonaws.connect#RoutingProfileQueueReference", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the queue and channel for manual assignment behaviour can be\n enabled.

" + } + }, + "com.amazonaws.connect#RoutingProfileManualAssignmentQueueConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileManualAssignmentQueueConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.connect#RoutingProfileManualAssignmentQueueConfigSummary": { + "type": "structure", + "members": { + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

", + "smithy.api#required": {} + } + }, + "QueueArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the queue.

", + "smithy.api#required": {} + } + }, + "QueueName": { + "target": "com.amazonaws.connect#QueueName", + "traits": { + "smithy.api#documentation": "

The name of the queue.

", + "smithy.api#required": {} + } + }, + "Channel": { + "target": "com.amazonaws.connect#Channel", + "traits": { + "smithy.api#documentation": "

The channels this queue supports. Valid Values: CHAT | TASK | EMAIL

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains summary information about a routing profile manual assignment queue.

" + } + }, + "com.amazonaws.connect#RoutingProfileManualAssignmentQueueConfigSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileManualAssignmentQueueConfigSummary" + } + }, "com.amazonaws.connect#RoutingProfileName": { "type": "string", "traits": { @@ -35045,6 +35651,51 @@ } } }, + "com.amazonaws.connect#SearchContactsAdditionalTimeRange": { + "type": "structure", + "members": { + "Criteria": { + "target": "com.amazonaws.connect#SearchContactsAdditionalTimeRangeCriteriaList", + "traits": { + "smithy.api#documentation": "

List of criteria of the time range to additionally filter on.

", + "smithy.api#required": {} + } + }, + "MatchType": { + "target": "com.amazonaws.connect#SearchContactsMatchType", + "traits": { + "smithy.api#documentation": "

The match type combining multiple time range filters.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Time range that you additionally want to filter on.

" + } + }, + "com.amazonaws.connect#SearchContactsAdditionalTimeRangeCriteria": { + "type": "structure", + "members": { + "TimeRange": { + "target": "com.amazonaws.connect#SearchContactsTimeRange" + }, + "TimestampCondition": { + "target": "com.amazonaws.connect#SearchContactsTimestampCondition", + "traits": { + "smithy.api#documentation": "

List of the timestamp conditions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The criteria of the time range to additionally filter on.

" + } + }, + "com.amazonaws.connect#SearchContactsAdditionalTimeRangeCriteriaList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SearchContactsAdditionalTimeRangeCriteria" + } + }, "com.amazonaws.connect#SearchContactsMatchType": { "type": "enum", "members": { @@ -35059,6 +35710,18 @@ "traits": { "smithy.api#enumValue": "MATCH_ANY" } + }, + "MATCH_EXACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MATCH_EXACT" + } + }, + "MATCH_NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MATCH_NONE" + } } } }, @@ -35164,6 +35827,17 @@ "smithy.api#documentation": "

A structure of time range that you want to search results.

" } }, + "com.amazonaws.connect#SearchContactsTimeRangeConditionType": { + "type": "enum", + "members": { + "NOT_EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EXISTS" + } + } + } + }, "com.amazonaws.connect#SearchContactsTimeRangeType": { "type": "enum", "members": { @@ -35190,12 +35864,46 @@ "traits": { "smithy.api#enumValue": "DISCONNECT_TIMESTAMP" } + }, + "ENQUEUE_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENQUEUE_TIMESTAMP" + } + } + } + }, + "com.amazonaws.connect#SearchContactsTimestampCondition": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.connect#SearchContactsTimeRangeType", + "traits": { + "smithy.api#documentation": "

Type of the timestamps to use for the filter.

", + "smithy.api#required": {} + } + }, + "ConditionType": { + "target": "com.amazonaws.connect#SearchContactsTimeRangeConditionType", + "traits": { + "smithy.api#documentation": "

Condition of the timestamp on the contact.

", + "smithy.api#required": {} + } } + }, + "traits": { + "smithy.api#documentation": "

The timestamp condition indicating which timestamp should be used and how it should be\n filtered.

" } }, "com.amazonaws.connect#SearchCriteria": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.connect#NameCriteria", + "traits": { + "smithy.api#documentation": "

Name of the contact.

" + } + }, "AgentIds": { "target": "com.amazonaws.connect#AgentResourceIdList", "traits": { @@ -35232,6 +35940,18 @@ "smithy.api#documentation": "

The list of queue IDs associated with contacts.

" } }, + "RoutingCriteria": { + "target": "com.amazonaws.connect#SearchableRoutingCriteria", + "traits": { + "smithy.api#documentation": "

Routing criteria for the contact.

" + } + }, + "AdditionalTimeRange": { + "target": "com.amazonaws.connect#SearchContactsAdditionalTimeRange", + "traits": { + "smithy.api#documentation": "

Additional TimeRange used to filter contacts.

" + } + }, "SearchableContactAttributes": { "target": "com.amazonaws.connect#SearchableContactAttributes", "traits": { @@ -35404,13 +36124,13 @@ "NextToken": { "target": "com.amazonaws.connect#NextToken2500", "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results. Length Constraints: Minimum length of 1.\n Maximum length of 2500.

" + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.

" } }, "MaxResults": { "target": "com.amazonaws.connect#MaxResult100", "traits": { - "smithy.api#documentation": "

The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum\n value of 100.

" + "smithy.api#documentation": "

The maximum number of results to return per page.

" } }, "SearchFilter": { @@ -35439,7 +36159,7 @@ "NextToken": { "target": "com.amazonaws.connect#NextToken2500", "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results. Length Constraints: Minimum length of 1.\n Maximum length of 2500.

" + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.

" } }, "ApproximateTotalCount": { @@ -35584,7 +36304,7 @@ } ], "traits": { - "smithy.api#documentation": "

Searches predefined attributes that meet certain criteria. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.

", + "smithy.api#documentation": "

Searches predefined attributes that meet certain criteria. A predefined\n attribute is made up of a name and a value. You can use predefined attributes\n for:

\n \n

For the predefined attributes per instance quota, see Amazon Connect quotas.

\n

\n Endpoints: See Amazon Connect endpoints and\n quotas.

", "smithy.api#http": { "method": "POST", "uri": "/search-predefined-attributes", @@ -36616,6 +37336,26 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#SearchableAgentCriteriaStep": { + "type": "structure", + "members": { + "AgentIds": { + "target": "com.amazonaws.connect#AgentResourceIdList", + "traits": { + "smithy.api#documentation": "

The identifiers of agents used in preferred agents matching.

" + } + }, + "MatchType": { + "target": "com.amazonaws.connect#SearchContactsMatchType", + "traits": { + "smithy.api#documentation": "

The match type combining multiple agent criteria steps.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The agent criteria to search for preferred agents on the routing criteria.

" + } + }, "com.amazonaws.connect#SearchableContactAttributeKey": { "type": "string", "traits": { @@ -36714,6 +37454,40 @@ } } }, + "com.amazonaws.connect#SearchableRoutingCriteria": { + "type": "structure", + "members": { + "Steps": { + "target": "com.amazonaws.connect#SearchableRoutingCriteriaStepList", + "traits": { + "smithy.api#documentation": "

The list of Routing criteria steps of the contact routing.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Routing criteria of the contact to match on.

" + } + }, + "com.amazonaws.connect#SearchableRoutingCriteriaStep": { + "type": "structure", + "members": { + "AgentCriteria": { + "target": "com.amazonaws.connect#SearchableAgentCriteriaStep", + "traits": { + "smithy.api#documentation": "

Agent matching the routing step of the routing criteria

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Routing criteria of the contact to match on.

" + } + }, + "com.amazonaws.connect#SearchableRoutingCriteriaStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SearchableRoutingCriteriaStep" + } + }, "com.amazonaws.connect#SearchableSegmentAttributeKey": { "type": "string", "traits": { @@ -37137,6 +37911,18 @@ "traits": { "smithy.api#documentation": "

The value of a segment attribute.

" } + }, + "ValueList": { + "target": "com.amazonaws.connect#SegmentAttributeValueList", + "traits": { + "smithy.api#documentation": "

The value of a segment attribute. This is only supported for system-defined attributes, not\n for user-defined attributes.

" + } + }, + "ValueArn": { + "target": "com.amazonaws.connect#SegmentAttributeValueString", + "traits": { + "smithy.api#documentation": "

The value of a segment attribute that has to be a valid ARN. This is only supported for\n system-defined attributes, not for user-defined attributes.

" + } } }, "traits": { @@ -37146,6 +37932,12 @@ "com.amazonaws.connect#SegmentAttributeValueInteger": { "type": "integer" }, + "com.amazonaws.connect#SegmentAttributeValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SegmentAttributeValue" + } + }, "com.amazonaws.connect#SegmentAttributeValueMap": { "type": "map", "key": { @@ -37679,6 +38471,12 @@ "traits": { "smithy.api#enumValue": "CHANNEL" } + }, + "EXPIRY_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRY_TIMESTAMP" + } } } }, @@ -37922,7 +38720,7 @@ } ], "traits": { - "smithy.api#documentation": "

Initiates a flow to start a new chat for the customer. Response of this API provides a token\n required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

\n

When a new chat contact is successfully created, clients must subscribe to the participant’s\n connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

\n

A 429 error occurs in the following situations:

\n
    \n
  • \n

    API rate limit is exceeded. API TPS throttling returns a TooManyRequests\n exception.

    \n
  • \n
  • \n

    The quota for concurrent active\n chats is exceeded. Active chat throttling returns a\n LimitExceededException.

    \n
  • \n
\n

If you use the ChatDurationInMinutes parameter and receive a 400 error, your\n account may not support the ability to configure custom chat durations. For more information,\n contact Amazon Web ServicesSupport.

\n

For more information about chat, see the following topics in the Amazon Connect\n Administrator Guide:

\n ", + "smithy.api#documentation": "

Initiates a flow to start a new chat for the customer. Response of this API provides a token\n required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

\n

When a new chat contact is successfully created, clients must subscribe to the participant’s\n connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

\n

A 429 error occurs in the following situations:

\n
    \n
  • \n

    API rate limit is exceeded. API TPS throttling returns a TooManyRequests\n exception.

    \n
  • \n
  • \n

    The quota for concurrent active\n chats is exceeded. Active chat throttling returns a\n LimitExceededException.

    \n
  • \n
\n

If you use the ChatDurationInMinutes parameter and receive a 400 error, your\n account may not support the ability to configure custom chat durations. For more information,\n contact Amazon Web Services Support.

\n

For more information about chat, see the following topics in the Amazon Connect\n Administrator Guide:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/contact/chat", @@ -38395,7 +39193,7 @@ "AdditionalRecipients": { "target": "com.amazonaws.connect#InboundAdditionalRecipients", "traits": { - "smithy.api#documentation": "

The addtional recipients address of the email.

" + "smithy.api#documentation": "

The additional recipients address of the email.

" } }, "Attachments": { @@ -41371,7 +42169,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates agent status.

", + "smithy.api#documentation": "

Updates agent status.

", "smithy.api#http": { "method": "POST", "uri": "/agent-status/{InstanceId}/{AgentStatusId}", @@ -41469,7 +42267,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change. To \nrequest access to this API, contact Amazon Web ServicesSupport.

\n

Updates the selected authentication profile.

", + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change. To \nrequest access to this API, contact Amazon Web Services Support.

\n

Updates the selected authentication profile.

", "smithy.api#http": { "method": "POST", "uri": "/authentication-profiles/{InstanceId}/{AuthenticationProfileId}", @@ -42190,7 +42988,7 @@ "SegmentAttributes": { "target": "com.amazonaws.connect#SegmentAttributes", "traits": { - "smithy.api#documentation": "

A set of system defined key-value pairs stored on individual contact segments (unique\n contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.\n They can be accessed in flows.

\n

Attribute keys can include only alphanumeric, -, and _.

\n

This field can be used to show channel subtype, such as connect:Guide.

\n

Currently Contact Expiry is the only segment attribute which can be updated by using the\n UpdateContact API.

" + "smithy.api#documentation": "

A set of system defined key-value pairs stored on individual contact segments (unique\n contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.\n They can be accessed in flows.

\n

Attribute keys can include only alphanumeric, -, and _.

\n

This field can be used to show channel subtype, such as connect:Guide.

\n

Contact Expiry, and user-defined attributes (String - String) that are defined in predefined\n attributes, can be updated by using the UpdateContact API.

" } }, "QueueInfo": { @@ -42659,7 +43457,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the hours of operation.

", + "smithy.api#documentation": "

Updates the hours of operation.

", "smithy.api#http": { "method": "POST", "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", @@ -42770,7 +43568,7 @@ "EffectiveTill": { "target": "com.amazonaws.connect#HoursOfOperationOverrideYearMonthDayDateFormat", "traits": { - "smithy.api#documentation": "

The date till when the hours of operation override would be effective.

" + "smithy.api#documentation": "

The date until the hours of operation override is effective.

" } } }, @@ -42874,7 +43672,7 @@ "AttributeType": { "target": "com.amazonaws.connect#InstanceAttributeType", "traits": { - "smithy.api#documentation": "

The type of attribute.

\n \n

Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature,\n contact Amazon Web ServicesSupport for allowlisting.

\n
", + "smithy.api#documentation": "

The type of attribute.

\n \n

Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature,\n contact Amazon Web Services Support for allowlisting.

\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -43343,7 +44141,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a predefined attribute for the specified Amazon Connect instance. Predefined\n attributes are attributes in an Amazon Connect instance that can be used to route\n contacts to an agent or pools of agents within a queue. For more information, see Create\n predefined attributes for routing contacts to agents.

", + "smithy.api#documentation": "

Updates a predefined attribute for the specified Amazon Connect instance. A predefined\n attribute is made up of a name and a value.

\n

For the predefined attributes per instance quota, see Amazon Connect quotas.

\n

\n Use cases\n

\n

Following are common uses cases for this API:

\n
    \n
  • \n

    Update routing proficiency (for example, agent certification) that has predefined values\n (for example, a list of possible certifications). For more information, see Create\n predefined attributes for routing contacts to agents.

    \n
  • \n
  • \n

    Update an attribute for business unit name that has a list of predefined business unit\n names used in your organization. This is a use case where information for a contact varies\n between transfers or conferences. For more information, see Use contact segment\n attributes.

    \n
  • \n
\n

\n Endpoints: See Amazon Connect endpoints and\n quotas.

", "smithy.api#http": { "method": "POST", "uri": "/predefined-attributes/{InstanceId}/{Name}", @@ -43375,6 +44173,18 @@ "traits": { "smithy.api#documentation": "

The values of the predefined attribute.

" } + }, + "Purposes": { + "target": "com.amazonaws.connect#PredefinedAttributePurposeNameList", + "traits": { + "smithy.api#documentation": "

Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.

" + } + }, + "AttributeConfiguration": { + "target": "com.amazonaws.connect#InputPredefinedAttributeConfiguration", + "traits": { + "smithy.api#documentation": "

Custom metadata that is associated to predefined attributes to control behavior \nin upstream services, such as controlling \nhow a predefined attribute should be displayed in the Amazon Connect admin website.

" + } } }, "traits": { @@ -43503,7 +44313,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the hours of operation for the specified queue.

", + "smithy.api#documentation": "

Updates the hours of operation for the specified queue.

", "smithy.api#http": { "method": "POST", "uri": "/queues/{InstanceId}/{QueueId}/hours-of-operation", @@ -43568,7 +44378,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the maximum number of contacts allowed in a queue before it is considered\n full.

", + "smithy.api#documentation": "

Updates the maximum number of contacts allowed in a queue before it is considered\n full.

", "smithy.api#http": { "method": "POST", "uri": "/queues/{InstanceId}/{QueueId}/max-contacts", @@ -43636,7 +44446,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the name and description of a queue. At least Name or Description must be provided.

", + "smithy.api#documentation": "

Updates the name and description of a queue. At least Name or Description must be provided.

", "smithy.api#http": { "method": "POST", "uri": "/queues/{InstanceId}/{QueueId}/name", @@ -43706,7 +44516,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the outbound caller ID name, number, and outbound whisper flow for a specified\n queue.

\n \n
    \n
  • \n

    If the phone number is claimed to a traffic distribution group that was created in the\n same Region as the Amazon Connect instance where you are calling this API, then you can use a\n full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed\n to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a\n UUID is provided in this scenario, you will receive a\n ResourceNotFoundException.

    \n
  • \n
  • \n

    Only use the phone number ARN format that doesn't contain instance in the\n path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This\n is the same ARN format that is returned when you call the ListPhoneNumbersV2\n API.

    \n
  • \n
  • \n

    If you plan to use IAM policies to allow/deny access to this API for phone\n number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

    \n
  • \n
\n
", + "smithy.api#documentation": "

Updates the outbound caller ID name, number, and outbound whisper flow for a specified\n queue.

\n \n
    \n
  • \n

    If the phone number is claimed to a traffic distribution group that was created in the\n same Region as the Amazon Connect instance where you are calling this API, then you can use a\n full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed\n to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a\n UUID is provided in this scenario, you will receive a\n ResourceNotFoundException.

    \n
  • \n
  • \n

    Only use the phone number ARN format that doesn't contain instance in the\n path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This\n is the same ARN format that is returned when you call the ListPhoneNumbersV2\n API.

    \n
  • \n
  • \n

    If you plan to use IAM policies to allow/deny access to this API for phone\n number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

    \n
  • \n
\n
", "smithy.api#http": { "method": "POST", "uri": "/queues/{InstanceId}/{QueueId}/outbound-caller-config", @@ -43842,7 +44652,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the status of the queue.

", + "smithy.api#documentation": "

Updates the status of the queue.

", "smithy.api#http": { "method": "POST", "uri": "/queues/{InstanceId}/{QueueId}/status", @@ -46022,6 +46832,13 @@ "traits": { "smithy.api#documentation": "

The phone number for the user's desk phone.

" } + }, + "PersistentConnection": { + "target": "com.amazonaws.connect#PersistentConnection", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The persistent connection setting for the user.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/connectcampaigns.json b/codegen/sdk/aws-models/connectcampaigns.json index a3d8e26f473..98747c2984d 100644 --- a/codegen/sdk/aws-models/connectcampaigns.json +++ b/codegen/sdk/aws-models/connectcampaigns.json @@ -653,17 +653,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -677,17 +666,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -701,17 +679,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -725,17 +692,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/connectcampaignsv2.json b/codegen/sdk/aws-models/connectcampaignsv2.json index ba4ac1f13de..8a9e67070dd 100644 --- a/codegen/sdk/aws-models/connectcampaignsv2.json +++ b/codegen/sdk/aws-models/connectcampaignsv2.json @@ -685,17 +685,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -709,17 +698,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -733,17 +711,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -757,17 +724,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/connectcases.json b/codegen/sdk/aws-models/connectcases.json index 340a7989bb9..841ac6512c1 100644 --- a/codegen/sdk/aws-models/connectcases.json +++ b/codegen/sdk/aws-models/connectcases.json @@ -587,17 +587,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -611,17 +600,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -635,17 +613,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -659,17 +626,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1732,6 +1688,50 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.connectcases#ConnectCaseContent": { + "type": "structure", + "members": { + "caseId": { + "target": "com.amazonaws.connectcases#CaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the related case", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the content of a Case related item" + } + }, + "com.amazonaws.connectcases#ConnectCaseFilter": { + "type": "structure", + "members": { + "caseId": { + "target": "com.amazonaws.connectcases#CaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the case to filter by" + } + } + }, + "traits": { + "smithy.api#documentation": "A filter for related items of type Case" + } + }, + "com.amazonaws.connectcases#ConnectCaseInputContent": { + "type": "structure", + "members": { + "caseId": { + "target": "com.amazonaws.connectcases#CaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the case to be related", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the input content of a Case related item" + } + }, "com.amazonaws.connectcases#ConnectedToSystemTime": { "type": "timestamp", "traits": { @@ -2475,6 +2475,21 @@ "smithy.api#timestampFormat": "date-time" } }, + "com.amazonaws.connectcases#CustomContent": { + "type": "structure", + "members": { + "fields": { + "target": "com.amazonaws.connectcases#FieldValueList", + "traits": { + "smithy.api#documentation": "List of field values for the custom related item", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the content of a Custom related item" + } + }, "com.amazonaws.connectcases#CustomEntity": { "type": "string", "traits": { @@ -2486,6 +2501,80 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.connectcases#CustomFieldsFilter": { + "type": "union", + "members": { + "field": { + "target": "com.amazonaws.connectcases#FieldFilter" + }, + "not": { + "target": "com.amazonaws.connectcases#CustomFieldsFilter", + "traits": { + "smithy.api#documentation": "Excludes items matching the filter" + } + }, + "andAll": { + "target": "com.amazonaws.connectcases#CustomFieldsFilterList", + "traits": { + "smithy.api#documentation": "Matches items that satisfy all of the specified filter conditions", + "smithy.api#length": { + "max": 10 + } + } + }, + "orAll": { + "target": "com.amazonaws.connectcases#CustomFieldsFilterList", + "traits": { + "smithy.api#documentation": "Matches items that satisfy any of the specified filter conditions", + "smithy.api#length": { + "max": 10 + } + } + } + }, + "traits": { + "smithy.api#documentation": "A filter for fields in related items of type Custom" + } + }, + "com.amazonaws.connectcases#CustomFieldsFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.connectcases#CustomFieldsFilter" + } + }, + "com.amazonaws.connectcases#CustomFilter": { + "type": "structure", + "members": { + "fields": { + "target": "com.amazonaws.connectcases#CustomFieldsFilter", + "traits": { + "smithy.api#documentation": "Filter conditions for custom fields" + } + } + }, + "traits": { + "smithy.api#documentation": "A filter for related items of type Custom" + } + }, + "com.amazonaws.connectcases#CustomInputContent": { + "type": "structure", + "members": { + "fields": { + "target": "com.amazonaws.connectcases#FieldValueList", + "traits": { + "smithy.api#documentation": "List of field values for the custom related item", + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the input content of a Custom related item" + } + }, "com.amazonaws.connectcases#DeleteCase": { "type": "operation", "input": { @@ -2512,7 +2601,7 @@ } ], "traits": { - "smithy.api#documentation": "

The DeleteCase API permanently deletes a case and all its associated resources from the cases data store. After a successful deletion, you cannot:

  • Retrieve related items

  • Access audit history

  • Perform any operations that require the CaseID

This action is irreversible. Once you delete a case, you cannot recover its data.

", + "smithy.api#documentation": "

The DeleteCase API permanently deletes a case and all its associated resources from the cases data store. After a successful deletion, you cannot:

  • Retrieve related items

  • Access audit history

  • Perform any operations that require the CaseID

This action is irreversible. After you delete a case, you cannot recover its data.

", "smithy.api#http": { "uri": "/domains/{domainId}/cases/{caseId}", "method": "DELETE" @@ -3740,7 +3829,7 @@ "target": "smithy.api#Integer", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of audit events to return. The current maximum supported value is 25. This is also the default when no other value is provided.

", + "smithy.api#documentation": "

The maximum number of audit events to return. When no value is provided, 25 is the default.

", "smithy.api#range": { "min": 1, "max": 25 @@ -5465,6 +5554,18 @@ "traits": { "smithy.api#documentation": "

Represents the content of an SLA to be returned to agents.

" } + }, + "connectCase": { + "target": "com.amazonaws.connectcases#ConnectCaseContent", + "traits": { + "smithy.api#documentation": "Content for a related Connect case" + } + }, + "custom": { + "target": "com.amazonaws.connectcases#CustomContent", + "traits": { + "smithy.api#documentation": "Content for a custom related item" + } } }, "traits": { @@ -5527,6 +5628,18 @@ "traits": { "smithy.api#documentation": "

Represents the content of an SLA to be created.

" } + }, + "connectCase": { + "target": "com.amazonaws.connectcases#ConnectCaseInputContent", + "traits": { + "smithy.api#documentation": "Input content for a related Connect case" + } + }, + "custom": { + "target": "com.amazonaws.connectcases#CustomInputContent", + "traits": { + "smithy.api#documentation": "Input content for a custom related item" + } } }, "traits": { @@ -5552,6 +5665,14 @@ { "value": "Sla", "name": "SLA" + }, + { + "value": "ConnectCase", + "name": "CONNECT_CASE" + }, + { + "value": "Custom", + "name": "CUSTOM" } ] } @@ -5582,6 +5703,18 @@ "traits": { "smithy.api#documentation": "

Filter for related items of type SLA.

" } + }, + "connectCase": { + "target": "com.amazonaws.connectcases#ConnectCaseFilter", + "traits": { + "smithy.api#documentation": "Filter for related items of type Connect case" + } + }, + "custom": { + "target": "com.amazonaws.connectcases#CustomFilter", + "traits": { + "smithy.api#documentation": "Filter for related items of type Custom" + } } }, "traits": { @@ -5732,7 +5865,7 @@ "target": "smithy.api#Integer", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

", + "smithy.api#documentation": "

The maximum number of cases to return. When no value is provided, 25 is the default.

", "smithy.api#range": { "min": 1, "max": 100 diff --git a/codegen/sdk/aws-models/connectparticipant.json b/codegen/sdk/aws-models/connectparticipant.json index 809c6b5ce86..fcd38ab7b18 100644 --- a/codegen/sdk/aws-models/connectparticipant.json +++ b/codegen/sdk/aws-models/connectparticipant.json @@ -623,17 +623,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -647,17 +636,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -671,17 +649,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -695,17 +662,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -881,6 +837,43 @@ "target": "com.amazonaws.connectparticipant#AttachmentItem" } }, + "com.amazonaws.connectparticipant#Attendee": { + "type": "structure", + "members": { + "AttendeeId": { + "target": "com.amazonaws.connectparticipant#AttendeeId", + "traits": { + "smithy.api#documentation": "

The Amazon Chime SDK attendee ID.

" + } + }, + "JoinToken": { + "target": "com.amazonaws.connectparticipant#JoinToken", + "traits": { + "smithy.api#documentation": "

The join token used by the Amazon Chime SDK attendee.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The attendee information, including attendee ID and join token.

" + } + }, + "com.amazonaws.connectparticipant#AttendeeId": { + "type": "string" + }, + "com.amazonaws.connectparticipant#AudioFeatures": { + "type": "structure", + "members": { + "EchoReduction": { + "target": "com.amazonaws.connectparticipant#MeetingFeatureStatus", + "traits": { + "smithy.api#documentation": "

Makes echo reduction available to clients who connect to the meeting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Has audio-specific configurations as the operating parameter for Echo Reduction.

" + } + }, "com.amazonaws.connectparticipant#AuthenticationUrl": { "type": "string", "traits": { @@ -916,7 +909,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the authentication session. The opted out branch of the Authenticate Customer\n flow block will be taken.

\n \n

The current supported channel is chat. This API is not supported for Apple\n Messages for Business, WhatsApp, or SMS chats.

\n
", + "smithy.api#documentation": "

Cancels the authentication session. The opted out branch of the Authenticate Customer\n flow block will be taken.

\n \n

The current supported channel is chat. This API is not supported for Apple\n Messages for Business, WhatsApp, or SMS chats.

\n
\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", "smithy.api#http": { "method": "POST", "uri": "/participant/cancel-authentication", @@ -1096,7 +1089,7 @@ } ], "traits": { - "smithy.api#documentation": "

Allows you to confirm that the attachment has been uploaded using the pre-signed URL\n provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment\n with that identifier is already being uploaded.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", + "smithy.api#documentation": "

Allows you to confirm that the attachment has been uploaded using the pre-signed URL\n provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment\n with that identifier is already being uploaded.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", "smithy.api#http": { "method": "POST", "uri": "/participant/complete-attachment-upload", @@ -1192,6 +1185,12 @@ "traits": { "smithy.api#enumValue": "CONNECTION_CREDENTIALS" } + }, + "WEBRTC_CONNECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEBRTC_CONNECTION" + } } } }, @@ -1247,7 +1246,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates the participant's connection.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n

\n ParticipantToken is used for invoking this API instead of\n ConnectionToken.

\n
\n

The participant token is valid for the lifetime of the participant – until they are\n part of a contact.

\n

The response URL for WEBSOCKET Type has a connect expiry timeout of 100s.\n Clients must manually connect to the returned websocket URL and subscribe to the desired\n topic.

\n

For chat, you need to publish the following on the established websocket\n connection:

\n

\n {\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}}\n

\n

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter,\n clients need to call this API again to obtain a new websocket URL and perform the same\n steps as before.

\n

\n Message streaming support: This API can also be used\n together with the StartContactStreaming API to create a participant connection for chat\n contacts that are not using a websocket. For more information about message streaming,\n Enable real-time chat\n message streaming in the Amazon Connect Administrator\n Guide.

\n

\n Feature specifications: For information about feature\n specifications, such as the allowed number of open websocket connections per\n participant, see Feature specifications in the Amazon Connect Administrator\n Guide.

\n \n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

\n
", + "smithy.api#documentation": "

Creates the participant's connection.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n

For WebRTC security recommendations, see Amazon Connect WebRTC security best practices.

\n \n

\n ParticipantToken is used for invoking this API instead of\n ConnectionToken.

\n
\n

The participant token is valid for the lifetime of the participant – until they are\n part of a contact. For WebRTC participants, if they leave or are disconnected for 60\n seconds, a new participant needs to be created using the CreateParticipant API.

\n

\n For WEBSOCKET Type:

\n

The response URL for has a connect expiry timeout of 100s. Clients must manually\n connect to the returned websocket URL and subscribe to the desired topic.

\n

For chat, you need to publish the following on the established websocket\n connection:

\n

\n {\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}}\n

\n

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter,\n clients need to call this API again to obtain a new websocket URL and perform the same\n steps as before.

\n

The expiry time for the connection token is different than the\n ChatDurationInMinutes. Expiry time for the connection token is 1\n day.

\n

\n For WEBRTC_CONNECTION Type:

\n

The response includes connection data required for the client application to join the\n call using the Amazon Chime SDK client libraries. The WebRTCConnection response contains\n Meeting and Attendee information needed to establish the media connection.

\n

The attendee join token in WebRTCConnection response is valid for the lifetime of the\n participant in the call. If a participant leaves or is disconnected for 60 seconds,\n their participant credentials will no longer be valid, and a new participant will need\n to be created to rejoin the call.

\n

\n Message streaming support: This API can also be used\n together with the StartContactStreaming API to create a participant connection for chat\n contacts that are not using a websocket. For more information about message streaming,\n Enable real-time chat\n message streaming in the Amazon Connect Administrator\n Guide.

\n

\n Multi-user web, in-app, video calling support:

\n

For WebRTC calls, this API is used in conjunction with the CreateParticipant API to\n enable multi-party calling. The StartWebRTCContact API creates the initial contact and\n routes it to an agent, while CreateParticipant adds additional participants to the\n ongoing call. For more information about multi-party WebRTC calls, see Enable multi-user web, in-app, and video calling in the Amazon Connect\n Administrator Guide.

\n

\n Feature specifications: For information about feature\n specifications, such as the allowed number of open websocket connections per participant\n or maximum number of WebRTC participants, see Feature specifications in the Amazon Connect Administrator\n Guide.

\n \n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

\n
", "smithy.api#http": { "method": "POST", "uri": "/participant/connection", @@ -1297,6 +1296,12 @@ "traits": { "smithy.api#documentation": "

Creates the participant's connection credentials. The authentication token associated\n with the participant's connection.

" } + }, + "WebRTCConnection": { + "target": "com.amazonaws.connectparticipant#WebRTCConnection", + "traits": { + "smithy.api#documentation": "

Creates the participant's WebRTC connection data required for the client application\n (mobile application or website) to connect to the call.

" + } } }, "traits": { @@ -1329,7 +1334,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the view for the specified view token.

\n

For security recommendations, see Amazon Connect Chat security best practices.

", + "smithy.api#documentation": "

Retrieves the view for the specified view token.

\n

For security recommendations, see Amazon Connect Chat security best practices.

", "smithy.api#http": { "method": "GET", "uri": "/participant/views/{ViewToken}", @@ -1398,7 +1403,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disconnects a participant.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", + "smithy.api#documentation": "

Disconnects a participant.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", "smithy.api#http": { "method": "POST", "uri": "/participant/disconnect", @@ -1468,7 +1473,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a pre-signed URL for download of a completed attachment. This is an\n asynchronous API for use with active contacts.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", + "smithy.api#documentation": "

Provides a pre-signed URL for download of a completed attachment. This is an\n asynchronous API for use with active contacts.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n
    \n
  • \n

    The participant role CUSTOM_BOT is not permitted to access\n attachments customers may upload. An AccessDeniedException can\n indicate that the participant may be a CUSTOM_BOT, and it doesn't have\n access to attachments.

    \n
  • \n
  • \n

    \n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

    \n
  • \n
\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", "smithy.api#http": { "method": "POST", "uri": "/participant/attachment", @@ -1556,7 +1561,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the AuthenticationUrl for the current authentication session for the\n AuthenticateCustomer flow block.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n
    \n
  • \n

    This API can only be called within one minute of receiving the\n authenticationInitiated event.

    \n
  • \n
  • \n

    The current supported channel is chat. This API is not supported for Apple\n Messages for Business, WhatsApp, or SMS chats.

    \n
  • \n
\n
", + "smithy.api#documentation": "

Retrieves the AuthenticationUrl for the current authentication session for the\n AuthenticateCustomer flow block.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n
    \n
  • \n

    This API can only be called within one minute of receiving the\n authenticationInitiated event.

    \n
  • \n
  • \n

    The current supported channel is chat. This API is not supported for Apple\n Messages for Business, WhatsApp, or SMS chats.

    \n
  • \n
\n
\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", "smithy.api#http": { "method": "POST", "uri": "/participant/authentication-url", @@ -1631,7 +1636,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a transcript of the session, including details about any attachments. For\n information about accessing past chat contact transcripts for a persistent chat, see\n Enable persistent chat.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n

If you have a process that consumes events in the transcript of an chat that has\n ended, note that chat transcripts contain the following event content types if the event\n has occurred during the chat session:

\n
    \n
  • \n

    \n application/vnd.amazonaws.connect.event.participant.left\n

    \n
  • \n
  • \n

    \n application/vnd.amazonaws.connect.event.participant.joined\n

    \n
  • \n
  • \n

    \n application/vnd.amazonaws.connect.event.chat.ended\n

    \n
  • \n
  • \n

    \n application/vnd.amazonaws.connect.event.transfer.succeeded\n

    \n
  • \n
  • \n

    \n application/vnd.amazonaws.connect.event.transfer.failed\n

    \n
  • \n
\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", + "smithy.api#documentation": "

Retrieves a transcript of the session, including details about any attachments. For\n information about accessing past chat contact transcripts for a persistent chat, see\n Enable persistent chat.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n

If you have a process that consumes events in the transcript of an chat that has\n ended, note that chat transcripts contain the following event content types if the event\n has occurred during the chat session:

\n
    \n
  • \n

    \n application/vnd.amazonaws.connect.event.participant.invited\n

    \n
  • \n
  • \n

    \n application/vnd.amazonaws.connect.event.participant.joined\n

    \n
  • \n
  • \n

    \n application/vnd.amazonaws.connect.event.participant.left\n

    \n
  • \n
  • \n

    \n application/vnd.amazonaws.connect.event.chat.ended\n

    \n
  • \n
  • \n

    \n application/vnd.amazonaws.connect.event.transfer.succeeded\n

    \n
  • \n
  • \n

    \n application/vnd.amazonaws.connect.event.transfer.failed\n

    \n
  • \n
\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", "smithy.api#http": { "method": "POST", "uri": "/participant/transcript", @@ -1723,6 +1728,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.connectparticipant#GuidString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$" + } + }, "com.amazonaws.connectparticipant#ISO8601Datetime": { "type": "string" }, @@ -1831,6 +1842,12 @@ "smithy.api#documentation": "

An item - message or event - that has been sent.

" } }, + "com.amazonaws.connectparticipant#JoinToken": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.connectparticipant#MaxResults": { "type": "integer", "traits": { @@ -1841,6 +1858,37 @@ } } }, + "com.amazonaws.connectparticipant#MeetingFeatureStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" + } + } + } + }, + "com.amazonaws.connectparticipant#MeetingFeaturesConfiguration": { + "type": "structure", + "members": { + "Audio": { + "target": "com.amazonaws.connectparticipant#AudioFeatures", + "traits": { + "smithy.api#documentation": "

The configuration settings for the audio features available to a meeting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration settings of the features available to a meeting.

" + } + }, "com.amazonaws.connectparticipant#Message": { "type": "string" }, @@ -2137,7 +2185,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

The application/vnd.amazonaws.connect.event.connection.acknowledged\n ContentType will no longer be supported starting December 31, 2024. This event has\n been migrated to the CreateParticipantConnection API using the\n ConnectParticipant field.

\n
\n

Sends an event. Message receipts are not supported when there are more than two active\n participants in the chat. Using the SendEvent API for message receipts when a supervisor\n is barged-in will result in a conflict exception.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", + "smithy.api#documentation": "\n

The application/vnd.amazonaws.connect.event.connection.acknowledged\n ContentType is no longer maintained since December 31, 2024. This event has been\n migrated to the CreateParticipantConnection API using the\n ConnectParticipant field.

\n
\n

Sends an event. Message receipts are not supported when there are more than two active\n participants in the chat. Using the SendEvent API for message receipts when a supervisor\n is barged-in will result in a conflict exception.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", "smithy.api#http": { "method": "POST", "uri": "/participant/event", @@ -2151,7 +2199,7 @@ "ContentType": { "target": "com.amazonaws.connectparticipant#ChatContentType", "traits": { - "smithy.api#documentation": "

The content type of the request. Supported types are:

\n
    \n
  • \n

    application/vnd.amazonaws.connect.event.typing

    \n
  • \n
  • \n

    application/vnd.amazonaws.connect.event.connection.acknowledged (will be\n deprecated on December 31, 2024)

    \n
  • \n
  • \n

    application/vnd.amazonaws.connect.event.message.delivered

    \n
  • \n
  • \n

    application/vnd.amazonaws.connect.event.message.read

    \n
  • \n
", + "smithy.api#documentation": "

The content type of the request. Supported types are:

\n
    \n
  • \n

    application/vnd.amazonaws.connect.event.typing

    \n
  • \n
  • \n

    application/vnd.amazonaws.connect.event.connection.acknowledged (is no longer\n maintained since December 31, 2024)

    \n
  • \n
  • \n

    application/vnd.amazonaws.connect.event.message.delivered

    \n
  • \n
  • \n

    application/vnd.amazonaws.connect.event.message.read

    \n
  • \n
", "smithy.api#required": {} } }, @@ -2224,7 +2272,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends a message.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", + "smithy.api#documentation": "

Sends a message.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", "smithy.api#http": { "method": "POST", "uri": "/participant/message", @@ -2238,7 +2286,7 @@ "ContentType": { "target": "com.amazonaws.connectparticipant#ChatContentType", "traits": { - "smithy.api#documentation": "

The type of the content. Supported types are text/plain,\n text/markdown, application/json, and\n application/vnd.amazonaws.connect.message.interactive.response.

", + "smithy.api#documentation": "

The type of the content. Possible types are text/plain,\n text/markdown, application/json, and\n application/vnd.amazonaws.connect.message.interactive.response.\n

\n

Supported types on the contact are configured through\n SupportedMessagingContentTypes on StartChatContact\n and StartOutboundChatContact.

\n

For Apple Messages for Business, SMS, and WhatsApp Business Messaging contacts, only\n text/plain is supported.

", "smithy.api#required": {} } }, @@ -2357,7 +2405,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to\n S3.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", + "smithy.api#documentation": "

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to\n S3.

\n

For security recommendations, see Amazon Connect Chat security best practices.

\n \n

\n ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n
\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", "smithy.api#http": { "method": "POST", "uri": "/participant/start-attachment-upload", @@ -2480,6 +2528,15 @@ "target": "com.amazonaws.connectparticipant#Item" } }, + "com.amazonaws.connectparticipant#URI": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, "com.amazonaws.connectparticipant#URLExpiryInSeconds": { "type": "integer", "traits": { @@ -2693,6 +2750,78 @@ "com.amazonaws.connectparticipant#ViewVersion": { "type": "integer" }, + "com.amazonaws.connectparticipant#WebRTCConnection": { + "type": "structure", + "members": { + "Attendee": { + "target": "com.amazonaws.connectparticipant#Attendee" + }, + "Meeting": { + "target": "com.amazonaws.connectparticipant#WebRTCMeeting", + "traits": { + "smithy.api#documentation": "

A meeting created using the Amazon Chime SDK.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates the participant’s WebRTC connection data required for the client application\n (mobile or web) to connect to the call.

" + } + }, + "com.amazonaws.connectparticipant#WebRTCMediaPlacement": { + "type": "structure", + "members": { + "AudioHostUrl": { + "target": "com.amazonaws.connectparticipant#URI", + "traits": { + "smithy.api#documentation": "

The audio host URL.

" + } + }, + "AudioFallbackUrl": { + "target": "com.amazonaws.connectparticipant#URI", + "traits": { + "smithy.api#documentation": "

The audio fallback URL.

" + } + }, + "SignalingUrl": { + "target": "com.amazonaws.connectparticipant#URI", + "traits": { + "smithy.api#documentation": "

The signaling URL.

" + } + }, + "EventIngestionUrl": { + "target": "com.amazonaws.connectparticipant#URI", + "traits": { + "smithy.api#documentation": "

The event ingestion URL to which you send client meeting events.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of endpoints used by clients to connect to the media service group for an\n Amazon Chime SDK meeting.

" + } + }, + "com.amazonaws.connectparticipant#WebRTCMeeting": { + "type": "structure", + "members": { + "MediaPlacement": { + "target": "com.amazonaws.connectparticipant#WebRTCMediaPlacement", + "traits": { + "smithy.api#documentation": "

The media placement for the meeting.

" + } + }, + "MeetingFeatures": { + "target": "com.amazonaws.connectparticipant#MeetingFeaturesConfiguration" + }, + "MeetingId": { + "target": "com.amazonaws.connectparticipant#GuidString", + "traits": { + "smithy.api#documentation": "

The Amazon Chime SDK meeting ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A meeting created using the Amazon Chime SDK.

" + } + }, "com.amazonaws.connectparticipant#Websocket": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/controlcatalog.json b/codegen/sdk/aws-models/controlcatalog.json index b27abeff5f2..b92470ea8e4 100644 --- a/codegen/sdk/aws-models/controlcatalog.json +++ b/codegen/sdk/aws-models/controlcatalog.json @@ -815,17 +815,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -839,17 +828,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -863,17 +841,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -887,17 +854,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/controltower.json b/codegen/sdk/aws-models/controltower.json index e8b1fd30156..0602692e407 100644 --- a/codegen/sdk/aws-models/controltower.json +++ b/codegen/sdk/aws-models/controltower.json @@ -762,17 +762,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -786,17 +775,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -810,17 +788,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -834,17 +801,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/cost-and-usage-report-service.json b/codegen/sdk/aws-models/cost-and-usage-report-service.json index d1418ece5c5..e7e47afe6b4 100644 --- a/codegen/sdk/aws-models/cost-and-usage-report-service.json +++ b/codegen/sdk/aws-models/cost-and-usage-report-service.json @@ -555,17 +555,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -579,17 +568,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -603,17 +581,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -627,17 +594,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/cost-explorer.json b/codegen/sdk/aws-models/cost-explorer.json index 27b9639b7a8..2ee534dcff6 100644 --- a/codegen/sdk/aws-models/cost-explorer.json +++ b/codegen/sdk/aws-models/cost-explorer.json @@ -608,6 +608,56 @@ }, "type": "endpoint" }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-eusc" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://ce.eusc-de-east-1.api.amazonwebservices.eu", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eusc-de-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [ { @@ -1146,17 +1196,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1178,17 +1217,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1210,17 +1238,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1242,17 +1259,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1274,17 +1280,6 @@ "UseDualStack": false } }, - { - "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": { @@ -1306,17 +1301,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1339,18 +1323,28 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://ce-fips.us-isof-south-1.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -1361,43 +1355,53 @@ } ] }, - "url": "https://ce-fips.us-isof-south-1.csp.hci.ic.gov" + "url": "https://ce.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eusc-de-east-1" + } + ] + }, + "url": "https://ce-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingRegion": "us-isof-south-1" + "signingRegion": "eusc-de-east-1" } ] }, - "url": "https://ce.us-isof-south-1.csp.hci.ic.gov" + "url": "https://ce.eusc-de-east-1.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } @@ -1977,6 +1981,18 @@ "smithy.api#pattern": "^arn:aws[a-z-]*:(billing)::[0-9]{12}:billingview/[-a-zA-Z0-9/:_+=.-@]{1,43}$" } }, + "com.amazonaws.costexplorer#BillingViewHealthStatusException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.costexplorer#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\n The billing view status must be HEALTHY to perform this action. Try again when the status is HEALTHY.\n

", + "smithy.api#error": "client" + } + }, "com.amazonaws.costexplorer#CommitmentPurchaseAnalysisConfiguration": { "type": "structure", "members": { @@ -2833,7 +2849,7 @@ "Type": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The category or classification of the cost driver.

\n

Values include: BUNDLED_DISCOUNT, CREDIT, OUT_OF_CYCLE_CHARGE, REFUND,\n RECURRING_RESERVATION_FEE, RESERVATION_USAGE, RI_VOLUME_DISCOUNT, SAVINGS_PLAN_USAGE,\n SAVINGS_PLAN_NEGATION, SAVINGS_PLAN_RECURRING_FEE, SUPPORT_FEE, TAX,\n UPFRONT_RESERVATION_FEE, USAGE_CHANGE, COMMITMENT

" + "smithy.api#documentation": "

The category or classification of the cost driver.

\n

Values include: BUNDLED_DISCOUNT, CREDIT, OUT_OF_CYCLE_CHARGE, REFUND,\n RECURRING_RESERVATION_FEE, RESERVATION_USAGE, RI_VOLUME_DISCOUNT, SAVINGS_PLAN_USAGE,\n SAVINGS_PLAN_RECURRING_FEE, SUPPORT_FEE, TAX, UPFRONT_RESERVATION_FEE, USAGE_CHANGE,\n COMMITMENT

" } }, "Name": { @@ -3518,6 +3534,12 @@ "smithy.api#enumValue": "LINKED_ACCOUNT" } }, + "PAYER_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAYER_ACCOUNT" + } + }, "LINKED_ACCOUNT_NAME": { "target": "smithy.api#Unit", "traits": { @@ -4886,6 +4908,9 @@ { "target": "com.amazonaws.costexplorer#BillExpirationException" }, + { + "target": "com.amazonaws.costexplorer#BillingViewHealthStatusException" + }, { "target": "com.amazonaws.costexplorer#DataUnavailableException" }, @@ -4915,6 +4940,9 @@ "target": "com.amazonaws.costexplorer#GetCostAndUsageComparisonsResponse" }, "errors": [ + { + "target": "com.amazonaws.costexplorer#BillingViewHealthStatusException" + }, { "target": "com.amazonaws.costexplorer#DataUnavailableException" }, @@ -5117,6 +5145,9 @@ { "target": "com.amazonaws.costexplorer#BillExpirationException" }, + { + "target": "com.amazonaws.costexplorer#BillingViewHealthStatusException" + }, { "target": "com.amazonaws.costexplorer#DataUnavailableException" }, @@ -5234,6 +5265,9 @@ { "target": "com.amazonaws.costexplorer#BillExpirationException" }, + { + "target": "com.amazonaws.costexplorer#BillingViewHealthStatusException" + }, { "target": "com.amazonaws.costexplorer#DataUnavailableException" }, @@ -5353,6 +5387,9 @@ "target": "com.amazonaws.costexplorer#GetCostComparisonDriversResponse" }, "errors": [ + { + "target": "com.amazonaws.costexplorer#BillingViewHealthStatusException" + }, { "target": "com.amazonaws.costexplorer#DataUnavailableException" }, @@ -5461,6 +5498,9 @@ "target": "com.amazonaws.costexplorer#GetCostForecastResponse" }, "errors": [ + { + "target": "com.amazonaws.costexplorer#BillingViewHealthStatusException" + }, { "target": "com.amazonaws.costexplorer#DataUnavailableException" }, @@ -5554,6 +5594,9 @@ { "target": "com.amazonaws.costexplorer#BillExpirationException" }, + { + "target": "com.amazonaws.costexplorer#BillingViewHealthStatusException" + }, { "target": "com.amazonaws.costexplorer#DataUnavailableException" }, @@ -6550,6 +6593,9 @@ { "target": "com.amazonaws.costexplorer#BillExpirationException" }, + { + "target": "com.amazonaws.costexplorer#BillingViewHealthStatusException" + }, { "target": "com.amazonaws.costexplorer#DataUnavailableException" }, @@ -6668,6 +6714,9 @@ "target": "com.amazonaws.costexplorer#GetUsageForecastResponse" }, "errors": [ + { + "target": "com.amazonaws.costexplorer#BillingViewHealthStatusException" + }, { "target": "com.amazonaws.costexplorer#DataUnavailableException" }, diff --git a/codegen/sdk/aws-models/cost-optimization-hub.json b/codegen/sdk/aws-models/cost-optimization-hub.json index 4ecfb52f46b..c3518e9ad16 100644 --- a/codegen/sdk/aws-models/cost-optimization-hub.json +++ b/codegen/sdk/aws-models/cost-optimization-hub.json @@ -841,17 +841,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -865,17 +854,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -889,17 +867,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -913,17 +880,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/customer-profiles.json b/codegen/sdk/aws-models/customer-profiles.json index b3f8d88f1fe..0bd8979d329 100644 --- a/codegen/sdk/aws-models/customer-profiles.json +++ b/codegen/sdk/aws-models/customer-profiles.json @@ -42,6 +42,65 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.customerprofiles#ActionType": { + "type": "enum", + "members": { + "ADDED_PROFILE_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDED_PROFILE_KEY" + } + }, + "DELETED_PROFILE_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED_PROFILE_KEY" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED" + } + }, + "INGESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INGESTED" + } + }, + "DELETED_BY_CUSTOMER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED_BY_CUSTOMER" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "MERGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MERGED" + } + }, + "DELETED_BY_MERGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED_BY_MERGE" + } + } + } + }, "com.amazonaws.customerprofiles#AddProfileKey": { "type": "operation", "input": { @@ -3113,6 +3172,9 @@ { "target": "com.amazonaws.customerprofiles#GetMatches" }, + { + "target": "com.amazonaws.customerprofiles#GetProfileHistoryRecord" + }, { "target": "com.amazonaws.customerprofiles#GetProfileObjectType" }, @@ -3179,6 +3241,9 @@ { "target": "com.amazonaws.customerprofiles#ListProfileAttributeValues" }, + { + "target": "com.amazonaws.customerprofiles#ListProfileHistoryRecords" + }, { "target": "com.amazonaws.customerprofiles#ListProfileObjects" }, @@ -3849,17 +3914,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3873,17 +3927,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3897,17 +3940,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3921,17 +3953,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -7379,6 +7400,132 @@ "smithy.api#output": {} } }, + "com.amazonaws.customerprofiles#GetProfileHistoryRecord": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#GetProfileHistoryRecordRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#GetProfileHistoryRecordResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a history record for a specific profile, for a specific domain.

", + "smithy.api#http": { + "method": "GET", + "uri": "/domains/{DomainName}/profiles/{ProfileId}/history-records/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#GetProfileHistoryRecordRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain for which to return a profile history record.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProfileId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

The unique identifier of the profile for which to return a history record.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

The unique identifier of the profile history record to return.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.customerprofiles#GetProfileHistoryRecordResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

The unique identifier of the profile history record.

", + "smithy.api#required": {} + } + }, + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the profile history record was created.

", + "smithy.api#required": {} + } + }, + "LastUpdatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the profile history record was last updated.

" + } + }, + "ActionType": { + "target": "com.amazonaws.customerprofiles#ActionType", + "traits": { + "smithy.api#documentation": "

The action type of the profile history record.

", + "smithy.api#required": {} + } + }, + "ProfileObjectUniqueKey": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The unique identifier of the profile object generated by the service.

" + } + }, + "Content": { + "target": "com.amazonaws.customerprofiles#stringifiedJson", + "traits": { + "smithy.api#documentation": "

A string containing the customer profile, profile object, or profile key content.

" + } + }, + "PerformedBy": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the person or service principal who performed the action.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.customerprofiles#GetProfileObjectType": { "type": "operation", "input": { @@ -7664,7 +7811,8 @@ "method": "GET", "uri": "/domains/{DomainName}/segment-definitions/{SegmentDefinitionName}", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.customerprofiles#GetSegmentDefinitionRequest": { @@ -8240,7 +8388,8 @@ "method": "GET", "uri": "/domains/{DomainName}/upload-jobs/{JobId}", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.customerprofiles#GetUploadJobPath": { @@ -8274,7 +8423,8 @@ "method": "GET", "uri": "/domains/{DomainName}/upload-jobs/{JobId}/path", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.customerprofiles#GetUploadJobPathRequest": { @@ -10267,6 +10417,115 @@ } } }, + "com.amazonaws.customerprofiles#ListProfileHistoryRecords": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#ListProfileHistoryRecordsRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#ListProfileHistoryRecordsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of history records for a specific profile, for a specific domain.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}/profiles/history-records", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#ListProfileHistoryRecordsRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain for which to return profile history records.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProfileId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the profile to be taken.

", + "smithy.api#required": {} + } + }, + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

Applies a filter to include profile history records only with the specified ObjectTypeName value in the response.

" + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.customerprofiles#maxSize100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "max-results" + } + }, + "ActionType": { + "target": "com.amazonaws.customerprofiles#ActionType", + "traits": { + "smithy.api#documentation": "

Applies a filter to include profile history records only with the specified ActionType value in the response.

" + } + }, + "PerformedBy": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

Applies a filter to include profile history records only with the specified PerformedBy value in the response. The PerformedBy value can be the Amazon Resource Name (ARN) of the person or service principal who performed the action.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.customerprofiles#ListProfileHistoryRecordsResponse": { + "type": "structure", + "members": { + "ProfileHistoryRecords": { + "target": "com.amazonaws.customerprofiles#ProfileHistoryRecords", + "traits": { + "smithy.api#documentation": "

The list of profile history records.

" + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.customerprofiles#ListProfileObjectTypeItem": { "type": "structure", "members": { @@ -10762,7 +11021,8 @@ "outputToken": "NextToken", "items": "Items", "pageSize": "MaxResults" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.customerprofiles#ListSegmentDefinitionsRequest": { @@ -10912,7 +11172,8 @@ "outputToken": "NextToken", "items": "Items", "pageSize": "MaxResults" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.customerprofiles#ListUploadJobsRequest": { @@ -12346,6 +12607,66 @@ "smithy.api#documentation": "

Object to hold the dimensions of a profile's fields to segment on.

" } }, + "com.amazonaws.customerprofiles#ProfileHistoryRecord": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

The unique identifier of the profile history record.

", + "smithy.api#required": {} + } + }, + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the profile history record was created.

", + "smithy.api#required": {} + } + }, + "LastUpdatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the profile history record was last updated.

" + } + }, + "ActionType": { + "target": "com.amazonaws.customerprofiles#ActionType", + "traits": { + "smithy.api#documentation": "

The action type of the profile history record.

", + "smithy.api#required": {} + } + }, + "ProfileObjectUniqueKey": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The unique identifier of the profile object generated by the service.

" + } + }, + "PerformedBy": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the person or service principal who performed the action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains profile history record metadata.

" + } + }, + "com.amazonaws.customerprofiles#ProfileHistoryRecords": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#ProfileHistoryRecord" + } + }, "com.amazonaws.customerprofiles#ProfileId": { "type": "string" }, diff --git a/codegen/sdk/aws-models/data-pipeline.json b/codegen/sdk/aws-models/data-pipeline.json index 20f6e96b81b..ae406e83a5d 100644 --- a/codegen/sdk/aws-models/data-pipeline.json +++ b/codegen/sdk/aws-models/data-pipeline.json @@ -836,17 +836,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -860,28 +849,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -895,17 +862,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/database-migration-service.json b/codegen/sdk/aws-models/database-migration-service.json index 17ba4e22c5e..b9cd13b080c 100644 --- a/codegen/sdk/aws-models/database-migration-service.json +++ b/codegen/sdk/aws-models/database-migration-service.json @@ -1457,28 +1457,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1505,28 +1483,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -3205,7 +3161,7 @@ "KmsKeyArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that is used to encrypt \n the connection parameters for the instance profile.

\n

If you don't specify a value for the KmsKeyArn parameter, then\n DMS uses your default encryption key.

\n

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that is used to encrypt \n the connection parameters for the instance profile.

\n

If you don't specify a value for the KmsKeyArn parameter, then\n DMS uses an Amazon Web Services owned encryption key to encrypt your resources.

" } }, "PubliclyAccessible": { @@ -11447,7 +11403,7 @@ "KmsKeyArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that is used to encrypt \n the connection parameters for the instance profile.

\n

If you don't specify a value for the KmsKeyArn parameter, then\n DMS uses your default encryption key.

\n

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account \n has a different default encryption key for each Amazon Web Services Region.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that is used to encrypt \n the connection parameters for the instance profile.

\n

If you don't specify a value for the KmsKeyArn parameter, then\n DMS uses an Amazon Web Services owned encryption key to encrypt your resources.

" } }, "PubliclyAccessible": { @@ -13258,7 +13214,7 @@ "KmsKeyArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that is used to encrypt \n the connection parameters for the instance profile.

\n

If you don't specify a value for the KmsKeyArn parameter, then\n DMS uses your default encryption key.

\n

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that is used to encrypt \n the connection parameters for the instance profile.

\n

If you don't specify a value for the KmsKeyArn parameter, then\n DMS uses an Amazon Web Services owned encryption key to encrypt your resources.

" } }, "PubliclyAccessible": { diff --git a/codegen/sdk/aws-models/databrew.json b/codegen/sdk/aws-models/databrew.json index a53b8ffad7c..efbd6a87603 100644 --- a/codegen/sdk/aws-models/databrew.json +++ b/codegen/sdk/aws-models/databrew.json @@ -944,17 +944,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -968,17 +957,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -992,17 +970,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1016,17 +983,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/dataexchange.json b/codegen/sdk/aws-models/dataexchange.json index 7fc506bce14..6c5deec1f97 100644 --- a/codegen/sdk/aws-models/dataexchange.json +++ b/codegen/sdk/aws-models/dataexchange.json @@ -2116,17 +2116,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2140,17 +2129,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2164,17 +2142,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2188,17 +2155,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/datasync.json b/codegen/sdk/aws-models/datasync.json index 2c34816f4df..7f82b2a25f5 100644 --- a/codegen/sdk/aws-models/datasync.json +++ b/codegen/sdk/aws-models/datasync.json @@ -3273,6 +3273,12 @@ "traits": { "smithy.api#enumValue": "FIPS" } + }, + "FIPS_PRIVATE_LINK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIPS_PRIVATE_LINK" + } } } }, @@ -4353,17 +4359,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4377,17 +4372,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4401,17 +4385,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4425,17 +4398,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/datazone.json b/codegen/sdk/aws-models/datazone.json index 7df080057ac..696df1cbec5 100644 --- a/codegen/sdk/aws-models/datazone.json +++ b/codegen/sdk/aws-models/datazone.json @@ -8,14 +8,14 @@ "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Specifies the target (for example, a column name) where a prediction can be\n accepted.

", + "smithy.api#documentation": "

Specifies the target (for example, a column name) where a prediction can be accepted.

", "smithy.api#required": {} } }, "predictionChoice": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Specifies the prediction (aka, the automatically generated piece of metadata) that can\n be accepted.

" + "smithy.api#documentation": "

Specifies the prediction (aka, the automatically generated piece of metadata) that can be accepted.

" } }, "editedValue": { @@ -26,7 +26,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the prediction (aka, the automatically generated piece of metadata) and the\n target (for example, a column name) that can be accepted.

" + "smithy.api#documentation": "

Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted.

" } }, "com.amazonaws.datazone#AcceptChoices": { @@ -64,7 +64,7 @@ } ], "traits": { - "smithy.api#documentation": "

Accepts automatically generated business-friendly metadata for your Amazon DataZone\n assets.

", + "smithy.api#documentation": "

Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -108,13 +108,13 @@ "acceptChoices": { "target": "com.amazonaws.datazone#AcceptChoices", "traits": { - "smithy.api#documentation": "

Specifies the prediction (aka, the automatically generated piece of metadata) and the\n target (for example, a column name) that can be accepted.

" + "smithy.api#documentation": "

Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted.

" } }, "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure idempotency of the request. This field is\n automatically populated if not provided.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

", "smithy.api#idempotencyToken": {} } } @@ -164,7 +164,7 @@ "threshold": { "target": "smithy.api#Float", "traits": { - "smithy.api#documentation": "

The confidence score that specifies the condition at which a prediction can be\n accepted.

" + "smithy.api#documentation": "

The confidence score that specifies the condition at which a prediction can be accepted.

" } } }, @@ -249,7 +249,7 @@ "decisionComment": { "target": "com.amazonaws.datazone#DecisionComment", "traits": { - "smithy.api#documentation": "

A description that specifies the reason for accepting the specified subscription\n request.

" + "smithy.api#documentation": "

A description that specifies the reason for accepting the specified subscription request.

" } }, "assetScopes": { @@ -289,7 +289,7 @@ "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Amazon DataZone domain where the specified subscription request\n was accepted.

", + "smithy.api#documentation": "

The unique identifier of the Amazon DataZone domain where the specified subscription request was accepted.

", "smithy.api#required": {} } }, @@ -324,7 +324,7 @@ "subscribedPrincipals": { "target": "com.amazonaws.datazone#SubscribedPrincipals", "traits": { - "smithy.api#documentation": "

Specifies the Amazon DataZone users who are subscribed to the asset specified in the\n subscription request.

", + "smithy.api#documentation": "

Specifies the Amazon DataZone users who are subscribed to the asset specified in the subscription request.

", "smithy.api#length": { "min": 1, "max": 1 @@ -416,6 +416,151 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.datazone#AccountInfo": { + "type": "structure", + "members": { + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The account ID.

", + "smithy.api#required": {} + } + }, + "supportedRegions": { + "target": "com.amazonaws.datazone#AwsRegionList", + "traits": { + "smithy.api#documentation": "

The regions supported for an account within an account pool.

", + "smithy.api#required": {} + } + }, + "awsAccountName": { + "target": "com.amazonaws.datazone#AwsAccountName", + "traits": { + "smithy.api#documentation": "

The account name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The account information within an account pool.

" + } + }, + "com.amazonaws.datazone#AccountInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#AccountInfo" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.datazone#AccountPoolId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#AccountPoolList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#AccountPoolId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.datazone#AccountPoolName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w -]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#AccountPoolSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#AccountPoolSummary" + } + }, + "com.amazonaws.datazone#AccountPoolSummary": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain.

" + } + }, + "id": { + "target": "com.amazonaws.datazone#AccountPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the account pool.

" + } + }, + "name": { + "target": "com.amazonaws.datazone#AccountPoolName", + "traits": { + "smithy.api#documentation": "

The name of the account pool.

" + } + }, + "resolutionStrategy": { + "target": "com.amazonaws.datazone#ResolutionStrategy", + "traits": { + "smithy.api#documentation": "

The mechanism used to resolve the account selection from the account pool.

" + } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain unit.

" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the account pool.

" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "

The user who updated the account pool.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary of the account pool.

" + } + }, + "com.amazonaws.datazone#AccountSource": { + "type": "union", + "members": { + "accounts": { + "target": "com.amazonaws.datazone#AccountInfoList", + "traits": { + "smithy.api#documentation": "

The static list of accounts within an account pool.

" + } + }, + "customAccountPoolHandler": { + "target": "com.amazonaws.datazone#CustomAccountPoolHandler", + "traits": { + "smithy.api#documentation": "

The custom Amazon Web Services Lambda handler within an account pool.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.

" + } + }, "com.amazonaws.datazone#ActionLink": { "type": "string", "traits": { @@ -517,7 +662,7 @@ "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -562,7 +707,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a policy grant (an authorization policy) to a specified entity, including domain\n units, environment blueprint configurations, or environment profiles.

", + "smithy.api#documentation": "

Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -625,7 +770,7 @@ "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -636,7 +781,14 @@ }, "com.amazonaws.datazone#AddPolicyGrantOutput": { "type": "structure", - "members": {}, + "members": { + "grantId": { + "target": "com.amazonaws.datazone#GrantIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the policy grant that was added to a specified entity.

" + } + } + }, "traits": { "smithy.api#output": {} } @@ -695,7 +847,7 @@ "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.

" + "smithy.api#documentation": "

The display value of the aggregation list item. Supported values include value and glossaryTerm.name.

" } } }, @@ -747,7 +899,7 @@ "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.

" + "smithy.api#documentation": "

The display value of the aggregation. If the attribute being aggregated corresponds to the id of a public resource, the service automatically resolves the id to the provided display value.

" } } }, @@ -857,6 +1009,9 @@ }, "firstRevisionCreatedBy": { "target": "com.amazonaws.datazone#CreatedBy" + }, + "governedGlossaryTerms": { + "target": "com.amazonaws.datazone#GovernedGlossaryTerms" } }, "create": { @@ -1108,6 +1263,16 @@ "traits": { "smithy.api#documentation": "

The additional attributes of a Amazon DataZone inventory asset.

" } + }, + "governedGlossaryTerms": { + "target": "com.amazonaws.datazone#GovernedGlossaryTerms", + "traits": { + "smithy.api#documentation": "

The restricted glossary terms accociated with an asset.

", + "smithy.api#length": { + "min": 0, + "max": 20 + } + } } }, "traits": { @@ -1137,7 +1302,7 @@ "latestTimeSeriesDataPointFormsOutput": { "target": "com.amazonaws.datazone#TimeSeriesDataPointSummaryFormOutputList", "traits": { - "smithy.api#documentation": "

The latest time series data points forms included in the additional attributes of an\n asset.

" + "smithy.api#documentation": "

The latest time series data points forms included in the additional attributes of an asset.

" } }, "matchRationale": { @@ -1187,7 +1352,7 @@ "latestTimeSeriesDataPointForms": { "target": "com.amazonaws.datazone#TimeSeriesDataPointSummaryFormOutputList", "traits": { - "smithy.api#documentation": "

The latest time series data points forms included in the additional attributes of an\n asset.

" + "smithy.api#documentation": "

The latest time series data points forms included in the additional attributes of an asset.

" } }, "glossaryTerms": { @@ -1196,10 +1361,20 @@ "smithy.api#documentation": "

The glossary terms attached to an asset published in an Amazon DataZone catalog.

" } }, + "governedGlossaryTerms": { + "target": "com.amazonaws.datazone#DetailedGlossaryTerms", + "traits": { + "smithy.api#documentation": "

The restricted glossary terms associated with an asset.

", + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "owningProjectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The identifier of the project where an asset published in an Amazon DataZone catalog exists.\n

" + "smithy.api#documentation": "

The identifier of the project where an asset published in an Amazon DataZone catalog exists.

" } } }, @@ -1298,6 +1473,16 @@ "smithy.api#documentation": "

Glossary terms attached to the inventory asset.

" } }, + "governedGlossaryTerms": { + "target": "com.amazonaws.datazone#DetailedGlossaryTerms", + "traits": { + "smithy.api#documentation": "

The restricted glossary terms associated with an asset.

", + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "owningProjectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { @@ -1333,7 +1518,7 @@ "latestTimeSeriesDataPointForms": { "target": "com.amazonaws.datazone#TimeSeriesDataPointSummaryFormOutputList", "traits": { - "smithy.api#documentation": "

The latest time series data points forms included in the additional attributes of an\n asset.

" + "smithy.api#documentation": "

The latest time series data points forms included in the additional attributes of an asset.

" } } }, @@ -1584,7 +1769,7 @@ "originDomainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain where the asset type was originally\n created.

" + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain where the asset type was originally created.

" } }, "originProjectId": { @@ -1719,6 +1904,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#AssociateGovernedTerms": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#AssociateGovernedTermsInput" + }, + "output": { + "target": "com.amazonaws.datazone#AssociateGovernedTermsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates governed terms with an asset.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/associate-governed-terms" + } + } + }, + "com.amazonaws.datazone#AssociateGovernedTermsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where governed terms are to be associated with an asset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityIdentifier": { + "target": "com.amazonaws.datazone#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the asset with which you want to associate a governed term.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.datazone#GovernedEntityType", + "traits": { + "smithy.api#documentation": "

The type of the asset with which you want to associate a governed term.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "governedGlossaryTerms": { + "target": "com.amazonaws.datazone#GovernedGlossaryTerms", + "traits": { + "smithy.api#documentation": "

The glossary terms in a restricted glossary.

", + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#AssociateGovernedTermsOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#AthenaPropertiesInput": { "type": "structure", "members": { @@ -1984,6 +2256,16 @@ "smithy.api#pattern": "^\\d{12}$" } }, + "com.amazonaws.datazone#AwsAccountName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.datazone#AwsConsoleLinkParameters": { "type": "structure", "members": { @@ -2037,6 +2319,18 @@ "smithy.api#pattern": "^[a-z]{2}-[a-z]{4,10}-\\d$" } }, + "com.amazonaws.datazone#AwsRegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#AwsRegion" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, "com.amazonaws.datazone#BasicAuthenticationCredentials": { "type": "structure", "members": { @@ -2109,7 +2403,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the metadata generation run.

", + "smithy.api#documentation": "

Cancels the metadata generation run.

Prerequisites:

  • The run must exist and be in a cancelable status (e.g., SUBMITTED, IN_PROGRESS).

  • Runs in SUCCEEDED status cannot be cancelled.

  • User must have access to the run and cancel permissions.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -2123,7 +2417,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the metadata generation run is to be\n cancelled.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the metadata generation run is to be cancelled.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2192,7 +2486,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Amazon DataZone domain where the subscription request is being\n cancelled.

", + "smithy.api#documentation": "

The unique identifier of the Amazon DataZone domain where the subscription request is being cancelled.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2236,7 +2530,7 @@ "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Amazon DataZone domain where the subscription is being\n cancelled.

", + "smithy.api#documentation": "

The unique identifier of the Amazon DataZone domain where the subscription is being cancelled.

", "smithy.api#required": {} } }, @@ -2250,7 +2544,7 @@ "createdAt": { "target": "com.amazonaws.datazone#CreatedAt", "traits": { - "smithy.api#documentation": "

The timestamp that specifies when the request to cancel the subscription was\n created.

", + "smithy.api#documentation": "

The timestamp that specifies when the request to cancel the subscription was created.

", "smithy.api#required": {} } }, @@ -2264,7 +2558,7 @@ "subscribedPrincipal": { "target": "com.amazonaws.datazone#SubscribedPrincipal", "traits": { - "smithy.api#documentation": "

The Amazon DataZone user who is made a subscriber to the specified asset by the subscription\n that is being cancelled.

", + "smithy.api#documentation": "

The Amazon DataZone user who is made a subscriber to the specified asset by the subscription that is being cancelled.

", "smithy.api#required": {} } }, @@ -2278,13 +2572,13 @@ "subscriptionRequestId": { "target": "com.amazonaws.datazone#SubscriptionRequestId", "traits": { - "smithy.api#documentation": "

The unique ID of the subscripton request for the subscription that is being\n cancelled.

" + "smithy.api#documentation": "

The unique ID of the subscripton request for the subscription that is being cancelled.

" } }, "retainPermissions": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the permissions to the asset are retained after the subscription is\n cancelled.

" + "smithy.api#documentation": "

Specifies whether the permissions to the asset are retained after the subscription is cancelled.

" } } }, @@ -2325,7 +2619,7 @@ "templateUrl": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The template URL of the cloud formation provisioning properties of the environment\n blueprint.

", + "smithy.api#documentation": "

The template URL of the cloud formation provisioning properties of the environment blueprint.

", "smithy.api#required": {} } } @@ -2949,6 +3243,167 @@ } } }, + "com.amazonaws.datazone#CreateAccountPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateAccountPoolInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateAccountPoolOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an account pool.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/account-pools" + } + } + }, + "com.amazonaws.datazone#CreateAccountPoolInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where the account pool is created.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#AccountPoolName", + "traits": { + "smithy.api#documentation": "

The name of the account pool.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the account pool.

" + } + }, + "resolutionStrategy": { + "target": "com.amazonaws.datazone#ResolutionStrategy", + "traits": { + "smithy.api#documentation": "

The mechanism used to resolve the account selection from the account pool.

", + "smithy.api#required": {} + } + }, + "accountSource": { + "target": "com.amazonaws.datazone#AccountSource", + "traits": { + "smithy.api#documentation": "

The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateAccountPoolOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where the account pool is created.

" + } + }, + "name": { + "target": "com.amazonaws.datazone#AccountPoolName", + "traits": { + "smithy.api#documentation": "

The name of the account pool.

" + } + }, + "id": { + "target": "com.amazonaws.datazone#AccountPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the account pool.

" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the account pool.

" + } + }, + "resolutionStrategy": { + "target": "com.amazonaws.datazone#ResolutionStrategy", + "traits": { + "smithy.api#documentation": "

The mechanism used to resolve the account selection from the account pool.

" + } + }, + "accountSource": { + "target": "com.amazonaws.datazone#AccountSource", + "traits": { + "smithy.api#documentation": "

The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.

", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the account pool.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the account pool was created.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the account pool was last updated.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "

The user who last updated the account pool.

" + } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where the account pool is created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#CreateAsset": { "type": "operation", "input": { @@ -2981,7 +3436,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an asset in Amazon DataZone catalog.

", + "smithy.api#documentation": "

Creates an asset in Amazon DataZone catalog.

Before creating assets, make sure that the following requirements are met:

  • --domain-identifier must refer to an existing domain.

  • --owning-project-identifier must be a valid project within the domain.

  • Asset type must be created beforehand using create-asset-type, or be a supported system-defined type. For more information, see create-asset-type.

  • --type-revision (if used) must match a valid revision of the asset type.

  • formsInput is required when it is associated as required in the asset-type. For more information, see create-form-type.

  • Form content must include all required fields as per the form schema (e.g., bucketArn).

You must invoke the following pre-requisite commands before invoking this API:

", "smithy.api#http": { "code": 201, "method": "POST", @@ -3022,7 +3477,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a data asset filter.

", + "smithy.api#documentation": "

Creates a data asset filter.

Asset filters provide a sophisticated way to create controlled views of data assets by selecting specific columns or applying row-level filters. This capability is crucial for organizations that need to share data while maintaining security and privacy controls. For example, your database might be filtered to show only non-PII fields to certain users, or sales data might be filtered by region for different regional teams. Asset filters enable fine-grained access control while maintaining a single source of truth.

Prerequisites:

  • A valid domain (--domain-identifier) must exist.

  • A data asset (--asset-identifier) must already be created under that domain.

  • The asset must have the referenced columns available in its schema for column-based filtering.

  • You cannot specify both (columnConfiguration, rowConfiguration)at the same time.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -3073,7 +3528,7 @@ "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -3141,7 +3596,7 @@ "errorMessage": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The error message that is displayed if the asset filter is not created\n successfully.

" + "smithy.api#documentation": "

The error message that is displayed if the asset filter is not created successfully.

" } }, "effectiveColumnNames": { @@ -3182,7 +3637,7 @@ "externalIdentifier": { "target": "com.amazonaws.datazone#ExternalIdentifier", "traits": { - "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.

" + "smithy.api#documentation": "

The external identifier of the asset.

If the value for the externalIdentifier parameter is specified, it must be a unique value.

" } }, "typeIdentifier": { @@ -3226,14 +3681,14 @@ "predictionConfiguration": { "target": "com.amazonaws.datazone#PredictionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration of the automatically generated business-friendly metadata for the\n asset.

", + "smithy.api#documentation": "

The configuration of the automatically generated business-friendly metadata for the asset.

", "smithy.api#notProperty": {} } }, "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -3322,6 +3777,16 @@ "smithy.api#documentation": "

The glossary terms that are attached to the created asset.

" } }, + "governedGlossaryTerms": { + "target": "com.amazonaws.datazone#GovernedGlossaryTerms", + "traits": { + "smithy.api#documentation": "

The glossary terms in a restricted glossary.

", + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "owningProjectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { @@ -3364,7 +3829,7 @@ "predictionConfiguration": { "target": "com.amazonaws.datazone#PredictionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration of the automatically generated business-friendly metadata for the\n asset.

", + "smithy.api#documentation": "

The configuration of the automatically generated business-friendly metadata for the asset.

", "smithy.api#notProperty": {} } } @@ -3402,7 +3867,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a revision of the asset.

", + "smithy.api#documentation": "

Creates a revision of the asset.

Asset revisions represent new versions of existing assets, capturing changes to either the underlying data or its metadata. They maintain a historical record of how assets evolve over time, who made changes, and when those changes occurred. This versioning capability is crucial for governance and compliance, allowing organizations to track changes, understand their impact, and roll back if necessary.

Prerequisites:

  • Asset must already exist in the domain with identifier.

  • formsInput is required when asset has the form type. typeRevision should be the latest version of form type.

  • The form content must include all required fields (e.g., bucketArn for S3ObjectCollectionForm).

  • The owning project of the original asset must still exist and be active.

  • User must have write access to the project and domain.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -3464,14 +3929,14 @@ "predictionConfiguration": { "target": "com.amazonaws.datazone#PredictionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration of the automatically generated business-friendly metadata for the\n asset.

", + "smithy.api#documentation": "

The configuration of the automatically generated business-friendly metadata for the asset.

", "smithy.api#notProperty": {} } }, "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -3560,6 +4025,16 @@ "smithy.api#documentation": "

The glossary terms that were attached to the asset as part of asset revision.

" } }, + "governedGlossaryTerms": { + "target": "com.amazonaws.datazone#GovernedGlossaryTerms", + "traits": { + "smithy.api#documentation": "

The glossary terms in a restricted glossary.

", + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "owningProjectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { @@ -3590,7 +4065,7 @@ "readOnlyFormsOutput": { "target": "com.amazonaws.datazone#FormOutputList", "traits": { - "smithy.api#documentation": "

The read-only metadata forms that were attached to the asset as part of the asset\n revision.

" + "smithy.api#documentation": "

The read-only metadata forms that were attached to the asset as part of the asset revision.

" } }, "latestTimeSeriesDataPointFormsOutput": { @@ -3602,7 +4077,7 @@ "predictionConfiguration": { "target": "com.amazonaws.datazone#PredictionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration of the automatically generated business-friendly metadata for the\n asset.

", + "smithy.api#documentation": "

The configuration of the automatically generated business-friendly metadata for the asset.

", "smithy.api#notProperty": {} } } @@ -3640,7 +4115,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a custom asset type.

", + "smithy.api#documentation": "

Creates a custom asset type.

Prerequisites:

  • The formsInput field is required, however, can be passed as empty (e.g. -forms-input {}).

  • You must have CreateAssetType permissions.

  • The domain-identifier and owning-project-identifier must be valid and active.

  • The name of the asset type must be unique within the domain — duplicate names will cause failure.

  • JSON input must be valid — incorrect formatting causes Invalid JSON errors.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -3654,7 +4129,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Amazon DataZone domain where the custom asset type is being\n created.

", + "smithy.api#documentation": "

The unique identifier of the Amazon DataZone domain where the custom asset type is being created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3824,7 +4299,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new connection. In Amazon DataZone, a connection enables you to connect your\n resources (domains, projects, and environments) to external resources and services.

", + "smithy.api#documentation": "

Creates a new connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -3845,7 +4320,7 @@ "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } }, @@ -3997,7 +4472,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a data product.

", + "smithy.api#documentation": "

Creates a data product.

A data product is a comprehensive package that combines data assets with their associated metadata, documentation, and access controls. It's designed to serve specific business needs or use cases, making it easier for users to find and consume data appropriately. Data products include important information about data quality, freshness, and usage guidelines, effectively bridging the gap between data producers and consumers while ensuring proper governance.

Prerequisites:

  • The domain must exist and be accessible.

  • The owning project must be valid and active.

  • The name must be unique within the domain (no existing data product with the same name).

  • User must have create permissions for data products in the project.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -4058,7 +4533,7 @@ "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -4195,7 +4670,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a data product revision.

", + "smithy.api#documentation": "

Creates a data product revision.

Prerequisites:

  • The original data product must exist in the given domain.

  • User must have permissions on the data product.

  • The domain must be valid and accessible.

  • The new revision name must comply with naming constraints (if required).

", "smithy.api#http": { "code": 201, "method": "POST", @@ -4257,7 +4732,7 @@ "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -4433,7 +4908,7 @@ "projectIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone project in which you want to add this data\n source.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone project in which you want to add this data source.

", "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$", "smithy.api#required": {} } @@ -4441,7 +4916,7 @@ "environmentIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The unique identifier of the Amazon DataZone environment to which the data source publishes\n assets.

", + "smithy.api#documentation": "

The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

", "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" } }, @@ -4455,21 +4930,21 @@ "type": { "target": "com.amazonaws.datazone#DataSourceType", "traits": { - "smithy.api#documentation": "

The type of the data source. In Amazon DataZone, you can use data sources to import\n technical metadata of assets (data) from the source databases or data warehouses into\n Amazon DataZone. In the current release of Amazon DataZone, you can create and run data\n sources for Amazon Web Services Glue and Amazon Redshift.

", + "smithy.api#documentation": "

The type of the data source. In Amazon DataZone, you can use data sources to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. In the current release of Amazon DataZone, you can create and run data sources for Amazon Web Services Glue and Amazon Redshift.

", "smithy.api#required": {} } }, "configuration": { "target": "com.amazonaws.datazone#DataSourceConfigurationInput", "traits": { - "smithy.api#documentation": "

Specifies the configuration of the data source. It can be set to either\n glueRunConfiguration or redshiftRunConfiguration.

", + "smithy.api#documentation": "

Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.

", "smithy.api#notProperty": {} } }, "recommendation": { "target": "com.amazonaws.datazone#RecommendationConfiguration", "traits": { - "smithy.api#documentation": "

Specifies whether the business name generation is to be enabled for this data\n source.

" + "smithy.api#documentation": "

Specifies whether the business name generation is to be enabled for this data source.

" } }, "enableSetting": { @@ -4487,19 +4962,19 @@ "publishOnImport": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the assets that this data source creates in the inventory are to be\n also automatically published to the catalog.

" + "smithy.api#documentation": "

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

" } }, "assetFormsInput": { "target": "com.amazonaws.datazone#FormInputList", "traits": { - "smithy.api#documentation": "

The metadata forms that are to be attached to the assets that this data source works\n with.

" + "smithy.api#documentation": "

The metadata forms that are to be attached to the assets that this data source works with.

" } }, "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -4560,7 +5035,7 @@ "environmentId": { "target": "com.amazonaws.datazone#EnvironmentId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Amazon DataZone environment to which the data source publishes\n assets.

" + "smithy.api#documentation": "

The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

" } }, "connectionId": { @@ -4572,14 +5047,14 @@ "configuration": { "target": "com.amazonaws.datazone#DataSourceConfigurationOutput", "traits": { - "smithy.api#documentation": "

Specifies the configuration of the data source. It can be set to either\n glueRunConfiguration or redshiftRunConfiguration.

", + "smithy.api#documentation": "

Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.

", "smithy.api#notProperty": {} } }, "recommendation": { "target": "com.amazonaws.datazone#RecommendationConfiguration", "traits": { - "smithy.api#documentation": "

Specifies whether the business name generation is to be enabled for this data\n source.

" + "smithy.api#documentation": "

Specifies whether the business name generation is to be enabled for this data source.

" } }, "enableSetting": { @@ -4591,7 +5066,7 @@ "publishOnImport": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the assets that this data source creates in the inventory are to be\n also automatically published to the catalog.

" + "smithy.api#documentation": "

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

" } }, "assetFormsOutput": { @@ -4621,13 +5096,13 @@ "lastRunErrorMessage": { "target": "com.amazonaws.datazone#DataSourceErrorMessage", "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "errorMessage": { "target": "com.amazonaws.datazone#DataSourceErrorMessage", "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "createdAt": { @@ -4716,14 +5191,14 @@ "domainExecutionRole": { "target": "com.amazonaws.datazone#RoleArn", "traits": { - "smithy.api#documentation": "

The domain execution role that is created when an Amazon DataZone domain is created. The\n domain execution role is created in the Amazon Web Services account that houses the\n Amazon DataZone domain.

", + "smithy.api#documentation": "

The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

", "smithy.api#required": {} } }, "kmsKeyIdentifier": { "target": "com.amazonaws.datazone#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Web Services Key Management Service (KMS) key that is used\n to encrypt the Amazon DataZone domain, metadata, and reporting data.

" + "smithy.api#documentation": "

The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

" } }, "tags": { @@ -4747,7 +5222,7 @@ "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -4793,7 +5268,7 @@ "domainExecutionRole": { "target": "com.amazonaws.datazone#RoleArn", "traits": { - "smithy.api#documentation": "

The domain execution role that is created when an Amazon DataZone domain is created. The\n domain execution role is created in the Amazon Web Services account that houses the\n Amazon DataZone domain.

" + "smithy.api#documentation": "

The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

" } }, "arn": { @@ -4805,7 +5280,7 @@ "kmsKeyIdentifier": { "target": "com.amazonaws.datazone#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Web Services Key Management Service (KMS) key that is used\n to encrypt the Amazon DataZone domain, metadata, and reporting data.

" + "smithy.api#documentation": "

The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

" } }, "status": { @@ -4918,7 +5393,7 @@ "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -5074,7 +5549,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an action for the environment, for example, creates a console link for an\n analytics tool that is available in this environment.

", + "smithy.api#documentation": "

Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -5118,7 +5593,7 @@ "description": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The description of the environment action that is being created in the\n environment.

" + "smithy.api#documentation": "

The description of the environment action that is being created in the environment.

" } } }, @@ -5175,6 +5650,162 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#CreateEnvironmentBlueprint": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateEnvironmentBlueprintInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateEnvironmentBlueprintOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Amazon DataZone blueprint.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/environment-blueprints" + } + } + }, + "com.amazonaws.datazone#CreateEnvironmentBlueprintInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The identifier of the domain in which this blueprint is created.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintName", + "traits": { + "smithy.api#documentation": "

The name of this Amazon DataZone blueprint.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the Amazon DataZone blueprint.

" + } + }, + "provisioningProperties": { + "target": "com.amazonaws.datazone#ProvisioningProperties", + "traits": { + "smithy.api#documentation": "

The provisioning properties of this Amazon DataZone blueprint.

", + "smithy.api#required": {} + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#CustomParameterList", + "traits": { + "smithy.api#documentation": "

The user parameters of this Amazon DataZone blueprint.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#CreateEnvironmentBlueprintOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "

The ID of this Amazon DataZone blueprint.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintName", + "traits": { + "smithy.api#documentation": "

The name of this Amazon DataZone blueprint.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of this Amazon DataZone blueprint.

" + } + }, + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The provider of this Amazon DataZone blueprint.

", + "smithy.api#required": {} + } + }, + "provisioningProperties": { + "target": "com.amazonaws.datazone#ProvisioningProperties", + "traits": { + "smithy.api#documentation": "

The provisioning properties of this Amazon DataZone blueprint.

", + "smithy.api#required": {} + } + }, + "deploymentProperties": { + "target": "com.amazonaws.datazone#DeploymentProperties", + "traits": { + "smithy.api#documentation": "

The deployment properties of this Amazon DataZone blueprint.

" + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#CustomParameterList", + "traits": { + "smithy.api#documentation": "

The user parameters of this Amazon DataZone blueprint.

" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "

The glossary terms attached to this Amazon DataZone blueprint.

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the environment blueprint was created.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when this blueprint was updated.

", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#CreateEnvironmentInput": { "type": "structure", "members": { @@ -5209,7 +5840,7 @@ "environmentProfileIdentifier": { "target": "com.amazonaws.datazone#EnvironmentProfileId", "traits": { - "smithy.api#documentation": "

The identifier of the environment profile that is used to create this Amazon DataZone\n environment.

" + "smithy.api#documentation": "

The identifier of the environment profile that is used to create this Amazon DataZone environment.

" } }, "userParameters": { @@ -5321,7 +5952,7 @@ "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", - "smithy.api#documentation": "

The ID of the environment profile with which this Amazon DataZone environment was\n created.

" + "smithy.api#documentation": "

The ID of the environment profile with which this Amazon DataZone environment was created.

" } }, "awsAccountId": { @@ -5529,13 +6160,13 @@ "awsAccountId": { "target": "com.amazonaws.datazone#AwsAccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID in which this Amazon DataZone environment profile is\n created.

" + "smithy.api#documentation": "

The Amazon Web Services account ID in which this Amazon DataZone environment profile is created.

" } }, "awsAccountRegion": { "target": "com.amazonaws.datazone#AwsRegion", "traits": { - "smithy.api#documentation": "

The Amazon Web Services region in which this Amazon DataZone environment profile is\n created.

" + "smithy.api#documentation": "

The Amazon Web Services region in which this Amazon DataZone environment profile is created.

" } }, "createdBy": { @@ -5639,7 +6270,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a metadata form type.

", + "smithy.api#documentation": "

Creates a metadata form type.

Prerequisites:

  • The domain must exist and be in an ENABLED state.

  • The owning project must exist and be accessible.

  • The name must be unique within the domain.

For custom form types, to indicate that a field should be searchable, annotate it with @amazon.datazone#searchable. By default, searchable fields are indexed for semantic search, where related query terms will match the attribute value even if they are not stemmed or keyword matches. To indicate that a field should be indexed for lexical search (which disables semantic search but supports stemmed and partial matches), annotate it with @amazon.datazone#searchable(modes:[\"LEXICAL\"]). To indicate that a field should be indexed for technical identifier search (for more information on technical identifier search, see: https://aws.amazon.com/blogs/big-data/streamline-data-discovery-with-precise-technical-identifier-search-in-amazon-sagemaker-unified-studio/), annotate it with @amazon.datazone#searchable(modes:[\"TECHNICAL\"]).

To denote that a field will store glossary term ids (which are filterable via the Search/SearchListings APIs), annotate it with @amazon.datazone#glossaryterm(\"${GLOSSARY_ID}\"), where ${GLOSSARY_ID} is the id of the glossary that the glossary terms stored in the field belong to.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -5735,13 +6366,13 @@ "originDomainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which this metadata form type was originally\n created.

" + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which this metadata form type was originally created.

" } }, "originProjectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The ID of the project in which this Amazon DataZone metadata form type was originally\n created.

" + "smithy.api#documentation": "

The ID of the project in which this Amazon DataZone metadata form type was originally created.

" } } }, @@ -5792,7 +6423,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon DataZone business glossary.

", + "smithy.api#documentation": "

Creates an Amazon DataZone business glossary.

Specifies that this is a create glossary policy.

A glossary serves as the central repository for business terminology and definitions within an organization. It helps establish and maintain a common language across different departments and teams, reducing miscommunication and ensuring consistent interpretation of business concepts. Glossaries can include hierarchical relationships between terms, cross-references, and links to actual data assets, making them invaluable for both business users and technical teams trying to understand and use data correctly.

Prerequisites:

  • Domain must exist and be in an active state.

  • Owning project must exist and be accessible by the caller.

  • The glossary name must be unique within the domain.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -5838,10 +6469,16 @@ "smithy.api#documentation": "

The status of this business glossary.

" } }, + "usageRestrictions": { + "target": "com.amazonaws.datazone#GlossaryUsageRestrictions", + "traits": { + "smithy.api#documentation": "

The usage restriction of the restricted glossary.

" + } + }, "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -5892,6 +6529,12 @@ "traits": { "smithy.api#documentation": "

The status of this business glossary.

" } + }, + "usageRestrictions": { + "target": "com.amazonaws.datazone#GlossaryUsageRestrictions", + "traits": { + "smithy.api#documentation": "

The usage restriction of the restricted glossary.

" + } } }, "traits": { @@ -5944,7 +6587,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a business glossary term.

", + "smithy.api#documentation": "

Creates a business glossary term.

A glossary term represents an individual entry within the Amazon DataZone glossary, serving as a standardized definition for a specific business concept or data element. Each term can include rich metadata such as detailed definitions, synonyms, related terms, and usage examples. Glossary terms can be linked directly to data assets, providing business context to technical data elements. This linking capability helps users understand the business meaning of data fields and ensures consistent interpretation across different systems and teams. Terms can also have relationships with other terms, creating a semantic network that reflects the complexity of business concepts.

Prerequisites:

  • Domain must exist.

  • Glossary must exist.

  • The term name must be unique within the glossary.

  • Ensure term does not conflict with existing terms in hierarchy.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -6005,7 +6648,7 @@ "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -6069,6 +6712,12 @@ "traits": { "smithy.api#documentation": "

The term relations of this business glossary term.

" } + }, + "usageRestrictions": { + "target": "com.amazonaws.datazone#GlossaryUsageRestrictions", + "traits": { + "smithy.api#documentation": "

The usage restriction of the restricted glossary.

" + } } }, "traits": { @@ -6131,7 +6780,7 @@ "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -6204,7 +6853,7 @@ } ], "traits": { - "smithy.api#documentation": "

Publishes a listing (a record of an asset at a given time) or removes a listing from the\n catalog.

", + "smithy.api#documentation": "

Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -6253,7 +6902,7 @@ "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -6337,13 +6986,13 @@ "includeChildDomainUnits": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether to include child domain units when creating a project from project\n profile policy grant details

" + "smithy.api#documentation": "

Specifies whether to include child domain units when creating a project from project profile policy grant details

" } }, "projectProfiles": { "target": "com.amazonaws.datazone#ProjectProfileList", "traits": { - "smithy.api#documentation": "

Specifies project profiles when creating a project from project profile policy grant\n details

" + "smithy.api#documentation": "

Specifies project profiles when creating a project from project profile policy grant details

" } } }, @@ -6384,7 +7033,7 @@ "domainUnitId": { "target": "com.amazonaws.datazone#DomainUnitId", "traits": { - "smithy.api#documentation": "

The ID of the domain unit. This parameter is not required and if it is not specified,\n then the project is created at the root domain unit level.

" + "smithy.api#documentation": "

The ID of the domain unit. This parameter is not required and if it is not specified, then the project is created at the root domain unit level.

" } }, "projectProfileId": { @@ -6519,7 +7168,7 @@ "failureReasons": { "target": "com.amazonaws.datazone#FailureReasons", "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "createdBy": { @@ -6785,7 +7434,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a rule in Amazon DataZone. A rule is a formal agreement that enforces specific\n requirements across user workflows (e.g., publishing assets to the catalog, requesting\n subscriptions, creating projects) within the Amazon DataZone data portal. These rules help\n maintain consistency, ensure compliance, and uphold governance standards in data management\n processes. For instance, a metadata enforcement rule can specify the required information\n for creating a subscription request or publishing a data asset to the catalog, ensuring\n alignment with organizational standards.

", + "smithy.api#documentation": "

Creates a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -6849,7 +7498,7 @@ "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -7018,7 +7667,7 @@ "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -7184,7 +7833,7 @@ "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } }, @@ -7415,7 +8064,7 @@ "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -7596,7 +8245,7 @@ "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -7680,6 +8329,27 @@ "smithy.api#pattern": "cron\\((\\b[0-5]?[0-9]\\b) (\\b2[0-3]\\b|\\b[0-1]?[0-9]\\b) ([-?*,/\\dLW]){1,83} ([-*,/\\d]|[a-zA-Z]{3}){1,23} ([-?#*,/\\dL]|[a-zA-Z]{3}){1,13} ([^\\)]+)\\)" } }, + "com.amazonaws.datazone#CustomAccountPoolHandler": { + "type": "structure", + "members": { + "lambdaFunctionArn": { + "target": "com.amazonaws.datazone#LambdaFunctionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Amazon Web Services Lambda function for the custom Amazon Web Services Lambda handler.

", + "smithy.api#required": {} + } + }, + "lambdaExecutionRoleArn": { + "target": "com.amazonaws.datazone#LambdaExecutionRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that enables Amazon SageMaker Unified Studio to invoke the Amazon Web Services Lambda funtion if the account source is the custom account pool handler.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The custom Amazon Web Services Lambda handler within an account pool.

" + } + }, "com.amazonaws.datazone#CustomParameter": { "type": "structure", "members": { @@ -7721,6 +8391,12 @@ "traits": { "smithy.api#documentation": "

Specifies whether the custom parameter is optional.

" } + }, + "isUpdateSupported": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a parameter value can be updated after creation.

" + } } }, "traits": { @@ -8428,19 +9104,19 @@ "errorType": { "target": "com.amazonaws.datazone#DataSourceErrorType", "traits": { - "smithy.api#documentation": "

The type of the error message that is returned if the operation cannot be successfully\n completed.

", + "smithy.api#documentation": "

The type of the error message that is returned if the operation cannot be successfully completed.

", "smithy.api#required": {} } }, "errorDetail": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The details of the error message that is returned if the operation cannot be\n successfully completed.

" + "smithy.api#documentation": "

The details of the error message that is returned if the operation cannot be successfully completed.

" } } }, "traits": { - "smithy.api#documentation": "

The details of the error message that is returned if the operation cannot be\n successfully completed.

" + "smithy.api#documentation": "

The details of the error message that is returned if the operation cannot be successfully completed.

" } }, "com.amazonaws.datazone#DataSourceErrorType": { @@ -8996,9 +9672,15 @@ { "target": "com.amazonaws.datazone#AssociateEnvironmentRole" }, + { + "target": "com.amazonaws.datazone#AssociateGovernedTerms" + }, { "target": "com.amazonaws.datazone#CancelSubscription" }, + { + "target": "com.amazonaws.datazone#CreateAccountPool" + }, { "target": "com.amazonaws.datazone#CreateAssetFilter" }, @@ -9011,6 +9693,9 @@ { "target": "com.amazonaws.datazone#CreateEnvironmentAction" }, + { + "target": "com.amazonaws.datazone#CreateEnvironmentBlueprint" + }, { "target": "com.amazonaws.datazone#CreateEnvironmentProfile" }, @@ -9041,6 +9726,9 @@ { "target": "com.amazonaws.datazone#CreateUserProfile" }, + { + "target": "com.amazonaws.datazone#DeleteAccountPool" + }, { "target": "com.amazonaws.datazone#DeleteAssetFilter" }, @@ -9053,6 +9741,9 @@ { "target": "com.amazonaws.datazone#DeleteEnvironmentAction" }, + { + "target": "com.amazonaws.datazone#DeleteEnvironmentBlueprint" + }, { "target": "com.amazonaws.datazone#DeleteEnvironmentProfile" }, @@ -9080,6 +9771,12 @@ { "target": "com.amazonaws.datazone#DisassociateEnvironmentRole" }, + { + "target": "com.amazonaws.datazone#DisassociateGovernedTerms" + }, + { + "target": "com.amazonaws.datazone#GetAccountPool" + }, { "target": "com.amazonaws.datazone#GetAssetFilter" }, @@ -9140,6 +9837,12 @@ { "target": "com.amazonaws.datazone#GetUserProfile" }, + { + "target": "com.amazonaws.datazone#ListAccountPools" + }, + { + "target": "com.amazonaws.datazone#ListAccountsInAccountPool" + }, { "target": "com.amazonaws.datazone#ListAssetFilters" }, @@ -9254,6 +9957,9 @@ { "target": "com.amazonaws.datazone#UntagResource" }, + { + "target": "com.amazonaws.datazone#UpdateAccountPool" + }, { "target": "com.amazonaws.datazone#UpdateAssetFilter" }, @@ -9266,6 +9972,9 @@ { "target": "com.amazonaws.datazone#UpdateEnvironmentAction" }, + { + "target": "com.amazonaws.datazone#UpdateEnvironmentBlueprint" + }, { "target": "com.amazonaws.datazone#UpdateEnvironmentProfile" }, @@ -9383,7 +10092,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "

Amazon DataZone is a data management service that enables you to catalog, discover,\n govern, share, and analyze your data. With Amazon DataZone, you can share and access your\n data across accounts and supported regions. Amazon DataZone simplifies your experience\n across Amazon Web Services services, including, but not limited to, Amazon Redshift, Amazon\n Athena, Amazon Web Services Glue, and Amazon Web Services Lake Formation.

", + "smithy.api#documentation": "

Amazon DataZone is a data management service that enables you to catalog, discover, govern, share, and analyze your data. With Amazon DataZone, you can share and access your data across accounts and supported regions. Amazon DataZone simplifies your experience across Amazon Web Services services, including, but not limited to, Amazon Redshift, Amazon Athena, Amazon Web Services Glue, and Amazon Web Services Lake Formation.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -9786,6 +10495,72 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.datazone#DeleteAccountPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteAccountPoolInput" + }, + "output": { + "target": "com.amazonaws.datazone#DeleteAccountPoolOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an account pool.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/account-pools/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteAccountPoolInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where the account pool is deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#AccountPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the account pool to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteAccountPoolOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#DeleteAsset": { "type": "operation", "input": { @@ -9815,7 +10590,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an asset in Amazon DataZone.

", + "smithy.api#documentation": "

Deletes an asset in Amazon DataZone.

  • --domain-identifier must refer to a valid and existing domain.

  • --identifier must refer to an existing asset in the specified domain.

  • Asset must not be referenced in any existing asset filters.

  • Asset must not be linked to any draft or published data product.

  • User must have delete permissions for the domain and project.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -9853,7 +10628,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an asset filter.

", + "smithy.api#documentation": "

Deletes an asset filter.

Prerequisites:

  • The asset filter must exist.

  • The domain and asset must not have been deleted.

  • Ensure the --identifier refers to a valid filter ID.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -9954,7 +10729,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an asset type in Amazon DataZone.

", + "smithy.api#documentation": "

Deletes an asset type in Amazon DataZone.

Prerequisites:

  • The asset type must exist in the domain.

  • You must have DeleteAssetType permission.

  • The asset type must not be in use (e.g., assigned to any asset). If used, deletion will fail.

  • You should retrieve the asset type using get-asset-type to confirm its presence before deletion.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -10019,7 +10794,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes and connection. In Amazon DataZone, a connection enables you to connect your\n resources (domains, projects, and environments) to external resources and services.

", + "smithy.api#documentation": "

Deletes and connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -10095,7 +10870,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a data product in Amazon DataZone.

", + "smithy.api#documentation": "

Deletes a data product in Amazon DataZone.

Prerequisites:

  • The data product must exist and not be deleted or archived.

  • The user must have delete permissions for the data product.

  • Domain and project must be active.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -10202,7 +10977,7 @@ "message": "This field is no longer required for idempotency.", "since": "2024-12-02" }, - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} } @@ -10210,7 +10985,7 @@ "retainPermissionsOnRevokeFailure": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies that the granted permissions are retained in case of a self-subscribe\n functionality failure for a data source.

", + "smithy.api#documentation": "

Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.

", "smithy.api#httpQuery": "retainPermissionsOnRevokeFailure" } } @@ -10264,7 +11039,7 @@ "projectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The ID of the project in which this data source exists and from which it's\n deleted.

", + "smithy.api#documentation": "

The ID of the project in which this data source exists and from which it's deleted.

", "smithy.api#required": {} } }, @@ -10290,13 +11065,13 @@ "enableSetting": { "target": "com.amazonaws.datazone#EnableSetting", "traits": { - "smithy.api#documentation": "

The enable setting of the data source that specifies whether the data source is enabled\n or disabled.

" + "smithy.api#documentation": "

The enable setting of the data source that specifies whether the data source is enabled or disabled.

" } }, "publishOnImport": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the assets that this data source creates in the inventory are to be\n also automatically published to the catalog.

" + "smithy.api#documentation": "

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

" } }, "assetFormsOutput": { @@ -10326,13 +11101,13 @@ "lastRunErrorMessage": { "target": "com.amazonaws.datazone#DataSourceErrorMessage", "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "errorMessage": { "target": "com.amazonaws.datazone#DataSourceErrorMessage", "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "createdAt": { @@ -10357,7 +11132,7 @@ "retainPermissionsOnRevokeFailure": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies that the granted permissions are retained in case of a self-subscribe\n functionality failure for a data source.

" + "smithy.api#documentation": "

Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.

" } } }, @@ -10420,7 +11195,7 @@ "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} } @@ -10589,7 +11364,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an action for the environment, for example, deletes a console link for an\n analytics tool that is available in this environment.

", + "smithy.api#documentation": "

Deletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -10630,6 +11405,44 @@ "smithy.api#input": {} } }, + "com.amazonaws.datazone#DeleteEnvironmentBlueprint": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteEnvironmentBlueprintInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a blueprint in Amazon DataZone.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/environment-blueprints/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, "com.amazonaws.datazone#DeleteEnvironmentBlueprintConfiguration": { "type": "operation", "input": { @@ -10693,6 +11506,30 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#DeleteEnvironmentBlueprintInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the blueprint is deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "

The ID of the blueprint that is deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.datazone#DeleteEnvironmentInput": { "type": "structure", "members": { @@ -10805,7 +11642,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delets and metadata form type in Amazon DataZone.

", + "smithy.api#documentation": "

Deletes and metadata form type in Amazon DataZone.

Prerequisites:

  • The form type must exist in the domain.

  • The form type must not be in use by any asset types or assets.

  • The domain must be valid and accessible.

  • User must have delete permissions on the form type.

  • Any dependencies (such as linked asset types) must be removed first.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -10873,7 +11710,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a business glossary in Amazon DataZone.

", + "smithy.api#documentation": "

Deletes a business glossary in Amazon DataZone.

Prerequisites:

  • The glossary must be in DISABLED state.

  • The glossary must not have any glossary terms associated with it.

  • The glossary must exist in the specified domain.

  • The caller must have the datazone:DeleteGlossary permission in the domain and glossary.

  • Glossary should not be linked to any active metadata forms.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -10942,7 +11779,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a business glossary term in Amazon DataZone.

", + "smithy.api#documentation": "

Deletes a business glossary term in Amazon DataZone.

Prerequisites:

  • Glossary term must exist and be active.

  • The term must not be linked to other assets or child terms.

  • Caller must have delete permissions in the domain/glossary.

  • Ensure all associations (such as to assets or parent terms) are removed before deletion.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -11296,7 +12133,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a rule in Amazon DataZone. A rule is a formal agreement that enforces specific\n requirements across user workflows (e.g., publishing assets to the catalog, requesting\n subscriptions, creating projects) within the Amazon DataZone data portal. These rules help\n maintain consistency, ensure compliance, and uphold governance standards in data management\n processes. For instance, a metadata enforcement rule can specify the required information\n for creating a subscription request or publishing a data asset to the catalog, ensuring\n alignment with organizational standards.

", + "smithy.api#documentation": "

Deletes a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -11444,7 +12281,7 @@ "subscriptionTargetId": { "target": "com.amazonaws.datazone#SubscriptionTargetId", "traits": { - "smithy.api#documentation": "

The ID of the subscription target associated with the subscription grant that is\n deleted.

", + "smithy.api#documentation": "

The ID of the subscription target associated with the subscription grant that is deleted.

", "smithy.api#required": {} } }, @@ -11653,7 +12490,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain that houses the asset for which you want to delete\n a time series form.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain that houses the asset for which you want to delete a time series form.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11685,7 +12522,7 @@ "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure idempotency of the request. This field is\n automatically populated if not provided.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} } @@ -11972,6 +12809,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#DisassociateGovernedTerms": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DisassociateGovernedTermsInput" + }, + "output": { + "target": "com.amazonaws.datazone#DisassociateGovernedTermsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates restricted terms from an asset.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/disassociate-governed-terms" + } + } + }, + "com.amazonaws.datazone#DisassociateGovernedTermsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where you want to disassociate restricted terms from an asset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityIdentifier": { + "target": "com.amazonaws.datazone#EntityIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of an asset from which you want to disassociate restricted terms.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.datazone#GovernedEntityType", + "traits": { + "smithy.api#documentation": "

The type of the asset from which you want to disassociate restricted terms.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "governedGlossaryTerms": { + "target": "com.amazonaws.datazone#GovernedGlossaryTerms", + "traits": { + "smithy.api#documentation": "

The restricted glossary terms that you want to disassociate from an asset.

", + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DisassociateGovernedTermsOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#Domain": { "type": "resource", "identifiers": { @@ -12302,7 +13226,7 @@ } }, "traits": { - "smithy.api#documentation": "

The grant filter for the domain unit. In the current release of Amazon DataZone, the\n only supported filter is the allDomainUnitsGrantFilter.

" + "smithy.api#documentation": "

The grant filter for the domain unit. In the current release of Amazon DataZone, the only supported filter is the allDomainUnitsGrantFilter.

" } }, "com.amazonaws.datazone#DomainUnitGroupProperties": { @@ -12632,7 +13556,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details about the specified action configured for an environment. For example, the\n details of the specified console links for an analytics tool that is available in this\n environment.

" + "smithy.api#documentation": "

The details about the specified action configured for an environment. For example, the details of the specified console links for an analytics tool that is available in this environment.

" } }, "com.amazonaws.datazone#EnvironmentBlueprintConfiguration": { @@ -12707,7 +13631,7 @@ "provisioningRoleArn": { "target": "com.amazonaws.datazone#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the provisioning role specified in the environment blueprint\n configuration.

" + "smithy.api#documentation": "

The ARN of the provisioning role specified in the environment blueprint configuration.

" } }, "environmentRolePermissionBoundary": { @@ -12719,7 +13643,7 @@ "manageAccessRoleArn": { "target": "com.amazonaws.datazone#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the manage access role specified in the environment blueprint\n configuration.

" + "smithy.api#documentation": "

The ARN of the manage access role specified in the environment blueprint configuration.

" } }, "enabledRegions": { @@ -12887,15 +13811,19 @@ "awsAccount": { "target": "com.amazonaws.datazone#AwsAccount", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account of the environment.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Web Services account of the environment.

" + } + }, + "accountPools": { + "target": "com.amazonaws.datazone#AccountPoolList", + "traits": { + "smithy.api#documentation": "

The account pools used by a custom project profile.

" } }, "awsRegion": { "target": "com.amazonaws.datazone#Region", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region of the environment.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Web Services Region of the environment.

" } }, "deploymentOrder": { @@ -13000,6 +13928,12 @@ "smithy.api#documentation": "

The ID of the environment.

" } }, + "environmentResolvedAccount": { + "target": "com.amazonaws.datazone#EnvironmentResolvedAccount", + "traits": { + "smithy.api#documentation": "

Specifies the account/Region that is to be used during project creation for a particular blueprint.

" + } + }, "environmentConfigurationName": { "target": "com.amazonaws.datazone#EnvironmentConfigurationName", "traits": { @@ -13232,6 +14166,34 @@ "smithy.api#documentation": "

The details of an environment profile.

" } }, + "com.amazonaws.datazone#EnvironmentResolvedAccount": { + "type": "structure", + "members": { + "awsAccountId": { + "target": "com.amazonaws.datazone#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the resolved account.

", + "smithy.api#required": {} + } + }, + "regionName": { + "target": "com.amazonaws.datazone#AwsRegion", + "traits": { + "smithy.api#documentation": "

The name of the resolved Region.

", + "smithy.api#required": {} + } + }, + "sourceAccountPoolId": { + "target": "com.amazonaws.datazone#AccountPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the account pool.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the account/Region that is to be used during project creation for a particular blueprint.

" + } + }, "com.amazonaws.datazone#EnvironmentStatus": { "type": "enum", "members": { @@ -13492,7 +14454,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "com.amazonaws.datazone#FailureReasons": { @@ -13920,7 +14882,7 @@ "originDomainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which the form type was originally\n created.

" + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which the form type was originally created.

" } }, "originProjectId": { @@ -14029,6 +14991,143 @@ } } }, + "com.amazonaws.datazone#GetAccountPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetAccountPoolInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetAccountPoolOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the details of the account pool.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/account-pools/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetAccountPoolInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain in which the account pool lives whose details are to be displayed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#AccountPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the account pool whose details are to be displayed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetAccountPoolOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain in which the account pool lives whose details are to be displayed.

" + } + }, + "name": { + "target": "com.amazonaws.datazone#AccountPoolName", + "traits": { + "smithy.api#documentation": "

The name of the account pool.

" + } + }, + "id": { + "target": "com.amazonaws.datazone#AccountPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the account pool.

" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the account pool.

" + } + }, + "resolutionStrategy": { + "target": "com.amazonaws.datazone#ResolutionStrategy", + "traits": { + "smithy.api#documentation": "

The mechanism used to resolve the account selection from the account pool.

" + } + }, + "accountSource": { + "target": "com.amazonaws.datazone#AccountSource", + "traits": { + "smithy.api#documentation": "

The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.

", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the account pool.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the account pool was created.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the account pool was last updated.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "

The user who last updated the account pool.

" + } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The domain unit ID of the account pool.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#GetAsset": { "type": "operation", "input": { @@ -14055,7 +15154,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets an Amazon DataZone asset.

", + "smithy.api#documentation": "

Gets an Amazon DataZone asset.

An asset is the fundamental building block in Amazon DataZone, representing any data resource that needs to be cataloged and managed. It can take many forms, from Amazon S3 buckets and database tables to dashboards and machine learning models. Each asset contains comprehensive metadata about the resource, including its location, schema, ownership, and lineage information. Assets are essential for organizing and managing data resources across an organization, making them discoverable and usable while maintaining proper governance.

Before using the Amazon DataZone GetAsset command, ensure the following prerequisites are met:

  • Domain identifier must exist and be valid

  • Asset identifier must exist

  • User must have the required permissions to perform the action

", "smithy.api#http": { "code": 200, "method": "GET", @@ -14090,7 +15189,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets an asset filter.

", + "smithy.api#documentation": "

Gets an asset filter.

Prerequisites:

  • Domain (--domain-identifier), asset (--asset-identifier), and filter (--identifier) must all exist.

  • The asset filter should not have been deleted.

  • The asset must still exist (since the filter is linked to it).

", "smithy.api#http": { "code": 200, "method": "GET", @@ -14224,7 +15323,7 @@ "identifier": { "target": "com.amazonaws.datazone#AssetIdentifier", "traits": { - "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#documentation": "

The ID of the Amazon DataZone asset.

This parameter supports either the value of assetId or externalIdentifier as input. If you are passing the value of externalIdentifier, you must prefix this value with externalIdentifer%2F.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -14321,6 +15420,16 @@ "smithy.api#documentation": "

The business glossary terms attached to the asset.

" } }, + "governedGlossaryTerms": { + "target": "com.amazonaws.datazone#GovernedGlossaryTerms", + "traits": { + "smithy.api#documentation": "

The restricted glossary terms attached to an asset.

", + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "owningProjectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { @@ -14391,7 +15500,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets an Amazon DataZone asset type.

", + "smithy.api#documentation": "

Gets an Amazon DataZone asset type.

Asset types define the categories and characteristics of different kinds of data assets within Amazon DataZone.. They determine what metadata fields are required, what operations are possible, and how the asset integrates with other Amazon Web Services services. Asset types can range from built-in types like Amazon S3 buckets and Amazon Web Services Glue tables to custom types defined for specific organizational needs. Understanding asset types is crucial for properly organizing and managing different kinds of data resources.

Prerequisites:

  • The asset type with identifier must exist in the domain. ResourceNotFoundException.

  • You must have the GetAssetType permission.

  • Ensure the domain-identifier value is correct and accessible.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -14542,7 +15651,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a connection. In Amazon DataZone, a connection enables you to connect your\n resources (domains, projects, and environments) to external resources and services.

", + "smithy.api#documentation": "

Gets a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -14694,7 +15803,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the data product.

", + "smithy.api#documentation": "

Gets the data product.

Prerequisites:

  • The data product ID must exist.

  • The domain must be valid and accessible.

  • User must have read or discovery permissions for the data product.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -14981,7 +16090,7 @@ "publishOnImport": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the assets that this data source creates in the inventory are to be\n also automatically published to the catalog.

" + "smithy.api#documentation": "

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

" } }, "assetFormsOutput": { @@ -15011,7 +16120,7 @@ "lastRunErrorMessage": { "target": "com.amazonaws.datazone#DataSourceErrorMessage", "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "lastRunAssetCount": { @@ -15023,7 +16132,7 @@ "errorMessage": { "target": "com.amazonaws.datazone#DataSourceErrorMessage", "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "createdAt": { @@ -15181,7 +16290,7 @@ "errorMessage": { "target": "com.amazonaws.datazone#DataSourceErrorMessage", "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "createdAt": { @@ -15322,7 +16431,7 @@ "kmsKeyIdentifier": { "target": "com.amazonaws.datazone#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Web Services Key Management Service (KMS) key that is used\n to encrypt the Amazon DataZone domain, metadata, and reporting data.

" + "smithy.api#documentation": "

The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

" } }, "status": { @@ -15583,7 +16692,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is\n invoked.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is invoked.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -15964,7 +17073,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which this environment and its credentials\n exist.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which this environment and its credentials exist.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -16361,7 +17470,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a metadata form type in Amazon DataZone.

", + "smithy.api#documentation": "

Gets a metadata form type in Amazon DataZone.

Form types define the structure and validation rules for collecting metadata about assets in Amazon DataZone. They act as templates that ensure consistent metadata capture across similar types of assets, while allowing for customization to meet specific organizational needs. Form types can include required fields, validation rules, and dependencies, helping maintain high-quality metadata that makes data assets more discoverable and usable.

  • The form type with the specified identifier must exist in the given domain.

  • The domain must be valid and active.

  • User must have permission on the form type.

  • The form type should not be deleted or in an invalid state.

One use case for this API is to determine whether a form field is indexed for search.

A searchable field will be annotated with @amazon.datazone#searchable. By default, searchable fields are indexed for semantic search, where related query terms will match the attribute value even if they are not stemmed or keyword matches. If a field is indexed technical identifier search, it will be annotated with @amazon.datazone#searchable(modes:[\"TECHNICAL\"]). If a field is indexed for lexical search (supports stemmed and prefix matches but not semantic matches), it will be annotated with @amazon.datazone#searchable(modes:[\"LEXICAL\"]).

A field storing glossary term IDs (which is filterable) will be annotated with @amazon.datazone#glossaryterm(\"${glossaryId}\").

", "smithy.api#http": { "code": 200, "method": "GET", @@ -16441,7 +17550,7 @@ "originDomainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the metadata form type was originally\n created.

" + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the metadata form type was originally created.

" } }, "originProjectId": { @@ -16511,7 +17620,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a business glossary in Amazon DataZone.

", + "smithy.api#documentation": "

Gets a business glossary in Amazon DataZone.

Prerequisites:

  • The specified glossary ID must exist and be associated with the given domain.

  • The caller must have the datazone:GetGlossary permission on the domain.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -16611,6 +17720,12 @@ "traits": { "smithy.api#documentation": "

The Amazon DataZone user who updated the business glossary.

" } + }, + "usageRestrictions": { + "target": "com.amazonaws.datazone#GlossaryUsageRestrictions", + "traits": { + "smithy.api#documentation": "

The usage restriction of the restricted glossary.

" + } } }, "traits": { @@ -16643,7 +17758,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a business glossary term in Amazon DataZone.

", + "smithy.api#documentation": "

Gets a business glossary term in Amazon DataZone.

Prerequisites:

  • Glossary term with identifier must exist in the domain.

  • User must have permission on the glossary term.

  • Domain must be accessible and active.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -16755,6 +17870,12 @@ "traits": { "smithy.api#documentation": "

The Amazon DataZone user who updated the business glossary term.

" } + }, + "usageRestrictions": { + "target": "com.amazonaws.datazone#GlossaryUsageRestrictions", + "traits": { + "smithy.api#documentation": "

The usage restriction of a term within a restricted glossary.

" + } } }, "traits": { @@ -17230,7 +18351,7 @@ "identifier": { "target": "com.amazonaws.datazone#LineageNodeIdentifier", "traits": { - "smithy.api#documentation": "

The ID of the data lineage node that you want to get.

\n

Both, a lineage node identifier generated by Amazon DataZone and a\n sourceIdentifier of the lineage node are supported. If\n sourceIdentifier is greater than 1800 characters, you can use lineage node\n identifier generated by Amazon DataZone to get the node details.

", + "smithy.api#documentation": "

The ID of the data lineage node that you want to get.

Both, a lineage node identifier generated by Amazon DataZone and a sourceIdentifier of the lineage node are supported. If sourceIdentifier is greater than 1800 characters, you can use lineage node identifier generated by Amazon DataZone to get the node details.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17374,7 +18495,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a listing (a record of an asset at a given time). If you specify a listing version,\n only details that are specific to that version are returned.

", + "smithy.api#documentation": "

Gets a listing (a record of an asset at a given time). If you specify a listing version, only details that are specific to that version are returned.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -17518,7 +18639,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a metadata generation run in Amazon DataZone.

", + "smithy.api#documentation": "

Gets a metadata generation run in Amazon DataZone.

Prerequisites:

  • Valid domain and run identifier.

  • The metadata generation run must exist.

  • User must have read access to the metadata run.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -17533,7 +18654,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain the metadata generation run of which you want to\n get.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17557,7 +18678,7 @@ "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain the metadata generation run of which you want to\n get.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

", "smithy.api#required": {} } }, @@ -17601,7 +18722,7 @@ "owningProjectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The ID of the project that owns the assets for which you're running metadata\n generation.

", + "smithy.api#documentation": "

The ID of the project that owns the assets for which you're running metadata generation.

", "smithy.api#required": {} } } @@ -17708,7 +18829,7 @@ "failureReasons": { "target": "com.amazonaws.datazone#FailureReasons", "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "createdBy": { @@ -17926,7 +19047,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the details of a rule in Amazon DataZone. A rule is a formal agreement that\n enforces specific requirements across user workflows (e.g., publishing assets to the\n catalog, requesting subscriptions, creating projects) within the Amazon DataZone data\n portal. These rules help maintain consistency, ensure compliance, and uphold governance\n standards in data management processes. For instance, a metadata enforcement rule can\n specify the required information for creating a subscription request or publishing a data\n asset to the catalog, ensuring alignment with organizational standards.

", + "smithy.api#documentation": "

Gets the details of a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -18396,7 +19517,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which to get the subscription request\n details.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which to get the subscription request details.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18741,7 +19862,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain that houses the asset for which you want to get the\n data point.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain that houses the asset for which you want to get the data point.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18789,7 +19910,7 @@ "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain that houses the asset data point that you want to\n get.

" + "smithy.api#documentation": "

The ID of the Amazon DataZone domain that houses the asset data point that you want to get.

" } }, "entityId": { @@ -18893,7 +20014,7 @@ "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

the identifier of the Amazon DataZone domain of which you want to get the user\n profile.

" + "smithy.api#documentation": "

the identifier of the Amazon DataZone domain of which you want to get the user profile.

" } }, "id": { @@ -18922,6 +20043,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#GlobalParameterMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, "com.amazonaws.datazone#Glossary": { "type": "resource", "identifiers": { @@ -18965,6 +20095,9 @@ }, "updatedBy": { "target": "com.amazonaws.datazone#UpdatedBy" + }, + "usageRestrictions": { + "target": "com.amazonaws.datazone#GlossaryUsageRestrictions" } }, "create": { @@ -19039,6 +20172,12 @@ "smithy.api#required": {} } }, + "usageRestrictions": { + "target": "com.amazonaws.datazone#GlossaryUsageRestrictions", + "traits": { + "smithy.api#documentation": "

The usage restrictions associated with a goverened glossary term.

" + } + }, "createdAt": { "target": "com.amazonaws.datazone#CreatedAt", "traits": { @@ -19164,6 +20303,9 @@ }, "updatedBy": { "target": "com.amazonaws.datazone#UpdatedBy" + }, + "usageRestrictions": { + "target": "com.amazonaws.datazone#GlossaryUsageRestrictions" } }, "create": { @@ -19222,6 +20364,12 @@ "smithy.api#documentation": "

The short description of the business glossary term.

" } }, + "usageRestrictions": { + "target": "com.amazonaws.datazone#GlossaryUsageRestrictions", + "traits": { + "smithy.api#documentation": "

The usage restrictions associated with a goverened glossary term.

" + } + }, "longDescription": { "target": "com.amazonaws.datazone#LongDescription", "traits": { @@ -19329,6 +20477,29 @@ } } }, + "com.amazonaws.datazone#GlossaryUsageRestriction": { + "type": "enum", + "members": { + "ASSET_GOVERNED_TERMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSET_GOVERNED_TERMS" + } + } + } + }, + "com.amazonaws.datazone#GlossaryUsageRestrictions": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#GlossaryUsageRestriction" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.datazone#GlueConnection": { "type": "structure", "members": { @@ -19507,13 +20678,13 @@ "validateCredentials": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Speciefies whether to validate credentials of the Amazon Web Services Glue\n connection.

" + "smithy.api#documentation": "

Speciefies whether to validate credentials of the Amazon Web Services Glue connection.

" } }, "validateForComputeEnvironments": { "target": "com.amazonaws.datazone#ComputeEnvironmentsList", "traits": { - "smithy.api#documentation": "

Speciefies whether to validate for compute environments of the Amazon Web Services Glue\n connection.

" + "smithy.api#documentation": "

Speciefies whether to validate for compute environments of the Amazon Web Services Glue connection.

" } }, "sparkProperties": { @@ -19757,21 +20928,21 @@ "dataAccessRole": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Web Services Glue data\n source.

", + "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Web Services Glue data source.

", "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" } }, "relationalFilterConfigurations": { "target": "com.amazonaws.datazone#RelationalFilterConfigurations", "traits": { - "smithy.api#documentation": "

The relational filter configurations included in the configuration details of the Amazon Web Services\n Glue data source.

", + "smithy.api#documentation": "

The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source.

", "smithy.api#required": {} } }, "autoImportDataQualityResult": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether to automatically import data quality metrics as part of the data\n source run.

" + "smithy.api#documentation": "

Specifies whether to automatically import data quality metrics as part of the data source run.

" } }, "catalogName": { @@ -19795,7 +20966,7 @@ "accountId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data\n source.

", + "smithy.api#documentation": "

The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data source.

", "smithy.api#length": { "min": 12, "max": 12 @@ -19806,7 +20977,7 @@ "region": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source.\n

", + "smithy.api#documentation": "

The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source.

", "smithy.api#length": { "min": 4, "max": 16 @@ -19817,21 +20988,21 @@ "dataAccessRole": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Web Services Glue data\n source.

", + "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Web Services Glue data source.

", "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" } }, "relationalFilterConfigurations": { "target": "com.amazonaws.datazone#RelationalFilterConfigurations", "traits": { - "smithy.api#documentation": "

The relational filter configurations included in the configuration details of the Amazon Web Services\n Glue data source.

", + "smithy.api#documentation": "

The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source.

", "smithy.api#required": {} } }, "autoImportDataQualityResult": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether to automatically import data quality metrics as part of the data\n source run.

" + "smithy.api#documentation": "

Specifies whether to automatically import data quality metrics as part of the data source run.

" } }, "catalogName": { @@ -19881,6 +21052,29 @@ } } }, + "com.amazonaws.datazone#GovernedEntityType": { + "type": "enum", + "members": { + "ASSET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSET" + } + } + } + }, + "com.amazonaws.datazone#GovernedGlossaryTerms": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#GlossaryTermId" + } + }, + "com.amazonaws.datazone#GrantIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9+/]{10}$" + } + }, "com.amazonaws.datazone#GrantedEntity": { "type": "union", "members": { @@ -20155,7 +21349,7 @@ "glueLineageSyncEnabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether Amazon Web Services Glue lineage sync is enabled for a\n connection.

" + "smithy.api#documentation": "

Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection.

" } } }, @@ -20175,7 +21369,7 @@ "glueLineageSyncEnabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether Amazon Web Services Glue lineage sync is enabled for a\n connection.

" + "smithy.api#documentation": "

Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection.

" } } }, @@ -20189,7 +21383,7 @@ "glueLineageSyncEnabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether Amazon Web Services Glue lineage sync is enabled for a\n connection.

" + "smithy.api#documentation": "

Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection.

" } } }, @@ -20211,6 +21405,12 @@ "traits": { "smithy.api#documentation": "

The ARN of an IAM user profile in Amazon DataZone.

" } + }, + "principalId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Principal ID of the IAM user.

" + } } }, "traits": { @@ -20567,13 +21767,13 @@ "locationRegistrationRole": { "target": "com.amazonaws.datazone#RoleArn", "traits": { - "smithy.api#documentation": "

The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for\n Data Lake using Amazon Web Services Lake Formation hybrid access mode.

" + "smithy.api#documentation": "

The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using Amazon Web Services Lake Formation hybrid access mode.

" } }, "locationRegistrationExcludeS3Locations": { "target": "com.amazonaws.datazone#S3LocationList", "traits": { - "smithy.api#documentation": "

Specifies certain Amazon S3 locations if you do not want Amazon DataZone to\n automatically register them in hybrid mode.

" + "smithy.api#documentation": "

Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode.

" } } }, @@ -20581,6 +21781,18 @@ "smithy.api#documentation": "

The Lake Formation configuration of the Data Lake blueprint.

" } }, + "com.amazonaws.datazone#LambdaExecutionRoleArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$" + } + }, + "com.amazonaws.datazone#LambdaFunctionArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov):lambda:(?:[a-z]{2}(?:-gov)?-[a-z]+-\\d{1,}):(\\d{12}):function:[a-zA-Z0-9-_]+(?::[a-zA-Z0-9-_]+)?(?:\\$[\\w-]+)?$" + } + }, "com.amazonaws.datazone#LastName": { "type": "string", "traits": { @@ -21049,7 +22261,7 @@ "numQueriesFailed": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of queries that failed in the SQL query run details of a data lineage\n run.

" + "smithy.api#documentation": "

The number of queries that failed in the SQL query run details of a data lineage run.

" } }, "errorMessages": { @@ -21078,6 +22290,214 @@ "smithy.api#documentation": "

The lineage sync schedule.

" } }, + "com.amazonaws.datazone#ListAccountPools": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#ListAccountPoolsInput" + }, + "output": { + "target": "com.amazonaws.datazone#ListAccountPoolsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists existing account pools.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/account-pools" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListAccountPoolsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where exsting account pools are to be listed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#AccountPoolName", + "traits": { + "smithy.api#documentation": "

The name of the account pool to be listed.

", + "smithy.api#httpQuery": "name" + } + }, + "sortBy": { + "target": "com.amazonaws.datazone#SortFieldAccountPool", + "traits": { + "smithy.api#documentation": "

The sort by mechanism in which the existing account pools are to be listed.

", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.datazone#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order in which the existing account pools are to be listed.

", + "smithy.api#httpQuery": "sortOrder" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of account pools is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of account pools to return in a single call to ListAccountPools. When the number of account pools to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAccountPools to list the next set of account pools.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#ListAccountPoolsOutput": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.datazone#AccountPoolSummaries", + "traits": { + "smithy.api#documentation": "

The results of the ListAccountPools operation.

" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of account pools is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#ListAccountsInAccountPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#ListAccountsInAccountPoolInput" + }, + "output": { + "target": "com.amazonaws.datazone#ListAccountsInAccountPoolOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the accounts in the specified account pool.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/account-pools/{identifier}/accounts" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListAccountsInAccountPoolInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain in which the accounts in the specified account pool are to be listed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#AccountPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the account pool whose accounts are to be listed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of accounts is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of accounts, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountsInAccountPool to list the next set of accounts.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of accounts to return in a single call to ListAccountsInAccountPool. When the number of accounts to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAccountsInAccountPool to list the next set of accounts.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#ListAccountsInAccountPoolOutput": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.datazone#AccountInfoList", + "traits": { + "smithy.api#documentation": "

The results of the ListAccountsInAccountPool operation.

" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of accounts is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of accounts, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountsInAccountPool to list the next set of accounts.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#ListAssetFilters": { "type": "operation", "input": { @@ -21104,7 +22524,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists asset filters.

", + "smithy.api#documentation": "

Lists asset filters.

Prerequisites:

  • A valid domain and asset must exist.

  • The asset must have at least one filter created to return results.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -21148,14 +22568,14 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of asset filters is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of asset filters, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListAssetFilters to\n list the next set of asset filters.

", + "smithy.api#documentation": "

When the number of asset filters is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of asset filters, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetFilters to list the next set of asset filters.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of asset filters to return in a single call to\n ListAssetFilters. When the number of asset filters to be listed is greater\n than the value of MaxResults, the response contains a NextToken\n value that you can use in a subsequent call to ListAssetFilters to list the\n next set of asset filters.

", + "smithy.api#documentation": "

The maximum number of asset filters to return in a single call to ListAssetFilters. When the number of asset filters to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAssetFilters to list the next set of asset filters.

", "smithy.api#httpQuery": "maxResults" } } @@ -21177,7 +22597,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of asset filters is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of asset filters, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListAssetFilters to\n list the next set of asset filters.

" + "smithy.api#documentation": "

When the number of asset filters is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of asset filters, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetFilters to list the next set of asset filters.

" } } }, @@ -21211,7 +22631,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the revisions for the asset.

", + "smithy.api#documentation": "

Lists the revisions for the asset.

Prerequisites:

  • The asset must exist in the domain.

  • There must be at least one revision of the asset (which happens automatically after creation).

  • The domain must be valid and active.

  • User must have permissions on the asset and domain.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -21243,14 +22663,14 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of revisions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of revisions, the response includes\n a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListAssetRevisions to\n list the next set of revisions.

", + "smithy.api#documentation": "

When the number of revisions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of revisions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetRevisions to list the next set of revisions.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of revisions to return in a single call to\n ListAssetRevisions. When the number of revisions to be listed is greater\n than the value of MaxResults, the response contains a NextToken\n value that you can use in a subsequent call to ListAssetRevisions to list the\n next set of revisions.

", + "smithy.api#documentation": "

The maximum number of revisions to return in a single call to ListAssetRevisions. When the number of revisions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAssetRevisions to list the next set of revisions.

", "smithy.api#httpQuery": "maxResults" } } @@ -21271,7 +22691,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of revisions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of revisions, the response includes\n a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListAssetRevisions to\n list the next set of revisions.

" + "smithy.api#documentation": "

When the number of revisions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of revisions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetRevisions to list the next set of revisions.

" } } }, @@ -21302,7 +22722,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists connections. In Amazon DataZone, a connection enables you to connect your\n resources (domains, projects, and environments) to external resources and services.

", + "smithy.api#documentation": "

Lists connections. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -21331,14 +22751,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of connections to return in a single call to ListConnections. When\n the number of connections to be listed is greater than the value of MaxResults, the\n response contains a NextToken value that you can use in a subsequent call to\n ListConnections to list the next set of connections.

", + "smithy.api#documentation": "

The maximum number of connections to return in a single call to ListConnections. When the number of connections to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListConnections to list the next set of connections.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of connections is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of connections, the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListConnections to list the next set of\n connections.

", + "smithy.api#documentation": "

When the number of connections is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of connections, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListConnections to list the next set of connections.

", "smithy.api#httpQuery": "nextToken" } }, @@ -21403,7 +22823,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of connections is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of connections, the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListConnections to list the next set of\n connections.

" + "smithy.api#documentation": "

When the number of connections is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of connections, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListConnections to list the next set of connections.

" } } }, @@ -21437,7 +22857,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists data product revisions.

", + "smithy.api#documentation": "

Lists data product revisions.

Prerequisites:

  • The data product ID must exist within the domain.

  • User must have view permissions on the data product.

  • The domain must be in a valid and accessible state.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -21474,14 +22894,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of asset filters to return in a single call to\n ListDataProductRevisions. When the number of data product revisions to be\n listed is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListDataProductRevisions to list the next set of data product\n revisions.

", + "smithy.api#documentation": "

The maximum number of asset filters to return in a single call to ListDataProductRevisions. When the number of data product revisions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDataProductRevisions to list the next set of data product revisions.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of data product revisions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of data product revisions, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListDataProductRevisions to list the next set of data product\n revisions.

", + "smithy.api#documentation": "

When the number of data product revisions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data product revisions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataProductRevisions to list the next set of data product revisions.

", "smithy.api#httpQuery": "nextToken" } } @@ -21503,7 +22923,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of data product revisions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of data product revisions, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListDataProductRevisions to list the next set of data product\n revisions.

" + "smithy.api#documentation": "

When the number of data product revisions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data product revisions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataProductRevisions to list the next set of data product revisions.

" } } }, @@ -21564,7 +22984,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which to list data source run\n activities.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which to list data source run activities.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -21587,14 +23007,14 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of activities is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of activities, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListDataSourceRunActivities to list the next set of activities.

", + "smithy.api#documentation": "

When the number of activities is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of activities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRunActivities to list the next set of activities.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of activities to return in a single call to\n ListDataSourceRunActivities. When the number of activities to be listed is\n greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListDataSourceRunActivities to list the next set of activities.

", + "smithy.api#documentation": "

The maximum number of activities to return in a single call to ListDataSourceRunActivities. When the number of activities to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDataSourceRunActivities to list the next set of activities.

", "smithy.api#httpQuery": "maxResults" } } @@ -21616,7 +23036,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of activities is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of activities, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListDataSourceRunActivities to list the next set of activities.

" + "smithy.api#documentation": "

When the number of activities is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of activities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRunActivities to list the next set of activities.

" } } }, @@ -21677,7 +23097,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which to invoke the\n ListDataSourceRuns action.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which to invoke the ListDataSourceRuns action.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -21700,14 +23120,14 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of runs is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of runs, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDataSourceRuns to list the next set of\n runs.

", + "smithy.api#documentation": "

When the number of runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRuns to list the next set of runs.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of runs to return in a single call to\n ListDataSourceRuns. When the number of runs to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that\n you can use in a subsequent call to ListDataSourceRuns to list the next set of\n runs.

", + "smithy.api#documentation": "

The maximum number of runs to return in a single call to ListDataSourceRuns. When the number of runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDataSourceRuns to list the next set of runs.

", "smithy.api#httpQuery": "maxResults" } } @@ -21729,7 +23149,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of runs is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of runs, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDataSourceRuns to list the next set of\n runs.

" + "smithy.api#documentation": "

When the number of runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRuns to list the next set of runs.

" } } }, @@ -21841,14 +23261,14 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of data sources is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of data sources, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListDataSources to\n list the next set of data sources.

", + "smithy.api#documentation": "

When the number of data sources is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data sources, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSources to list the next set of data sources.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of data sources to return in a single call to\n ListDataSources. When the number of data sources to be listed is greater\n than the value of MaxResults, the response contains a NextToken\n value that you can use in a subsequent call to ListDataSources to list the\n next set of data sources.

", + "smithy.api#documentation": "

The maximum number of data sources to return in a single call to ListDataSources. When the number of data sources to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDataSources to list the next set of data sources.

", "smithy.api#httpQuery": "maxResults" } } @@ -21870,7 +23290,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of data sources is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of data sources, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListDataSources to\n list the next set of data sources.

" + "smithy.api#documentation": "

When the number of data sources is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data sources, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSources to list the next set of data sources.

" } } }, @@ -21925,7 +23345,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the domain in which you want to list domain units for a parent domain\n unit.

", + "smithy.api#documentation": "

The ID of the domain in which you want to list domain units for a parent domain unit.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -21941,14 +23361,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResultsForListDomains", "traits": { - "smithy.api#documentation": "

The maximum number of domain units to return in a single call to\n ListDomainUnitsForParent. When the number of domain units to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that you can use in a\n subsequent call to ListDomainUnitsForParent to list the next set of domain units.

", + "smithy.api#documentation": "

The maximum number of domain units to return in a single call to ListDomainUnitsForParent. When the number of domain units to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of domain units is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of domain units, the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set\n of domain units.

", + "smithy.api#documentation": "

When the number of domain units is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domain units, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.

", "smithy.api#httpQuery": "nextToken" } } @@ -21970,7 +23390,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of domain units is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of domain units, the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set\n of domain units.

" + "smithy.api#documentation": "

When the number of domain units is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domain units, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.

" } } }, @@ -22038,14 +23458,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResultsForListDomains", "traits": { - "smithy.api#documentation": "

The maximum number of domains to return in a single call to ListDomains.\n When the number of domains to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that you\n can use in a subsequent call to ListDomains to list the next set of\n domains.

", + "smithy.api#documentation": "

The maximum number of domains to return in a single call to ListDomains. When the number of domains to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDomains to list the next set of domains.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of domains is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of domains, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDomains to list the next set of\n domains.

", + "smithy.api#documentation": "

When the number of domains is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domains, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomains to list the next set of domains.

", "smithy.api#httpQuery": "nextToken" } } @@ -22067,7 +23487,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of domains is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of domains, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDomains to list the next set of\n domains.

" + "smithy.api#documentation": "

When the number of domains is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domains, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomains to list the next set of domains.

" } } }, @@ -22146,14 +23566,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResultsForListDomains", "traits": { - "smithy.api#documentation": "

The maximum number of entities to return in a single call to\n ListEntityOwners. When the number of entities to be listed is greater than\n the value of MaxResults, the response contains a NextToken value\n that you can use in a subsequent call to ListEntityOwners to list the next set\n of entities.

", + "smithy.api#documentation": "

The maximum number of entities to return in a single call to ListEntityOwners. When the number of entities to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEntityOwners to list the next set of entities.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of entities is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of entities, the response includes\n a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEntityOwners to\n list the next set of entities.

", + "smithy.api#documentation": "

When the number of entities is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of entities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEntityOwners to list the next set of entities.

", "smithy.api#httpQuery": "nextToken" } } @@ -22175,7 +23595,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of entities is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of entities, the response includes\n a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEntityOwners to\n list the next set of entities.

" + "smithy.api#documentation": "

When the number of entities is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of entities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEntityOwners to list the next set of entities.

" } } }, @@ -22249,14 +23669,14 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of environment actions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of environment actions, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEnvironmentActions\n to list the next set of environment actions.

", + "smithy.api#documentation": "

When the number of environment actions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment actions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of environment actions to return in a single call to\n ListEnvironmentActions. When the number of environment actions to be listed\n is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListEnvironmentActions to list the next set of environment actions.

", + "smithy.api#documentation": "

The maximum number of environment actions to return in a single call to ListEnvironmentActions. When the number of environment actions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

", "smithy.api#httpQuery": "maxResults" } } @@ -22277,7 +23697,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of environment actions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of environment actions, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEnvironmentActions\n to list the next set of environment actions.

" + "smithy.api#documentation": "

When the number of environment actions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment actions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

" } } }, @@ -22340,14 +23760,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of blueprint configurations to return in a single call to\n ListEnvironmentBlueprintConfigurations. When the number of configurations\n to be listed is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListEnvironmentBlueprintConfigurations to list the next set of\n configurations.

", + "smithy.api#documentation": "

The maximum number of blueprint configurations to return in a single call to ListEnvironmentBlueprintConfigurations. When the number of configurations to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of blueprint configurations is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of configurations, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListEnvironmentBlueprintConfigurations to list the next set of\n configurations.

", + "smithy.api#documentation": "

When the number of blueprint configurations is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of configurations, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.

", "smithy.api#httpQuery": "nextToken" } } @@ -22368,7 +23788,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of blueprint configurations is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of configurations, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListEnvironmentBlueprintConfigurations to list the next set of\n configurations.

" + "smithy.api#documentation": "

When the number of blueprint configurations is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of configurations, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.

" } } }, @@ -22431,14 +23851,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of blueprints to return in a single call to\n ListEnvironmentBlueprints. When the number of blueprints to be listed is\n greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListEnvironmentBlueprints to list the next set of blueprints.

", + "smithy.api#documentation": "

The maximum number of blueprints to return in a single call to ListEnvironmentBlueprints. When the number of blueprints to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentBlueprints to list the next set of blueprints.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of blueprints in the environment is greater than the default value for\n the MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of blueprints in the environment,\n the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListEnvironmentBlueprintsto list the next set of blueprints.

", + "smithy.api#documentation": "

When the number of blueprints in the environment is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of blueprints in the environment, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintsto list the next set of blueprints.

", "smithy.api#httpQuery": "nextToken" } }, @@ -22474,7 +23894,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of blueprints in the environment is greater than the default value for\n the MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of blueprints in the environment,\n the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListEnvironmentBlueprintsto list the next set of blueprints.

" + "smithy.api#documentation": "

When the number of blueprints in the environment is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of blueprints in the environment, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintsto list the next set of blueprints.

" } } }, @@ -22534,7 +23954,7 @@ "awsAccountId": { "target": "com.amazonaws.datazone#AwsAccountId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Web Services account where you want to list environment\n profiles.

", + "smithy.api#documentation": "

The identifier of the Amazon Web Services account where you want to list environment profiles.

", "smithy.api#httpQuery": "awsAccountId" } }, @@ -22548,7 +23968,7 @@ "environmentBlueprintIdentifier": { "target": "com.amazonaws.datazone#EnvironmentBlueprintId", "traits": { - "smithy.api#documentation": "

The identifier of the blueprint that was used to create the environment profiles that\n you want to list.

", + "smithy.api#documentation": "

The identifier of the blueprint that was used to create the environment profiles that you want to list.

", "smithy.api#httpQuery": "environmentBlueprintIdentifier" } }, @@ -22569,14 +23989,14 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of environment profiles is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of environment profiles, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListEnvironmentProfiles to list the next set of environment\n profiles.

", + "smithy.api#documentation": "

When the number of environment profiles is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentProfiles to list the next set of environment profiles.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of environment profiles to return in a single call to\n ListEnvironmentProfiles. When the number of environment profiles to be\n listed is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListEnvironmentProfiles to list the next set of environment\n profiles.

", + "smithy.api#documentation": "

The maximum number of environment profiles to return in a single call to ListEnvironmentProfiles. When the number of environment profiles to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentProfiles to list the next set of environment profiles.

", "smithy.api#httpQuery": "maxResults" } } @@ -22598,7 +24018,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of environment profiles is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of environment profiles, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListEnvironmentProfiles to list the next set of environment\n profiles.

" + "smithy.api#documentation": "

When the number of environment profiles is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentProfiles to list the next set of environment profiles.

" } } }, @@ -22658,7 +24078,7 @@ "awsAccountId": { "target": "com.amazonaws.datazone#AwsAccountId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Web Services account where you want to list\n environments.

", + "smithy.api#documentation": "

The identifier of the Amazon Web Services account where you want to list environments.

", "smithy.api#httpQuery": "awsAccountId" } }, @@ -22715,14 +24135,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of environments to return in a single call to\n ListEnvironments. When the number of environments to be listed is greater\n than the value of MaxResults, the response contains a NextToken\n value that you can use in a subsequent call to ListEnvironments to list the\n next set of environments.

", + "smithy.api#documentation": "

The maximum number of environments to return in a single call to ListEnvironments. When the number of environments to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironments to list the next set of environments.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of environments is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of environments, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEnvironments to\n list the next set of environments.

", + "smithy.api#documentation": "

When the number of environments is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environments, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironments to list the next set of environments.

", "smithy.api#httpQuery": "nextToken" } } @@ -22744,7 +24164,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of environments is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of environments, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEnvironments to\n list the next set of environments.

" + "smithy.api#documentation": "

When the number of environments is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environments, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironments to list the next set of environments.

" } } }, @@ -22830,14 +24250,14 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of job runs is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of job runs, the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListJobRuns to list the next set of job\n runs.

", + "smithy.api#documentation": "

When the number of job runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of job runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListJobRuns to list the next set of job runs.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of job runs to return in a single call to ListJobRuns. When the\n number of job runs to be listed is greater than the value of MaxResults, the response\n contains a NextToken value that you can use in a subsequent call to ListJobRuns to list the\n next set of job runs.

", + "smithy.api#documentation": "

The maximum number of job runs to return in a single call to ListJobRuns. When the number of job runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListJobRuns to list the next set of job runs.

", "smithy.api#httpQuery": "maxResults" } } @@ -22858,7 +24278,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of job runs is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of job runs, the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListJobRuns to list the next set of job\n runs.

" + "smithy.api#documentation": "

When the number of job runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of job runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListJobRuns to list the next set of job runs.

" } } }, @@ -22918,7 +24338,7 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of lineage events to return in a single call to ListLineageEvents.\n When the number of lineage events to be listed is greater than the value of MaxResults, the\n response contains a NextToken value that you can use in a subsequent call to\n ListLineageEvents to list the next set of lineage events.

", + "smithy.api#documentation": "

The maximum number of lineage events to return in a single call to ListLineageEvents. When the number of lineage events to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListLineageEvents to list the next set of lineage events.

", "smithy.api#httpQuery": "maxResults" } }, @@ -22953,7 +24373,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of lineage events is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of lineage events, the response includes a pagination token named NextToken. You can\n specify this NextToken value in a subsequent call to ListLineageEvents to list the next set\n of lineage events.

", + "smithy.api#documentation": "

When the number of lineage events is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of lineage events, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageEvents to list the next set of lineage events.

", "smithy.api#httpQuery": "nextToken" } } @@ -22974,7 +24394,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of lineage events is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of lineage events, the response includes a pagination token named NextToken. You can\n specify this NextToken value in a subsequent call to ListLineageEvents to list the next set\n of lineage events.

" + "smithy.api#documentation": "

When the number of lineage events is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of lineage events, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageEvents to list the next set of lineage events.

" } } }, @@ -23029,7 +24449,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the domain where you want to list the history of the specified data lineage\n node.

", + "smithy.api#documentation": "

The ID of the domain where you want to list the history of the specified data lineage node.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -23037,14 +24457,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of history items to return in a single call to\n ListLineageNodeHistory. When the number of memberships to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that you can use in a\n subsequent call to ListLineageNodeHistory to list the next set of items.

", + "smithy.api#documentation": "

The maximum number of history items to return in a single call to ListLineageNodeHistory. When the number of memberships to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListLineageNodeHistory to list the next set of items.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of history items is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of items, the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of\n items.

", + "smithy.api#documentation": "

When the number of history items is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of items, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of items.

", "smithy.api#httpQuery": "nextToken" } }, @@ -23059,21 +24479,21 @@ "direction": { "target": "com.amazonaws.datazone#EdgeDirection", "traits": { - "smithy.api#documentation": "

The direction of the data lineage node refers to the lineage node having neighbors in\n that direction. For example, if direction is UPSTREAM, the\n ListLineageNodeHistory API responds with historical versions with upstream\n neighbors only.

", + "smithy.api#documentation": "

The direction of the data lineage node refers to the lineage node having neighbors in that direction. For example, if direction is UPSTREAM, the ListLineageNodeHistory API responds with historical versions with upstream neighbors only.

", "smithy.api#httpQuery": "direction" } }, "eventTimestampGTE": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

Specifies whether the action is to return data lineage node history from the time after\n the event timestamp.

", + "smithy.api#documentation": "

Specifies whether the action is to return data lineage node history from the time after the event timestamp.

", "smithy.api#httpQuery": "timestampGTE" } }, "eventTimestampLTE": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

Specifies whether the action is to return data lineage node history from the time prior\n of the event timestamp.

", + "smithy.api#documentation": "

Specifies whether the action is to return data lineage node history from the time prior of the event timestamp.

", "smithy.api#httpQuery": "timestampLTE" } }, @@ -23101,7 +24521,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of history items is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of items, the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of\n items.

" + "smithy.api#documentation": "

When the number of history items is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of items, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of items.

" } } }, @@ -23135,7 +24555,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all metadata generation runs.

", + "smithy.api#documentation": "

Lists all metadata generation runs.

Metadata generation runs represent automated processes that leverage AI/ML capabilities to create or enhance asset metadata at scale. This feature helps organizations maintain comprehensive and consistent metadata across large numbers of assets without manual intervention. It can automatically generate business descriptions, tags, and other metadata elements, significantly reducing the time and effort required for metadata management while improving consistency and completeness.

Prerequisites:

  • Valid domain identifier.

  • User must have access to metadata generation runs in the domain.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -23156,7 +24576,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain where you want to list metadata generation\n runs.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain where you want to list metadata generation runs.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -23178,14 +24598,14 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of metadata generation runs is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than\n the number of metadata generation runs, the response includes a pagination token named\n NextToken. You can specify this NextToken value in a subsequent call to\n ListMetadataGenerationRuns to list the next set of revisions.

", + "smithy.api#documentation": "

When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of metadata generation runs to return in a single call to\n ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is\n greater than the value of MaxResults, the response contains a NextToken value that you can\n use in a subsequent call to ListMetadataGenerationRuns to list the next set of\n revisions.

", + "smithy.api#documentation": "

The maximum number of metadata generation runs to return in a single call to ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

", "smithy.api#httpQuery": "maxResults" } } @@ -23206,7 +24626,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of metadata generation runs is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than\n the number of metadata generation runs, the response includes a pagination token named\n NextToken. You can specify this NextToken value in a subsequent call to\n ListMetadataGenerationRuns to list the next set of revisions.

" + "smithy.api#documentation": "

When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

" } } }, @@ -23302,14 +24722,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of notifications to return in a single call to\n ListNotifications. When the number of notifications to be listed is greater\n than the value of MaxResults, the response contains a NextToken\n value that you can use in a subsequent call to ListNotifications to list the\n next set of notifications.

", + "smithy.api#documentation": "

The maximum number of notifications to return in a single call to ListNotifications. When the number of notifications to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListNotifications to list the next set of notifications.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of notifications is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of notifications, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListNotifications to\n list the next set of notifications.

", + "smithy.api#documentation": "

When the number of notifications is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notifications, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotifications to list the next set of notifications.

", "smithy.api#httpQuery": "nextToken" } } @@ -23330,7 +24750,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of notifications is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of notifications, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListNotifications to\n list the next set of notifications.

" + "smithy.api#documentation": "

When the number of notifications is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notifications, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotifications to list the next set of notifications.

" } } }, @@ -23417,14 +24837,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResultsForListDomains", "traits": { - "smithy.api#documentation": "

The maximum number of grants to return in a single call to\n ListPolicyGrants. When the number of grants to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that\n you can use in a subsequent call to ListPolicyGrants to list the next set of\n grants.

", + "smithy.api#documentation": "

The maximum number of grants to return in a single call to ListPolicyGrants. When the number of grants to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListPolicyGrants to list the next set of grants.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of grants is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of grants, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListPolicyGrants to list the next set of\n grants.

", + "smithy.api#documentation": "

When the number of grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListPolicyGrants to list the next set of grants.

", "smithy.api#httpQuery": "nextToken" } } @@ -23446,7 +24866,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of grants is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of grants, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListPolicyGrants to list the next set of\n grants.

" + "smithy.api#documentation": "

When the number of grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListPolicyGrants to list the next set of grants.

" } } }, @@ -23501,7 +24921,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which you want to list project\n memberships.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which you want to list project memberships.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -23531,14 +24951,14 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of memberships is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of memberships, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListProjectMemberships\n to list the next set of memberships.

", + "smithy.api#documentation": "

When the number of memberships is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of memberships, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectMemberships to list the next set of memberships.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of memberships to return in a single call to\n ListProjectMemberships. When the number of memberships to be listed is\n greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListProjectMemberships to list the next set of memberships.

", + "smithy.api#documentation": "

The maximum number of memberships to return in a single call to ListProjectMemberships. When the number of memberships to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListProjectMemberships to list the next set of memberships.

", "smithy.api#httpQuery": "maxResults" } } @@ -23560,7 +24980,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of memberships is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of memberships, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListProjectMemberships\n to list the next set of memberships.

" + "smithy.api#documentation": "

When the number of memberships is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of memberships, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectMemberships to list the next set of memberships.

" } } }, @@ -23641,14 +25061,14 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of project profiles is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of project profiles, the response includes a pagination token named NextToken. You can\n specify this NextToken value in a subsequent call to ListProjectProfiles to list the next\n set of project profiles.

", + "smithy.api#documentation": "

When the number of project profiles is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of project profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectProfiles to list the next set of project profiles.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of project profiles to return in a single call to\n ListProjectProfiles. When the number of project profiles to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that you can use in a\n subsequent call to ListProjectProfiles to list the next set of project profiles.

", + "smithy.api#documentation": "

The maximum number of project profiles to return in a single call to ListProjectProfiles. When the number of project profiles to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListProjectProfiles to list the next set of project profiles.

", "smithy.api#httpQuery": "maxResults" } } @@ -23669,7 +25089,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of project profiles is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of project profiles, the response includes a pagination token named NextToken. You can\n specify this NextToken value in a subsequent call to ListProjectProfiles to list the next\n set of project profiles.

" + "smithy.api#documentation": "

When the number of project profiles is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of project profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectProfiles to list the next set of project profiles.

" } } }, @@ -23750,14 +25170,14 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of projects is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of projects, the response includes\n a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListProjects to list\n the next set of projects.

", + "smithy.api#documentation": "

When the number of projects is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of projects to return in a single call to ListProjects.\n When the number of projects to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that you\n can use in a subsequent call to ListProjects to list the next set of\n projects.

", + "smithy.api#documentation": "

The maximum number of projects to return in a single call to ListProjects. When the number of projects to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListProjects to list the next set of projects.

", "smithy.api#httpQuery": "maxResults" } } @@ -23778,7 +25198,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of projects is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of projects, the response includes\n a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListProjects to list\n the next set of projects.

" + "smithy.api#documentation": "

When the number of projects is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.

" } } }, @@ -23812,7 +25232,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists existing rules. In Amazon DataZone, a rule is a formal agreement that enforces\n specific requirements across user workflows (e.g., publishing assets to the catalog,\n requesting subscriptions, creating projects) within the Amazon DataZone data portal. These\n rules help maintain consistency, ensure compliance, and uphold governance standards in data\n management processes. For instance, a metadata enforcement rule can specify the required\n information for creating a subscription request or publishing a data asset to the catalog,\n ensuring alignment with organizational standards.

", + "smithy.api#documentation": "

Lists existing rules. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -23899,7 +25319,7 @@ "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of rules to return in a single call to ListRules. When\n the number of rules to be listed is greater than the value of MaxResults, the\n response contains a NextToken value that you can use in a subsequent call to\n ListRules to list the next set of rules.

", + "smithy.api#documentation": "

The maximum number of rules to return in a single call to ListRules. When the number of rules to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListRules to list the next set of rules.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 25, @@ -23910,7 +25330,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of rules is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of rules, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListRules to list the next set of rules.

", + "smithy.api#documentation": "

When the number of rules is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of rules, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListRules to list the next set of rules.

", "smithy.api#httpQuery": "nextToken" } } @@ -23932,7 +25352,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of rules is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of rules, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListRules to list the next set of rules.

" + "smithy.api#documentation": "

When the number of rules is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of rules, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListRules to list the next set of rules.

" } } }, @@ -24044,14 +25464,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of subscription grants to return in a single call to\n ListSubscriptionGrants. When the number of subscription grants to be listed\n is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListSubscriptionGrants to list the next set of subscription grants.

", + "smithy.api#documentation": "

The maximum number of subscription grants to return in a single call to ListSubscriptionGrants. When the number of subscription grants to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListSubscriptionGrants to list the next set of subscription grants.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of subscription grants is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription grants, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListSubscriptionGrants\n to list the next set of subscription grants.

", + "smithy.api#documentation": "

When the number of subscription grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionGrants to list the next set of subscription grants.

", "smithy.api#httpQuery": "nextToken" } } @@ -24073,7 +25493,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of subscription grants is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription grants, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListSubscriptionGrants\n to list the next set of subscription grants.

" + "smithy.api#documentation": "

When the number of subscription grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionGrants to list the next set of subscription grants.

" } } }, @@ -24136,7 +25556,7 @@ "status": { "target": "com.amazonaws.datazone#SubscriptionRequestStatus", "traits": { - "smithy.api#documentation": "

Specifies the status of the subscription requests.

\n \n

This is not a required parameter, but if not specified, by default, Amazon DataZone\n returns only PENDING subscription requests.

\n
", + "smithy.api#documentation": "

Specifies the status of the subscription requests.

This is not a required parameter, but if not specified, by default, Amazon DataZone returns only PENDING subscription requests.

", "smithy.api#httpQuery": "status" } }, @@ -24178,14 +25598,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of subscription requests to return in a single call to\n ListSubscriptionRequests. When the number of subscription requests to be\n listed is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListSubscriptionRequests to list the next set of subscription\n requests.

", + "smithy.api#documentation": "

The maximum number of subscription requests to return in a single call to ListSubscriptionRequests. When the number of subscription requests to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of subscription requests is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription requests, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListSubscriptionRequests to list the next set of subscription\n requests.

", + "smithy.api#documentation": "

When the number of subscription requests is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription requests, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.

", "smithy.api#httpQuery": "nextToken" } } @@ -24207,7 +25627,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of subscription requests is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription requests, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListSubscriptionRequests to list the next set of subscription\n requests.

" + "smithy.api#documentation": "

When the number of subscription requests is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription requests, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.

" } } }, @@ -24262,7 +25682,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain where you want to list subscription\n targets.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain where you want to list subscription targets.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -24292,14 +25712,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of subscription targets to return in a single call to\n ListSubscriptionTargets. When the number of subscription targets to be\n listed is greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListSubscriptionTargets to list the next set of subscription targets.\n

", + "smithy.api#documentation": "

The maximum number of subscription targets to return in a single call to ListSubscriptionTargets. When the number of subscription targets to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListSubscriptionTargets to list the next set of subscription targets.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of subscription targets is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription targets, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListSubscriptionTargets to list the next set of subscription\n targets.

", + "smithy.api#documentation": "

When the number of subscription targets is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription targets, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionTargets to list the next set of subscription targets.

", "smithy.api#httpQuery": "nextToken" } } @@ -24321,7 +25741,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of subscription targets is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscription targets, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to\n ListSubscriptionTargets to list the next set of subscription\n targets.

" + "smithy.api#documentation": "

When the number of subscription targets is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription targets, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionTargets to list the next set of subscription targets.

" } } }, @@ -24384,21 +25804,21 @@ "subscriptionRequestIdentifier": { "target": "com.amazonaws.datazone#SubscriptionRequestId", "traits": { - "smithy.api#documentation": "

The identifier of the subscription request for the subscriptions that you want to\n list.

", + "smithy.api#documentation": "

The identifier of the subscription request for the subscriptions that you want to list.

", "smithy.api#httpQuery": "subscriptionRequestIdentifier" } }, "status": { "target": "com.amazonaws.datazone#SubscriptionStatus", "traits": { - "smithy.api#documentation": "

The status of the subscriptions that you want to list.

\n \n

This is not a required parameter, but if not provided, by default, Amazon DataZone\n returns only APPROVED subscriptions.

\n
", + "smithy.api#documentation": "

The status of the subscriptions that you want to list.

This is not a required parameter, but if not provided, by default, Amazon DataZone returns only APPROVED subscriptions.

", "smithy.api#httpQuery": "status" } }, "subscribedListingId": { "target": "com.amazonaws.datazone#ListingId", "traits": { - "smithy.api#documentation": "

The identifier of the subscribed listing for the subscriptions that you want to\n list.

", + "smithy.api#documentation": "

The identifier of the subscribed listing for the subscriptions that you want to list.

", "smithy.api#httpQuery": "subscribedListingId" } }, @@ -24433,14 +25853,14 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of subscriptions to return in a single call to\n ListSubscriptions. When the number of subscriptions to be listed is greater\n than the value of MaxResults, the response contains a NextToken\n value that you can use in a subsequent call to ListSubscriptions to list the\n next set of Subscriptions.

", + "smithy.api#documentation": "

The maximum number of subscriptions to return in a single call to ListSubscriptions. When the number of subscriptions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListSubscriptions to list the next set of Subscriptions.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of subscriptions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscriptions, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListSubscriptions to\n list the next set of subscriptions.

", + "smithy.api#documentation": "

When the number of subscriptions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscriptions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptions to list the next set of subscriptions.

", "smithy.api#httpQuery": "nextToken" } } @@ -24462,7 +25882,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of subscriptions is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of subscriptions, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListSubscriptions to\n list the next set of subscriptions.

" + "smithy.api#documentation": "

When the number of subscriptions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscriptions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptions to list the next set of subscriptions.

" } } }, @@ -24575,7 +25995,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain that houses the assets for which you want to list\n time series data points.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -24621,14 +26041,14 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of data points is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of data points, the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set\n of data points.

", + "smithy.api#documentation": "

When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of data points to return in a single call to\n ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that you can use in a\n subsequent call to ListTimeSeriesDataPoints to list the next set of data points.

", + "smithy.api#documentation": "

The maximum number of data points to return in a single call to ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.

", "smithy.api#httpQuery": "maxResults" } } @@ -24649,7 +26069,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of data points is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of data points, the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set\n of data points.

" + "smithy.api#documentation": "

When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.

" } } }, @@ -24772,14 +26192,14 @@ "identifier": { "target": "com.amazonaws.datazone#ListingId", "traits": { - "smithy.api#documentation": "

An identifier of revision to be made to an asset published in a Amazon DataZone\n catalog.

", + "smithy.api#documentation": "

An identifier of revision to be made to an asset published in a Amazon DataZone catalog.

", "smithy.api#required": {} } }, "revision": { "target": "com.amazonaws.datazone#Revision", "traits": { - "smithy.api#documentation": "

The details of a revision to be made to an asset published in a Amazon DataZone\n catalog.

", + "smithy.api#documentation": "

The details of a revision to be made to an asset published in a Amazon DataZone catalog.

", "smithy.api#required": {} } } @@ -24884,6 +26304,30 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.datazone#ManagedEndpointCredentials": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of the managed endpoint credentials.

", + "smithy.api#length": { + "max": 64 + } + } + }, + "token": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of the managed endpoint credentials.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The managed endpoint credentials of the EMR on EKS cluster.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.datazone#ManagedPolicyType": { "type": "enum", "members": { @@ -25244,7 +26688,7 @@ "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the metadata generation run was\n created.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the metadata generation run was created.

", "smithy.api#required": {} } }, @@ -25288,7 +26732,7 @@ "owningProjectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The ID of the project that owns the asset for which the metadata generation was\n ran.

", + "smithy.api#documentation": "

The ID of the project that owns the asset for which the metadata generation was ran.

", "smithy.api#required": {} } } @@ -25716,7 +27160,7 @@ "aWSManagedClientApplicationReference": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services managed client application reference in the OAuth2Client\n application.

", + "smithy.api#documentation": "

The Amazon Web Services managed client application reference in the OAuth2Client application.

", "smithy.api#length": { "max": 2048 }, @@ -26194,7 +27638,7 @@ "createGlossary": { "target": "com.amazonaws.datazone#CreateGlossaryPolicyGrantDetail", "traits": { - "smithy.api#documentation": "

Specifies that this is a create glossary policy.

" + "smithy.api#documentation": "

Specifies that this is a create glossary policy.

" } }, "createFormType": { @@ -26245,7 +27689,7 @@ "useAssetType": { "target": "com.amazonaws.datazone#UseAssetTypePolicyGrantDetail", "traits": { - "smithy.api#documentation": "

Specifies the domain unit(s) whose projects can use this asset type while creating\n asset or asset revisions.

" + "smithy.api#documentation": "

Specifies the domain unit(s) whose projects can use this asset type while creating asset or asset revisions.

" } } }, @@ -26285,6 +27729,12 @@ "traits": { "smithy.api#documentation": "

Specifies the user who created the policy grant member.

" } + }, + "grantId": { + "target": "com.amazonaws.datazone#GrantIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the policy grant.

" + } } }, "traits": { @@ -26378,7 +27828,7 @@ "event": { "target": "com.amazonaws.datazone#LineageEvent", "traits": { - "smithy.api#documentation": "

The data lineage event that you want to post. Only open-lineage run event are supported\n as events.

", + "smithy.api#documentation": "

The data lineage event that you want to post. Only open-lineage run event are supported as events.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -26386,7 +27836,7 @@ "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#httpHeader": "Client-Token", "smithy.api#idempotencyToken": {} } @@ -26463,7 +27913,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which you want to post time series data\n points.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which you want to post time series data points.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -26494,7 +27944,7 @@ "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -26509,7 +27959,7 @@ "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which you want to post time series data\n points.

" + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which you want to post time series data points.

" } }, "entityId": { @@ -26572,7 +28022,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "com.amazonaws.datazone#ProjectDesignation": { @@ -26819,6 +28269,12 @@ "traits": { "smithy.api#enumValue": "UPDATE_FAILED" } + }, + "MOVING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MOVING" + } } } }, @@ -26867,7 +28323,7 @@ "failureReasons": { "target": "com.amazonaws.datazone#FailureReasons", "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "createdBy": { @@ -27017,7 +28473,7 @@ "cloudFormation": { "target": "com.amazonaws.datazone#CloudFormationProperties", "traits": { - "smithy.api#documentation": "

The cloud formation properties included as part of the provisioning properties of an\n environment blueprint.

" + "smithy.api#documentation": "

The cloud formation properties included as part of the provisioning properties of an environment blueprint.

" } } }, @@ -27113,6 +28569,13 @@ "smithy.api#documentation": "

The regional parameters in the environment blueprint.

" } }, + "globalParameters": { + "target": "com.amazonaws.datazone#GlobalParameterMap", + "traits": { + "smithy.api#documentation": "

Region-agnostic environment blueprint parameters.

", + "smithy.api#notProperty": {} + } + }, "provisioningConfigurations": { "target": "com.amazonaws.datazone#ProvisioningConfigurationList", "traits": { @@ -27204,12 +28667,12 @@ "enableBusinessNameGeneration": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether automatic business name generation is to be enabled or not as part of\n the recommendation configuration.

" + "smithy.api#documentation": "

Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.

" } } }, "traits": { - "smithy.api#documentation": "

The recommendation to be updated as part of the UpdateDataSource\n action.

" + "smithy.api#documentation": "

The recommendation to be updated as part of the UpdateDataSource action.

" } }, "com.amazonaws.datazone#RedshiftClusterStorage": { @@ -27487,14 +28950,14 @@ "dataAccessRole": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Redshift data\n source.

", + "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Redshift data source.

", "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" } }, "relationalFilterConfigurations": { "target": "com.amazonaws.datazone#RelationalFilterConfigurations", "traits": { - "smithy.api#documentation": "

The relational filger configurations included in the configuration details of the Amazon\n Redshift data source.

", + "smithy.api#documentation": "

The relational filger configurations included in the configuration details of the Amazon Redshift data source.

", "smithy.api#required": {} } }, @@ -27515,7 +28978,7 @@ "accountId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift\n data source.

", + "smithy.api#documentation": "

The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift data source.

", "smithy.api#length": { "min": 12, "max": 12 @@ -27526,7 +28989,7 @@ "region": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services region included in the configuration details of the Amazon Redshift data\n source.

", + "smithy.api#documentation": "

The Amazon Web Services region included in the configuration details of the Amazon Redshift data source.

", "smithy.api#length": { "min": 4, "max": 16 @@ -27537,14 +29000,14 @@ "dataAccessRole": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Redshift data\n source.

", + "smithy.api#documentation": "

The data access role included in the configuration details of the Amazon Redshift data source.

", "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$" } }, "relationalFilterConfigurations": { "target": "com.amazonaws.datazone#RelationalFilterConfigurations", "traits": { - "smithy.api#documentation": "

The relational filger configurations included in the configuration details of the Amazon\n Redshift data source.

", + "smithy.api#documentation": "

The relational filger configurations included in the configuration details of the Amazon Redshift data source.

", "smithy.api#required": {} } }, @@ -27614,7 +29077,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details of the Amazon Redshift storage as part of the configuration of an Amazon\n Redshift data source run.

" + "smithy.api#documentation": "

The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.

" } }, "com.amazonaws.datazone#RedshiftStorageProperties": { @@ -27698,7 +29161,7 @@ "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Specifies the target (for example, a column name) where a prediction can be\n rejected.

", + "smithy.api#documentation": "

Specifies the target (for example, a column name) where a prediction can be rejected.

", "smithy.api#required": {} } }, @@ -27748,7 +29211,7 @@ } ], "traits": { - "smithy.api#documentation": "

Rejects automatically generated business-friendly metadata for your Amazon DataZone\n assets.

", + "smithy.api#documentation": "

Rejects automatically generated business-friendly metadata for your Amazon DataZone assets.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -27792,13 +29255,13 @@ "rejectChoices": { "target": "com.amazonaws.datazone#RejectChoices", "traits": { - "smithy.api#documentation": "

Specifies the prediction (aka, the automatically generated piece of metadata) and the\n target (for example, a column name) that can be rejected.

" + "smithy.api#documentation": "

Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be rejected.

" } }, "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -27848,7 +29311,7 @@ "threshold": { "target": "smithy.api#Float", "traits": { - "smithy.api#documentation": "

The confidence score that specifies the condition at which a prediction can be\n rejected.

" + "smithy.api#documentation": "

The confidence score that specifies the condition at which a prediction can be rejected.

" } } }, @@ -27917,7 +29380,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which the subscription request was\n rejected.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which the subscription request was rejected.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -27967,7 +29430,7 @@ "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which the subscription request was\n rejected.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which the subscription request was rejected.

", "smithy.api#required": {} } }, @@ -28056,7 +29519,7 @@ "databaseName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The database name specified in the relational filter configuration for the data\n source.

", + "smithy.api#documentation": "

The database name specified in the relational filter configuration for the data source.

", "smithy.api#length": { "min": 1, "max": 128 @@ -28067,7 +29530,7 @@ "schemaName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The schema name specified in the relational filter configuration for the data\n source.

", + "smithy.api#documentation": "

The schema name specified in the relational filter configuration for the data source.

", "smithy.api#length": { "min": 1, "max": 128 @@ -28077,7 +29540,7 @@ "filterExpressions": { "target": "com.amazonaws.datazone#FilterExpressions", "traits": { - "smithy.api#documentation": "

The filter expressions specified in the relational filter configuration for the data\n source.

" + "smithy.api#documentation": "

The filter expressions specified in the relational filter configuration for the data source.

" } } }, @@ -28166,7 +29629,7 @@ "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -28258,10 +29721,16 @@ "smithy.api#required": {} } }, + "grantIdentifier": { + "target": "com.amazonaws.datazone#GrantIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the policy grant that is to be removed from a specified entity.

" + } + }, "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -28299,6 +29768,17 @@ } } }, + "com.amazonaws.datazone#ResolutionStrategy": { + "type": "enum", + "members": { + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, "com.amazonaws.datazone#Resource": { "type": "structure", "members": { @@ -29042,7 +30522,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\n connection.

" + "smithy.api#documentation": "

The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection.

" } } }, @@ -29063,7 +30543,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\n connection.

" + "smithy.api#documentation": "

The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection.

" } }, "status": { @@ -29096,7 +30576,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\n a connection.

" + "smithy.api#documentation": "

The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties patch of a connection.

" } } }, @@ -29224,7 +30704,7 @@ } ], "traits": { - "smithy.api#documentation": "

Searches for assets in Amazon DataZone.

", + "smithy.api#documentation": "

Searches for assets in Amazon DataZone.

Search in Amazon DataZone is a powerful capability that enables users to discover and explore data assets, glossary terms, and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. Search can be scoped to specific types of resources (like assets, glossary terms, or data products) and can be filtered using various criteria such as creation date, owner, or status. The search functionality is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.

Many search commands in Amazon DataZone are paginated, including search and search-types. When the result set is large, Amazon DataZone returns a nextToken in the response. This token can be used to retrieve the next page of results.

Prerequisites:

  • The --domain-identifier must refer to an existing Amazon DataZone domain.

  • --search-scope must be one of: ASSET, GLOSSARY_TERM, DATA_PRODUCT, or GLOSSARY.

  • The user must have search permissions in the specified domain.

  • If using --filters, ensure that the JSON is well-formed and that each filter includes valid attribute and value keys.

  • For paginated results, be prepared to use --next-token to fetch additional pages.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -29284,7 +30764,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which you want to search group\n profiles.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which you want to search group profiles.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -29305,13 +30785,13 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call to\n SearchGroupProfiles. When the number of results to be listed is greater\n than the value of MaxResults, the response contains a NextToken\n value that you can use in a subsequent call to SearchGroupProfiles to list the\n next set of results.

" + "smithy.api#documentation": "

The maximum number of results to return in a single call to SearchGroupProfiles. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchGroupProfiles to list the next set of results.

" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchGroupProfiles to list the next set of\n results.

" + "smithy.api#documentation": "

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchGroupProfiles to list the next set of results.

" } } }, @@ -29331,7 +30811,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchGroupProfiles to list the next set of\n results.

" + "smithy.api#documentation": "

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchGroupProfiles to list the next set of results.

" } } }, @@ -29386,13 +30866,13 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call to Search. When\n the number of results to be listed is greater than the value of MaxResults,\n the response contains a NextToken value that you can use in a subsequent call\n to Search to list the next set of results.

" + "smithy.api#documentation": "

The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.

" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to Search to list the next set of results.

" + "smithy.api#documentation": "

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

" } }, "searchScope": { @@ -29498,7 +30978,7 @@ } ], "traits": { - "smithy.api#documentation": "

Searches listings (records of an asset at a given time) in Amazon DataZone.

", + "smithy.api#documentation": "

Searches listings in Amazon DataZone.

SearchListings is a powerful capability that enables users to discover and explore published assets and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. SearchListings also supports filtering using various criteria such as creation date, owner, or status. This API is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.

SearchListings returns results in a paginated format. When the result set is large, the response will include a nextToken, which can be used to retrieve the next page of results.

The SearchListings API gives users flexibility in specifying what kind of search is run.

To run a free-text search, the searchText parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the CreateFormType API documentation. To run a lexical search query, enclose the query with double quotes (\"\"). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone#searchable.

To run a filtered search, provide filter clause using the filters parameter. To filter on glossary terms, use the special attribute __DataZoneGlossaryTerms.

To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -29541,13 +31021,13 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call to SearchListings.\n When the number of results to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that you\n can use in a subsequent call to SearchListings to list the next set of\n results.

" + "smithy.api#documentation": "

The maximum number of results to return in a single call to SearchListings. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchListings to list the next set of results.

" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchListings to list the next set of\n results.

" + "smithy.api#documentation": "

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchListings to list the next set of results.

" } }, "filters": { @@ -29559,7 +31039,7 @@ "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.

" + "smithy.api#documentation": "

Enables you to specify one or more attributes to compute and return counts grouped by field values.

" } }, "sort": { @@ -29591,7 +31071,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchListings to list the next set of\n results.

" + "smithy.api#documentation": "

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchListings to list the next set of results.

" } }, "totalMatchCount": { @@ -29603,7 +31083,7 @@ "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.

" + "smithy.api#documentation": "

Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.

" } } }, @@ -29623,7 +31103,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to Search to list the next set of results.

" + "smithy.api#documentation": "

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

" } }, "totalMatchCount": { @@ -29675,7 +31155,7 @@ "assetListing": { "target": "com.amazonaws.datazone#AssetListingItem", "traits": { - "smithy.api#documentation": "

The asset listing included in the results of the SearchListings\n action.

" + "smithy.api#documentation": "

The asset listing included in the results of the SearchListings action.

" } }, "dataProductListing": { @@ -29748,7 +31228,7 @@ } ], "traits": { - "smithy.api#documentation": "

Searches for types in Amazon DataZone.

", + "smithy.api#documentation": "

Searches for types in Amazon DataZone.

Prerequisites:

  • The --domain-identifier must refer to an existing Amazon DataZone domain.

  • --search-scope must be one of the valid values including: ASSET_TYPE, GLOSSARY_TERM_TYPE, DATA_PRODUCT_TYPE.

  • The --managed flag must be present without a value.

  • The user must have permissions for form or asset types in the domain.

  • If using --filters, ensure that the JSON is valid.

  • Filters contain correct structure (attribute, value, operator).

", "smithy.api#http": { "code": 200, "method": "POST", @@ -29768,7 +31248,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which to invoke the SearchTypes\n action.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which to invoke the SearchTypes action.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -29776,13 +31256,13 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call to SearchTypes.\n When the number of results to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that you\n can use in a subsequent call to SearchTypes to list the next set of results.\n

" + "smithy.api#documentation": "

The maximum number of results to return in a single call to SearchTypes. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchTypes to list the next set of results.

" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchTypes to list the next set of\n results.

" + "smithy.api#documentation": "

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchTypes to list the next set of results.

" } }, "searchScope": { @@ -29840,7 +31320,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchTypes to list the next set of\n results.

" + "smithy.api#documentation": "

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchTypes to list the next set of results.

" } }, "totalMatchCount": { @@ -29932,7 +31412,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which you want to search user\n profiles.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which you want to search user profiles.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -29953,13 +31433,13 @@ "maxResults": { "target": "com.amazonaws.datazone#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call to\n SearchUserProfiles. When the number of results to be listed is greater than\n the value of MaxResults, the response contains a NextToken value\n that you can use in a subsequent call to SearchUserProfiles to list the next\n set of results.

" + "smithy.api#documentation": "

The maximum number of results to return in a single call to SearchUserProfiles. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchUserProfiles to list the next set of results.

" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchUserProfiles to list the next set of\n results.

" + "smithy.api#documentation": "

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchUserProfiles to list the next set of results.

" } } }, @@ -29979,7 +31459,7 @@ "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "

When the number of results is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of results, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to SearchUserProfiles to list the next set of\n results.

" + "smithy.api#documentation": "

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchUserProfiles to list the next set of results.

" } } }, @@ -30181,6 +31661,17 @@ } } }, + "com.amazonaws.datazone#SortFieldAccountPool": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + } + } + }, "com.amazonaws.datazone#SortFieldConnection": { "type": "enum", "members": { @@ -30245,8 +31736,9 @@ "traits": { "smithy.api#documentation": "

The compute ARN of Spark EMR.

", "smithy.api#length": { - "max": 256 - } + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-(cn|us-gov|iso(-[bef])?))?:(elasticmapreduce|emr-serverless|emr-containers):.*" } }, "instanceProfileArn": { @@ -30300,6 +31792,15 @@ "max": 256 } } + }, + "managedEndpointArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The managed endpoint ARN of the EMR on EKS cluster.

", + "smithy.api#length": { + "max": 2048 + } + } } }, "traits": { @@ -30375,6 +31876,27 @@ "traits": { "smithy.api#documentation": "

The trusted certificate S3 URL of the Spark EMR.

" } + }, + "certificateData": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The certificate data of the EMR on EKS cluster.

" + } + }, + "managedEndpointArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The managed endpoint ARN of the EMR on EKS cluster.

", + "smithy.api#length": { + "max": 2048 + } + } + }, + "managedEndpointCredentials": { + "target": "com.amazonaws.datazone#ManagedEndpointCredentials", + "traits": { + "smithy.api#documentation": "

The managed endpoint credentials of the EMR on EKS cluster.

" + } } }, "traits": { @@ -30389,8 +31911,9 @@ "traits": { "smithy.api#documentation": "

The compute ARN in the Spark EMR properties patch.

", "smithy.api#length": { - "max": 256 - } + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-(cn|us-gov|iso(-[bef])?))?:(elasticmapreduce|emr-serverless|emr-containers):.*" } }, "instanceProfileArn": { @@ -30444,6 +31967,15 @@ "max": 256 } } + }, + "managedEndpointArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The managed endpoint ARN of the EMR on EKS cluster.

", + "smithy.api#length": { + "max": 2048 + } + } } }, "traits": { @@ -30476,7 +32008,7 @@ "glueConnectionName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Glue connection name in the Spark Amazon Web Services Glue\n properties.

", + "smithy.api#documentation": "

The Amazon Web Services Glue connection name in the Spark Amazon Web Services Glue properties.

", "smithy.api#length": { "max": 256 } @@ -30485,7 +32017,7 @@ "glueVersion": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Glue version in the Spark Amazon Web Services Glue\n properties.

", + "smithy.api#documentation": "

The Amazon Web Services Glue version in the Spark Amazon Web Services Glue properties.

", "smithy.api#length": { "max": 256 } @@ -30547,13 +32079,13 @@ "glueConnectionName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Glue connection name in the Spark Amazon Web Services Glue\n properties.

" + "smithy.api#documentation": "

The Amazon Web Services Glue connection name in the Spark Amazon Web Services Glue properties.

" } }, "glueVersion": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Glue version in the Spark Amazon Web Services Glue properties.\n

" + "smithy.api#documentation": "

The Amazon Web Services Glue version in the Spark Amazon Web Services Glue properties.

" } }, "idleTimeout": { @@ -30680,7 +32212,7 @@ "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -30749,7 +32281,7 @@ "errorMessage": { "target": "com.amazonaws.datazone#DataSourceErrorMessage", "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "createdAt": { @@ -30815,7 +32347,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts the metadata generation run.

", + "smithy.api#documentation": "

Starts the metadata generation run.

Prerequisites:

  • Asset must be created and belong to the specified domain and project.

  • Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table).

  • Asset must have a structured schema with valid rows and columns.

  • Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES.

  • The user must have permission to run metadata generation in the domain/project.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -30830,7 +32362,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain where you want to start a metadata generation\n run.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain where you want to start a metadata generation run.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -30852,14 +32384,14 @@ "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure idempotency of the request. This field is\n automatically populated if not provided.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

", "smithy.api#idempotencyToken": {} } }, "owningProjectIdentifier": { "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The ID of the project that owns the asset for which you want to start a metadata\n generation run.

", + "smithy.api#documentation": "

The ID of the project that owns the asset for which you want to start a metadata generation run.

", "smithy.api#required": {} } } @@ -30874,7 +32406,7 @@ "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the metadata generation run was\n started.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the metadata generation run was started.

", "smithy.api#required": {} } }, @@ -30912,7 +32444,7 @@ "owningProjectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The ID of the project that owns the asset for which the metadata generation run was\n started.

" + "smithy.api#documentation": "

The ID of the project that owns the asset for which the metadata generation run was started.

" } } }, @@ -30997,7 +32529,7 @@ "failureCause": { "target": "com.amazonaws.datazone#FailureCause", "traits": { - "smithy.api#documentation": "

The failure cause included in the details of the asset for which the subscription grant\n is created.

" + "smithy.api#documentation": "

The failure cause included in the details of the asset for which the subscription grant is created.

" } }, "grantedTimestamp": { @@ -31009,7 +32541,7 @@ "failureTimestamp": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The failure timestamp included in the details of the asset for which the subscription\n grant is created.

" + "smithy.api#documentation": "

The failure timestamp included in the details of the asset for which the subscription grant is created.

" } }, "assetScope": { @@ -31029,7 +32561,7 @@ "entityId": { "target": "com.amazonaws.datazone#AssetId", "traits": { - "smithy.api#documentation": "

The identifier of the published asset for which the subscription grant is\n created.

" + "smithy.api#documentation": "

The identifier of the published asset for which the subscription grant is created.

" } }, "entityRevision": { @@ -31047,13 +32579,13 @@ "forms": { "target": "com.amazonaws.datazone#Forms", "traits": { - "smithy.api#documentation": "

The forms attached to the published asset for which the subscription grant is\n created.

" + "smithy.api#documentation": "

The forms attached to the published asset for which the subscription grant is created.

" } }, "glossaryTerms": { "target": "com.amazonaws.datazone#DetailedGlossaryTerms", "traits": { - "smithy.api#documentation": "

The glossary terms attached to the published asset for which the subscription grant is\n created.

" + "smithy.api#documentation": "

The glossary terms attached to the published asset for which the subscription grant is created.

" } }, "assetScope": { @@ -31079,7 +32611,7 @@ "id": { "target": "com.amazonaws.datazone#ListingId", "traits": { - "smithy.api#documentation": "

The identifier of the published asset for which the subscription grant is\n created.

", + "smithy.api#documentation": "

The identifier of the published asset for which the subscription grant is created.

", "smithy.api#required": {} } }, @@ -31099,7 +32631,7 @@ "description": { "target": "com.amazonaws.datazone#Description", "traits": { - "smithy.api#documentation": "

The description of the published asset for which the subscription grant is\n created.

", + "smithy.api#documentation": "

The description of the published asset for which the subscription grant is created.

", "smithy.api#required": {} } }, @@ -31113,14 +32645,14 @@ "ownerProjectId": { "target": "com.amazonaws.datazone#ProjectId", "traits": { - "smithy.api#documentation": "

The identifier of the project of the published asset for which the subscription grant is\n created.

", + "smithy.api#documentation": "

The identifier of the project of the published asset for which the subscription grant is created.

", "smithy.api#required": {} } }, "ownerProjectName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the project that owns the published asset for which the subscription grant\n is created.

" + "smithy.api#documentation": "

The name of the project that owns the published asset for which the subscription grant is created.

" } } }, @@ -31134,7 +32666,7 @@ "identifier": { "target": "com.amazonaws.datazone#ListingId", "traits": { - "smithy.api#documentation": "

The identifier of the published asset for which the subscription grant is to be\n created.

", + "smithy.api#documentation": "

The identifier of the published asset for which the subscription grant is to be created.

", "smithy.api#required": {} } } @@ -31451,7 +32983,7 @@ "updatedAt": { "target": "com.amazonaws.datazone#UpdatedAt", "traits": { - "smithy.api#documentation": "

The timestampf of when the subscription grant was updated.

", + "smithy.api#documentation": "

The timestamp of when the subscription grant was updated.

", "smithy.api#required": {} } }, @@ -32923,6 +34455,173 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#UpdateAccountPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UpdateAccountPoolInput" + }, + "output": { + "target": "com.amazonaws.datazone#UpdateAccountPoolOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the account pool.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/account-pools/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UpdateAccountPoolInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The domain ID where the account pool that is to be updated lives.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#AccountPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the account pool that is to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#AccountPoolName", + "traits": { + "smithy.api#documentation": "

The name of the account pool that is to be updated.

" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the account pool that is to be udpated.

" + } + }, + "resolutionStrategy": { + "target": "com.amazonaws.datazone#ResolutionStrategy", + "traits": { + "smithy.api#documentation": "

The mechanism used to resolve the account selection from the account pool.

" + } + }, + "accountSource": { + "target": "com.amazonaws.datazone#AccountSource", + "traits": { + "smithy.api#documentation": "

The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#UpdateAccountPoolOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The domain ID where the account pool that is to be updated lives.

" + } + }, + "name": { + "target": "com.amazonaws.datazone#AccountPoolName", + "traits": { + "smithy.api#documentation": "

The name of the account pool that is to be updated.

" + } + }, + "id": { + "target": "com.amazonaws.datazone#AccountPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the account pool that is to be updated.

" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the account pool that is to be udpated.

" + } + }, + "resolutionStrategy": { + "target": "com.amazonaws.datazone#ResolutionStrategy", + "traits": { + "smithy.api#documentation": "

The mechanism used to resolve the account selection from the account pool.

" + } + }, + "accountSource": { + "target": "com.amazonaws.datazone#AccountSource", + "traits": { + "smithy.api#documentation": "

The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.

", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user who created the account pool.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the account pool was created.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the account pool was last updated.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "

The user who last updated the account pool.

" + } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "

The domain ID in which the account pool that is to be updated lives.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#UpdateAssetFilter": { "type": "operation", "input": { @@ -32952,7 +34651,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an asset filter.

", + "smithy.api#documentation": "

Updates an asset filter.

Prerequisites:

  • The domain, asset, and asset filter identifier must all exist.

  • The asset must contain the columns being referenced in the update.

  • If applying a row filter, ensure the column referenced in the expression exists in the asset schema.

", "smithy.api#http": { "code": 200, "method": "PATCH", @@ -33122,7 +34821,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a connection. In Amazon DataZone, a connection enables you to connect your\n resources (domains, projects, and environments) to external resources and services.

", + "smithy.api#documentation": "

Updates a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

", "smithy.api#http": { "code": 200, "method": "PATCH", @@ -33320,25 +35019,25 @@ "description": { "target": "com.amazonaws.datazone#Description", "traits": { - "smithy.api#documentation": "

The description to be updated as part of the UpdateDataSource\n action.

" + "smithy.api#documentation": "

The description to be updated as part of the UpdateDataSource action.

" } }, "enableSetting": { "target": "com.amazonaws.datazone#EnableSetting", "traits": { - "smithy.api#documentation": "

The enable setting to be updated as part of the UpdateDataSource\n action.

" + "smithy.api#documentation": "

The enable setting to be updated as part of the UpdateDataSource action.

" } }, "publishOnImport": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

The publish on import setting to be updated as part of the UpdateDataSource\n action.

" + "smithy.api#documentation": "

The publish on import setting to be updated as part of the UpdateDataSource action.

" } }, "assetFormsInput": { "target": "com.amazonaws.datazone#FormInputList", "traits": { - "smithy.api#documentation": "

The asset forms to be updated as part of the UpdateDataSource\n action.

" + "smithy.api#documentation": "

The asset forms to be updated as part of the UpdateDataSource action.

" } }, "schedule": { @@ -33350,20 +35049,20 @@ "configuration": { "target": "com.amazonaws.datazone#DataSourceConfigurationInput", "traits": { - "smithy.api#documentation": "

The configuration to be updated as part of the UpdateDataSource\n action.

", + "smithy.api#documentation": "

The configuration to be updated as part of the UpdateDataSource action.

", "smithy.api#notProperty": {} } }, "recommendation": { "target": "com.amazonaws.datazone#RecommendationConfiguration", "traits": { - "smithy.api#documentation": "

The recommendation to be updated as part of the UpdateDataSource\n action.

" + "smithy.api#documentation": "

The recommendation to be updated as part of the UpdateDataSource action.

" } }, "retainPermissionsOnRevokeFailure": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies that the granted permissions are retained in case of a self-subscribe\n functionality failure for a data source.

" + "smithy.api#documentation": "

Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.

" } } }, @@ -33403,7 +35102,7 @@ "description": { "target": "com.amazonaws.datazone#Description", "traits": { - "smithy.api#documentation": "

The description to be updated as part of the UpdateDataSource\n action.

" + "smithy.api#documentation": "

The description to be updated as part of the UpdateDataSource action.

" } }, "domainId": { @@ -33435,32 +35134,32 @@ "configuration": { "target": "com.amazonaws.datazone#DataSourceConfigurationOutput", "traits": { - "smithy.api#documentation": "

The configuration to be updated as part of the UpdateDataSource\n action.

", + "smithy.api#documentation": "

The configuration to be updated as part of the UpdateDataSource action.

", "smithy.api#notProperty": {} } }, "recommendation": { "target": "com.amazonaws.datazone#RecommendationConfiguration", "traits": { - "smithy.api#documentation": "

The recommendation to be updated as part of the UpdateDataSource\n action.

" + "smithy.api#documentation": "

The recommendation to be updated as part of the UpdateDataSource action.

" } }, "enableSetting": { "target": "com.amazonaws.datazone#EnableSetting", "traits": { - "smithy.api#documentation": "

The enable setting to be updated as part of the UpdateDataSource\n action.

" + "smithy.api#documentation": "

The enable setting to be updated as part of the UpdateDataSource action.

" } }, "publishOnImport": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

The publish on import setting to be updated as part of the UpdateDataSource\n action.

" + "smithy.api#documentation": "

The publish on import setting to be updated as part of the UpdateDataSource action.

" } }, "assetFormsOutput": { "target": "com.amazonaws.datazone#FormOutputList", "traits": { - "smithy.api#documentation": "

The asset forms to be updated as part of the UpdateDataSource\n action.

" + "smithy.api#documentation": "

The asset forms to be updated as part of the UpdateDataSource action.

" } }, "schedule": { @@ -33490,7 +35189,7 @@ "errorMessage": { "target": "com.amazonaws.datazone#DataSourceErrorMessage", "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "createdAt": { @@ -33515,7 +35214,7 @@ "retainPermissionsOnRevokeFailure": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies that the granted permissions are retained in case of a self-subscribe\n functionality failure for a data source.

" + "smithy.api#documentation": "

Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.

" } } }, @@ -33587,13 +35286,13 @@ "singleSignOn": { "target": "com.amazonaws.datazone#SingleSignOn", "traits": { - "smithy.api#documentation": "

The single sign-on option to be updated as part of the UpdateDomain\n action.

" + "smithy.api#documentation": "

The single sign-on option to be updated as part of the UpdateDomain action.

" } }, "domainExecutionRole": { "target": "com.amazonaws.datazone#RoleArn", "traits": { - "smithy.api#documentation": "

The domain execution role to be updated as part of the UpdateDomain\n action.

" + "smithy.api#documentation": "

The domain execution role to be updated as part of the UpdateDomain action.

" } }, "serviceRole": { @@ -33611,7 +35310,7 @@ "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} } @@ -33652,7 +35351,7 @@ "domainExecutionRole": { "target": "com.amazonaws.datazone#RoleArn", "traits": { - "smithy.api#documentation": "

The domain execution role to be updated as part of the UpdateDomain\n action.

" + "smithy.api#documentation": "

The domain execution role to be updated as part of the UpdateDomain action.

" } }, "serviceRole": { @@ -34000,6 +35699,163 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#UpdateEnvironmentBlueprint": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UpdateEnvironmentBlueprintInput" + }, + "output": { + "target": "com.amazonaws.datazone#UpdateEnvironmentBlueprintOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an environment blueprint in Amazon DataZone.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/environment-blueprints/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UpdateEnvironmentBlueprintInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which an environment blueprint is to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "

The identifier of the environment blueprint to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The description to be updated as part of the UpdateEnvironmentBlueprint action.

" + } + }, + "provisioningProperties": { + "target": "com.amazonaws.datazone#ProvisioningProperties", + "traits": { + "smithy.api#documentation": "

The provisioning properties to be updated as part of the UpdateEnvironmentBlueprint action.

" + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#CustomParameterList", + "traits": { + "smithy.api#documentation": "

The user parameters to be updated as part of the UpdateEnvironmentBlueprint action.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#UpdateEnvironmentBlueprintOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintId", + "traits": { + "smithy.api#documentation": "

The identifier of the blueprint to be updated.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#EnvironmentBlueprintName", + "traits": { + "smithy.api#documentation": "

The name to be updated as part of the UpdateEnvironmentBlueprint action.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description to be updated as part of the UpdateEnvironmentBlueprint action.

" + } + }, + "provider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The provider of the blueprint to be udpated.

", + "smithy.api#required": {} + } + }, + "provisioningProperties": { + "target": "com.amazonaws.datazone#ProvisioningProperties", + "traits": { + "smithy.api#documentation": "

The provisioning properties to be updated as part of the UpdateEnvironmentBlueprint action.

", + "smithy.api#required": {} + } + }, + "deploymentProperties": { + "target": "com.amazonaws.datazone#DeploymentProperties", + "traits": { + "smithy.api#documentation": "

The deployment properties to be updated as part of the UpdateEnvironmentBlueprint action.

" + } + }, + "userParameters": { + "target": "com.amazonaws.datazone#CustomParameterList", + "traits": { + "smithy.api#documentation": "

The user parameters to be updated as part of the UpdateEnvironmentBlueprint action.

" + } + }, + "glossaryTerms": { + "target": "com.amazonaws.datazone#GlossaryTerms", + "traits": { + "smithy.api#documentation": "

The glossary terms to be updated as part of the UpdateEnvironmentBlueprint action.

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the environment blueprint was created.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the blueprint was updated.

", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#UpdateEnvironmentInput": { "type": "structure", "members": { @@ -34028,19 +35884,19 @@ "description": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The description to be updated as part of the UpdateEnvironment\n action.

" + "smithy.api#documentation": "

The description to be updated as part of the UpdateEnvironment action.

" } }, "glossaryTerms": { "target": "com.amazonaws.datazone#GlossaryTerms", "traits": { - "smithy.api#documentation": "

The glossary terms to be updated as part of the UpdateEnvironment\n action.

" + "smithy.api#documentation": "

The glossary terms to be updated as part of the UpdateEnvironment action.

" } }, "blueprintVersion": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The blueprint version to which the environment should be updated. You can only specify\n the following string for this parameter: latest.

" + "smithy.api#documentation": "

The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: latest.

" } }, "userParameters": { @@ -34108,7 +35964,7 @@ "description": { "target": "com.amazonaws.datazone#Description", "traits": { - "smithy.api#documentation": "

The description to be updated as part of the UpdateEnvironment\n action.

" + "smithy.api#documentation": "

The description to be updated as part of the UpdateEnvironment action.

" } }, "environmentProfileId": { @@ -34122,7 +35978,7 @@ "awsAccountId": { "target": "com.amazonaws.datazone#AwsAccountId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Web Services account in which the environment is to be\n updated.

" + "smithy.api#documentation": "

The identifier of the Amazon Web Services account in which the environment is to be updated.

" } }, "awsAccountRegion": { @@ -34141,7 +35997,7 @@ "provisionedResources": { "target": "com.amazonaws.datazone#ResourceList", "traits": { - "smithy.api#documentation": "

The provisioned resources to be updated as part of the UpdateEnvironment\n action.

" + "smithy.api#documentation": "

The provisioned resources to be updated as part of the UpdateEnvironment action.

" } }, "status": { @@ -34153,19 +36009,19 @@ "environmentActions": { "target": "com.amazonaws.datazone#EnvironmentActionList", "traits": { - "smithy.api#documentation": "

The environment actions to be updated as part of the UpdateEnvironment\n action.

" + "smithy.api#documentation": "

The environment actions to be updated as part of the UpdateEnvironment action.

" } }, "glossaryTerms": { "target": "com.amazonaws.datazone#GlossaryTerms", "traits": { - "smithy.api#documentation": "

The glossary terms to be updated as part of the UpdateEnvironment\n action.

" + "smithy.api#documentation": "

The glossary terms to be updated as part of the UpdateEnvironment action.

" } }, "userParameters": { "target": "com.amazonaws.datazone#CustomParameterList", "traits": { - "smithy.api#documentation": "

The user parameters to be updated as part of the UpdateEnvironment\n action.

" + "smithy.api#documentation": "

The user parameters to be updated as part of the UpdateEnvironment action.

" } }, "lastDeployment": { @@ -34177,13 +36033,13 @@ "provisioningProperties": { "target": "com.amazonaws.datazone#ProvisioningProperties", "traits": { - "smithy.api#documentation": "

The provisioning properties to be updated as part of the UpdateEnvironment\n action.

" + "smithy.api#documentation": "

The provisioning properties to be updated as part of the UpdateEnvironment action.

" } }, "deploymentProperties": { "target": "com.amazonaws.datazone#DeploymentProperties", "traits": { - "smithy.api#documentation": "

The deployment properties to be updated as part of the UpdateEnvironment\n action.

" + "smithy.api#documentation": "

The deployment properties to be updated as part of the UpdateEnvironment action.

" } }, "environmentBlueprintId": { @@ -34249,7 +36105,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which an environment profile is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which an environment profile is to be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -34265,31 +36121,31 @@ "name": { "target": "com.amazonaws.datazone#EnvironmentProfileName", "traits": { - "smithy.api#documentation": "

The name to be updated as part of the UpdateEnvironmentProfile\n action.

" + "smithy.api#documentation": "

The name to be updated as part of the UpdateEnvironmentProfile action.

" } }, "description": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The description to be updated as part of the UpdateEnvironmentProfile\n action.

" + "smithy.api#documentation": "

The description to be updated as part of the UpdateEnvironmentProfile action.

" } }, "userParameters": { "target": "com.amazonaws.datazone#EnvironmentParametersList", "traits": { - "smithy.api#documentation": "

The user parameters to be updated as part of the UpdateEnvironmentProfile\n action.

" + "smithy.api#documentation": "

The user parameters to be updated as part of the UpdateEnvironmentProfile action.

" } }, "awsAccountId": { "target": "com.amazonaws.datazone#AwsAccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account in which a specified environment profile is to be\n udpated.

" + "smithy.api#documentation": "

The Amazon Web Services account in which a specified environment profile is to be udpated.

" } }, "awsAccountRegion": { "target": "com.amazonaws.datazone#AwsRegion", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region in which a specified environment profile is to be\n updated.

" + "smithy.api#documentation": "

The Amazon Web Services Region in which a specified environment profile is to be updated.

" } } }, @@ -34310,20 +36166,20 @@ "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which the environment profile is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which the environment profile is to be updated.

", "smithy.api#required": {} } }, "awsAccountId": { "target": "com.amazonaws.datazone#AwsAccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account in which a specified environment profile is to be\n udpated.

" + "smithy.api#documentation": "

The Amazon Web Services account in which a specified environment profile is to be udpated.

" } }, "awsAccountRegion": { "target": "com.amazonaws.datazone#AwsRegion", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region in which a specified environment profile is to be\n updated.

" + "smithy.api#documentation": "

The Amazon Web Services Region in which a specified environment profile is to be updated.

" } }, "createdBy": { @@ -34350,14 +36206,14 @@ "name": { "target": "com.amazonaws.datazone#EnvironmentProfileName", "traits": { - "smithy.api#documentation": "

The name to be updated as part of the UpdateEnvironmentProfile\n action.

", + "smithy.api#documentation": "

The name to be updated as part of the UpdateEnvironmentProfile action.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.datazone#Description", "traits": { - "smithy.api#documentation": "

The description to be updated as part of the UpdateEnvironmentProfile\n action.

" + "smithy.api#documentation": "

The description to be updated as part of the UpdateEnvironmentProfile action.

" } }, "environmentBlueprintId": { @@ -34376,7 +36232,7 @@ "userParameters": { "target": "com.amazonaws.datazone#CustomParameterList", "traits": { - "smithy.api#documentation": "

The user parameters to be updated as part of the UpdateEnvironmentProfile\n action.

" + "smithy.api#documentation": "

The user parameters to be updated as part of the UpdateEnvironmentProfile action.

" } } }, @@ -34413,7 +36269,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the business glossary in Amazon DataZone.

", + "smithy.api#documentation": "

Updates the business glossary in Amazon DataZone.

Prerequisites:

  • The glossary must exist in the given domain.

  • The caller must have the datazone:UpdateGlossary permission to update it.

  • When updating the name, the new name must be unique within the domain.

  • The glossary must not be deleted or in a terminal state.

", "smithy.api#http": { "code": 200, "method": "PATCH", @@ -34428,7 +36284,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a business glossary is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a business glossary is to be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -34462,7 +36318,7 @@ "clientToken": { "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } } @@ -34477,7 +36333,7 @@ "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a business glossary is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a business glossary is to be updated.

", "smithy.api#required": {} } }, @@ -34513,6 +36369,12 @@ "traits": { "smithy.api#documentation": "

The status to be updated as part of the UpdateGlossary action.

" } + }, + "usageRestrictions": { + "target": "com.amazonaws.datazone#GlossaryUsageRestrictions", + "traits": { + "smithy.api#documentation": "

The usage restriction of the restricted glossary.

" + } } }, "traits": { @@ -34548,7 +36410,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a business glossary term in Amazon DataZone.

", + "smithy.api#documentation": "

Updates a business glossary term in Amazon DataZone.

Prerequisites:

  • Glossary term must exist in the specified domain.

  • New name must not conflict with existing terms in the same glossary.

  • User must have permissions on the term.

  • The term must not be in DELETED status.

", "smithy.api#http": { "code": 200, "method": "PATCH", @@ -34563,7 +36425,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a business glossary term is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -34591,19 +36453,19 @@ "shortDescription": { "target": "com.amazonaws.datazone#ShortDescription", "traits": { - "smithy.api#documentation": "

The short description to be updated as part of the UpdateGlossaryTerm\n action.

" + "smithy.api#documentation": "

The short description to be updated as part of the UpdateGlossaryTerm action.

" } }, "longDescription": { "target": "com.amazonaws.datazone#LongDescription", "traits": { - "smithy.api#documentation": "

The long description to be updated as part of the UpdateGlossaryTerm\n action.

" + "smithy.api#documentation": "

The long description to be updated as part of the UpdateGlossaryTerm action.

" } }, "termRelations": { "target": "com.amazonaws.datazone#TermRelations", "traits": { - "smithy.api#documentation": "

The term relations to be updated as part of the UpdateGlossaryTerm\n action.

" + "smithy.api#documentation": "

The term relations to be updated as part of the UpdateGlossaryTerm action.

" } }, "status": { @@ -34630,7 +36492,7 @@ "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a business glossary term is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.

", "smithy.api#required": {} } }, @@ -34658,19 +36520,25 @@ "shortDescription": { "target": "com.amazonaws.datazone#ShortDescription", "traits": { - "smithy.api#documentation": "

The short description to be updated as part of the UpdateGlossaryTerm\n action.

" + "smithy.api#documentation": "

The short description to be updated as part of the UpdateGlossaryTerm action.

" } }, "longDescription": { "target": "com.amazonaws.datazone#LongDescription", "traits": { - "smithy.api#documentation": "

The long description to be updated as part of the UpdateGlossaryTerm\n action.

" + "smithy.api#documentation": "

The long description to be updated as part of the UpdateGlossaryTerm action.

" } }, "termRelations": { "target": "com.amazonaws.datazone#TermRelations", "traits": { - "smithy.api#documentation": "

The term relations to be updated as part of the UpdateGlossaryTerm\n action.

" + "smithy.api#documentation": "

The term relations to be updated as part of the UpdateGlossaryTerm action.

" + } + }, + "usageRestrictions": { + "target": "com.amazonaws.datazone#GlossaryUsageRestrictions", + "traits": { + "smithy.api#documentation": "

The usage restriction of a term within a restricted glossary.

" } } }, @@ -34850,7 +36718,7 @@ "glossaryTerms": { "target": "com.amazonaws.datazone#GlossaryTerms", "traits": { - "smithy.api#documentation": "

The glossary terms to be updated as part of the UpdateProject\n action.

" + "smithy.api#documentation": "

The glossary terms to be updated as part of the UpdateProject action.

" } }, "domainUnitId": { @@ -34874,7 +36742,7 @@ "projectProfileVersion": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The project profile version to which the project should be updated. You can only specify\n the following string for this parameter: latest.

" + "smithy.api#documentation": "

The project profile version to which the project should be updated. You can only specify the following string for this parameter: latest.

" } } }, @@ -34921,7 +36789,7 @@ "failureReasons": { "target": "com.amazonaws.datazone#FailureReasons", "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "createdBy": { @@ -35181,7 +37049,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a rule. In Amazon DataZone, a rule is a formal agreement that enforces specific\n requirements across user workflows (e.g., publishing assets to the catalog, requesting\n subscriptions, creating projects) within the Amazon DataZone data portal. These rules help\n maintain consistency, ensure compliance, and uphold governance standards in data management\n processes. For instance, a metadata enforcement rule can specify the required information\n for creating a subscription request or publishing a data asset to the catalog, ensuring\n alignment with organizational standards.

", + "smithy.api#documentation": "

Updates a rule. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

", "smithy.api#http": { "code": 200, "method": "PATCH", @@ -35387,7 +37255,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a subscription grant status is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -35403,7 +37271,7 @@ "assetIdentifier": { "target": "com.amazonaws.datazone#AssetId", "traits": { - "smithy.api#documentation": "

The identifier of the asset the subscription grant status of which is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the asset the subscription grant status of which is to be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -35411,20 +37279,20 @@ "status": { "target": "com.amazonaws.datazone#SubscriptionGrantStatus", "traits": { - "smithy.api#documentation": "

The status to be updated as part of the UpdateSubscriptionGrantStatus\n action.

", + "smithy.api#documentation": "

The status to be updated as part of the UpdateSubscriptionGrantStatus action.

", "smithy.api#required": {} } }, "failureCause": { "target": "com.amazonaws.datazone#FailureCause", "traits": { - "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully\n completed.

" + "smithy.api#documentation": "

Specifies the error message that is returned if the operation cannot be successfully completed.

" } }, "targetName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The target name to be updated as part of the UpdateSubscriptionGrantStatus\n action.

" + "smithy.api#documentation": "

The target name to be updated as part of the UpdateSubscriptionGrantStatus action.

" } } }, @@ -35458,7 +37326,7 @@ "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a subscription grant status is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.

", "smithy.api#required": {} } }, @@ -35479,21 +37347,21 @@ "subscriptionTargetId": { "target": "com.amazonaws.datazone#SubscriptionTargetId", "traits": { - "smithy.api#documentation": "

The identifier of the subscription target whose subscription grant status is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the subscription target whose subscription grant status is to be updated.

", "smithy.api#required": {} } }, "grantedEntity": { "target": "com.amazonaws.datazone#GrantedEntity", "traits": { - "smithy.api#documentation": "

The granted entity to be updated as part of the\n UpdateSubscriptionGrantStatus action.

", + "smithy.api#documentation": "

The granted entity to be updated as part of the UpdateSubscriptionGrantStatus action.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.datazone#SubscriptionGrantOverallStatus", "traits": { - "smithy.api#documentation": "

The status to be updated as part of the UpdateSubscriptionGrantStatus\n action.

", + "smithy.api#documentation": "

The status to be updated as part of the UpdateSubscriptionGrantStatus action.

", "smithy.api#required": {} } }, @@ -35561,7 +37429,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a subscription request is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a subscription request is to be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -35612,7 +37480,7 @@ "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a subscription request is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a subscription request is to be updated.

", "smithy.api#required": {} } }, @@ -35739,7 +37607,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a subscription target is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a subscription target is to be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -35747,7 +37615,7 @@ "environmentIdentifier": { "target": "com.amazonaws.datazone#EnvironmentId", "traits": { - "smithy.api#documentation": "

The identifier of the environment in which a subscription target is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the environment in which a subscription target is to be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -35763,37 +37631,37 @@ "name": { "target": "com.amazonaws.datazone#SubscriptionTargetName", "traits": { - "smithy.api#documentation": "

The name to be updated as part of the UpdateSubscriptionTarget\n action.

" + "smithy.api#documentation": "

The name to be updated as part of the UpdateSubscriptionTarget action.

" } }, "authorizedPrincipals": { "target": "com.amazonaws.datazone#AuthorizedPrincipalIdentifiers", "traits": { - "smithy.api#documentation": "

The authorized principals to be updated as part of the\n UpdateSubscriptionTarget action.

" + "smithy.api#documentation": "

The authorized principals to be updated as part of the UpdateSubscriptionTarget action.

" } }, "applicableAssetTypes": { "target": "com.amazonaws.datazone#ApplicableAssetTypes", "traits": { - "smithy.api#documentation": "

The applicable asset types to be updated as part of the\n UpdateSubscriptionTarget action.

" + "smithy.api#documentation": "

The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.

" } }, "subscriptionTargetConfig": { "target": "com.amazonaws.datazone#SubscriptionTargetForms", "traits": { - "smithy.api#documentation": "

The configuration to be updated as part of the UpdateSubscriptionTarget\n action.

" + "smithy.api#documentation": "

The configuration to be updated as part of the UpdateSubscriptionTarget action.

" } }, "manageAccessRole": { "target": "com.amazonaws.datazone#IamRoleArn", "traits": { - "smithy.api#documentation": "

The manage access role to be updated as part of the\n UpdateSubscriptionTarget action.

" + "smithy.api#documentation": "

The manage access role to be updated as part of the UpdateSubscriptionTarget action.

" } }, "provider": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The provider to be updated as part of the UpdateSubscriptionTarget\n action.

" + "smithy.api#documentation": "

The provider to be updated as part of the UpdateSubscriptionTarget action.

" } } }, @@ -35814,14 +37682,14 @@ "authorizedPrincipals": { "target": "com.amazonaws.datazone#AuthorizedPrincipalIdentifiers", "traits": { - "smithy.api#documentation": "

The authorized principals to be updated as part of the\n UpdateSubscriptionTarget action. Updates are supported in batches of 5 at a\n time.

", + "smithy.api#documentation": "

The authorized principals to be updated as part of the UpdateSubscriptionTarget action. Updates are supported in batches of 5 at a time.

", "smithy.api#required": {} } }, "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a subscription target is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the Amazon DataZone domain in which a subscription target is to be updated.

", "smithy.api#required": {} } }, @@ -35835,21 +37703,21 @@ "environmentId": { "target": "com.amazonaws.datazone#EnvironmentId", "traits": { - "smithy.api#documentation": "

The identifier of the environment in which a subscription target is to be\n updated.

", + "smithy.api#documentation": "

The identifier of the environment in which a subscription target is to be updated.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.datazone#SubscriptionTargetName", "traits": { - "smithy.api#documentation": "

The name to be updated as part of the UpdateSubscriptionTarget\n action.

", + "smithy.api#documentation": "

The name to be updated as part of the UpdateSubscriptionTarget action.

", "smithy.api#required": {} } }, "type": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The type to be updated as part of the UpdateSubscriptionTarget\n action.

", + "smithy.api#documentation": "

The type to be updated as part of the UpdateSubscriptionTarget action.

", "smithy.api#required": {} } }, @@ -35882,27 +37750,27 @@ "manageAccessRole": { "target": "com.amazonaws.datazone#IamRoleArn", "traits": { - "smithy.api#documentation": "

The manage access role to be updated as part of the\n UpdateSubscriptionTarget action.

" + "smithy.api#documentation": "

The manage access role to be updated as part of the UpdateSubscriptionTarget action.

" } }, "applicableAssetTypes": { "target": "com.amazonaws.datazone#ApplicableAssetTypes", "traits": { - "smithy.api#documentation": "

The applicable asset types to be updated as part of the\n UpdateSubscriptionTarget action.

", + "smithy.api#documentation": "

The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.

", "smithy.api#required": {} } }, "subscriptionTargetConfig": { "target": "com.amazonaws.datazone#SubscriptionTargetForms", "traits": { - "smithy.api#documentation": "

The configuration to be updated as part of the UpdateSubscriptionTarget\n action.

", + "smithy.api#documentation": "

The configuration to be updated as part of the UpdateSubscriptionTarget action.

", "smithy.api#required": {} } }, "provider": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The provider to be updated as part of the UpdateSubscriptionTarget\n action.

", + "smithy.api#documentation": "

The provider to be updated as part of the UpdateSubscriptionTarget action.

", "smithy.api#required": {} } } @@ -36034,7 +37902,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the domain unit(s) whose projects can use this asset type while creating asset\n or asset revisions.

" + "smithy.api#documentation": "

Specifies the domain unit(s) whose projects can use this asset type while creating asset or asset revisions.

" } }, "com.amazonaws.datazone#UserAssignment": { diff --git a/codegen/sdk/aws-models/dax.json b/codegen/sdk/aws-models/dax.json index 658c3c4e37e..3c35b149814 100644 --- a/codegen/sdk/aws-models/dax.json +++ b/codegen/sdk/aws-models/dax.json @@ -109,7 +109,7 @@ "name": "dax" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

DAX is a managed caching service engineered for Amazon DynamoDB. DAX\n dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so\n applications can access that data with sub-millisecond latency. You can create a DAX\n cluster easily, using the AWS Management Console. With a few simple modifications to\n your code, your application can begin taking advantage of the DAX cluster and realize\n significant improvements in read performance.

", + "smithy.api#documentation": "

DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching\n frequently-accessed data from DynamoDB, so applications can access that data\n with sub-millisecond latency. You can create a DAX cluster easily, using\n the Amazon Web Services Management Console. With a few simple modifications to your code, your\n application can begin taking advantage of the DAX cluster and realize\n significant improvements in read performance.

", "smithy.api#title": "Amazon DynamoDB Accelerator (DAX)", "smithy.api#xmlNamespace": { "uri": "http://dax.amazonaws.com/doc/2017-04-19/" @@ -755,17 +755,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -779,17 +768,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -803,17 +781,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -827,17 +794,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -957,7 +913,7 @@ "ClusterArn": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

" } }, "TotalNodes": { @@ -975,7 +931,7 @@ "NodeType": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of\n the same type.)

" + "smithy.api#documentation": "

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the\n same type.)

" } }, "Status": { @@ -987,7 +943,7 @@ "ClusterDiscoveryEndpoint": { "target": "com.amazonaws.dax#Endpoint", "traits": { - "smithy.api#documentation": "

The endpoint for this DAX cluster, consisting of a DNS name, a port number,\n and a URL. Applications should use the URL to configure the DAX client to find\n their cluster.

" + "smithy.api#documentation": "

The endpoint for this DAX cluster, consisting of a DNS name, a port\n number, and a URL. Applications should use the URL to configure the DAX\n client to find their cluster.

" } }, "NodeIdsToRemove": { @@ -1023,13 +979,13 @@ "SecurityGroups": { "target": "com.amazonaws.dax#SecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "

A list of security groups, and the status of each, for the nodes in the cluster.

" + "smithy.api#documentation": "

A list of security groups, and the status of each, for the nodes in the\n cluster.

" } }, "IamRoleArn": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX\n will assume this role and use the role's permissions to access DynamoDB on your\n behalf.

" + "smithy.api#documentation": "

A valid Amazon Resource Name (ARN) that identifies an IAM role. At\n runtime, DAX will assume this role and use the role's permissions to\n access DynamoDB on your behalf.

" } }, "ParameterGroup": { @@ -1047,7 +1003,13 @@ "ClusterEndpointEncryptionType": { "target": "com.amazonaws.dax#ClusterEndpointEncryptionType", "traits": { - "smithy.api#documentation": "

The type of encryption supported by the cluster's endpoint. Values are:

\n
    \n
  • \n

    \n NONE for no encryption

    \n

    \n TLS for Transport Layer Security

    \n
  • \n
" + "smithy.api#documentation": "

The type of encryption supported by the cluster's endpoint. Values are:

\n
    \n
  • \n

    \n NONE for no encryption

    \n

    \n TLS for Transport Layer Security

    \n
  • \n
" + } + }, + "NetworkType": { + "target": "com.amazonaws.dax#NetworkType", + "traits": { + "smithy.api#documentation": "

The IP address type of the cluster. Values are:

\n
    \n
  • \n

    \n ipv4 - IPv4 addresses only

    \n
  • \n
  • \n

    \n ipv6 - IPv6 addresses only

    \n
  • \n
  • \n

    \n dual_stack - Both IPv4 and IPv6 addresses

    \n
  • \n
" } } }, @@ -1113,7 +1075,7 @@ "code": "ClusterNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "

The requested cluster ID does not refer to an existing DAX cluster.

", + "smithy.api#documentation": "

The requested cluster ID does not refer to an existing DAX\n cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1130,7 +1092,7 @@ "code": "ClusterQuotaForCustomerExceeded", "httpResponseCode": 400 }, - "smithy.api#documentation": "

You have attempted to exceed the maximum number of DAX clusters for your AWS\n account.

", + "smithy.api#documentation": "

You have attempted to exceed the maximum number of DAX clusters for\n your Amazon Web Services account.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1200,7 +1162,7 @@ "ClusterName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The cluster identifier. This parameter is stored as a lowercase\n string.

\n

\n Constraints:\n

\n
    \n
  • \n

    A name must contain from 1 to 20 alphanumeric characters or\n hyphens.

    \n
  • \n
  • \n

    The first character must be a letter.

    \n
  • \n
  • \n

    A name cannot end with a hyphen or contain two consecutive\n hyphens.

    \n
  • \n
", + "smithy.api#documentation": "

The cluster identifier. This parameter is stored as a lowercase string.

\n

\n Constraints:\n

\n
    \n
  • \n

    A name must contain from 1 to 20 alphanumeric characters or\n hyphens.

    \n
  • \n
  • \n

    The first character must be a letter.

    \n
  • \n
  • \n

    A name cannot end with a hyphen or contain two consecutive\n hyphens.

    \n
  • \n
", "smithy.api#required": {} } }, @@ -1221,44 +1183,44 @@ "target": "com.amazonaws.dax#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The number of nodes in the DAX cluster. A replication factor of 1 will\n create a single-node cluster, without any read replicas. For additional fault tolerance,\n you can create a multiple node cluster with one or more read replicas. To do this, set\n ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). \n If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

\n \n

AWS recommends that you have at least two read replicas per cluster.

\n
", + "smithy.api#documentation": "

The number of nodes in the DAX cluster. A replication factor of 1\n will create a single-node cluster, without any read replicas. For additional fault\n tolerance, you can create a multiple node cluster with one or more read replicas. To do\n this, set ReplicationFactor to a number between 3 (one primary and two read\n replicas) and 10 (one primary and nine read replicas). If the\n AvailabilityZones parameter is provided, its length must equal the\n ReplicationFactor.

\n \n

Amazon Web Services recommends that you have at least two read replicas per\n cluster.

\n
", "smithy.api#required": {} } }, "AvailabilityZones": { "target": "com.amazonaws.dax#AvailabilityZoneList", "traits": { - "smithy.api#documentation": "

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster\n has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter.\n If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

" + "smithy.api#documentation": "

The Availability Zones (AZs) in which the cluster nodes will reside after the\n cluster has been created or updated. If provided, the length of this list must equal the\n ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest\n availability.

" } }, "SubnetGroupName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The name of the subnet group to be used for the replication group.

\n \n

DAX clusters can only run in an Amazon VPC environment. All of the subnets\n that you specify in a subnet group must exist in the same VPC.

\n
" + "smithy.api#documentation": "

The name of the subnet group to be used for the replication group.

\n \n

DAX clusters can only run in an Amazon VPC environment.\n All of the subnets that you specify in a subnet group must exist in the same\n VPC.

\n
" } }, "SecurityGroupIds": { "target": "com.amazonaws.dax#SecurityGroupIdentifierList", "traits": { - "smithy.api#documentation": "

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the \n security group ID is system-generated.)

\n

If this parameter is not specified, DAX assigns the default VPC security group to\n each node.

" + "smithy.api#documentation": "

A list of security group IDs to be assigned to each node in the DAX\n cluster. (Each of the security group ID is system-generated.)

\n

If this parameter is not specified, DAX assigns the default VPC\n security group to each node.

" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

Specifies the weekly time range during which maintenance on the DAX cluster is\n performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock\n UTC). The minimum maintenance window is a 60 minute period. Valid values for\n ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
  • \n
  • \n

    \n mon\n

    \n
  • \n
  • \n

    \n tue\n

    \n
  • \n
  • \n

    \n wed\n

    \n
  • \n
  • \n

    \n thu\n

    \n
  • \n
  • \n

    \n fri\n

    \n
  • \n
  • \n

    \n sat\n

    \n
  • \n
\n

Example: sun:05:00-sun:09:00\n

\n \n

If you don't specify a preferred maintenance window when you create or modify a\n cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day\n of the week.

\n
" + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance on the DAX cluster is\n performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock\n UTC). The minimum maintenance window is a 60 minute period. Valid values for\n ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
  • \n
  • \n

    \n mon\n

    \n
  • \n
  • \n

    \n tue\n

    \n
  • \n
  • \n

    \n wed\n

    \n
  • \n
  • \n

    \n thu\n

    \n
  • \n
  • \n

    \n fri\n

    \n
  • \n
  • \n

    \n sat\n

    \n
  • \n
\n

Example: sun:05:00-sun:09:00\n

\n \n

If you don't specify a preferred maintenance window when you create or modify a\n cache cluster, DAX assigns a 60-minute maintenance window on a\n randomly selected day of the week.

\n
" } }, "NotificationTopicArn": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will\n be sent.

\n \n

The Amazon SNS topic owner must be same as the DAX cluster owner.

\n
" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to which\n notifications will be sent.

\n \n

The Amazon SNS topic owner must be same as the DAX\n cluster owner.

\n
" } }, "IamRoleArn": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX\n will assume this role and use the role's permissions to access DynamoDB on your\n behalf.

", + "smithy.api#documentation": "

A valid Amazon Resource Name (ARN) that identifies an IAM role. At\n runtime, DAX will assume this role and use the role's permissions to\n access DynamoDB on your behalf.

", "smithy.api#required": {} } }, @@ -1271,19 +1233,25 @@ "Tags": { "target": "com.amazonaws.dax#TagList", "traits": { - "smithy.api#documentation": "

A set of tags to associate with the DAX cluster.

" + "smithy.api#documentation": "

A set of tags to associate with the DAX cluster.\n

" } }, "SSESpecification": { "target": "com.amazonaws.dax#SSESpecification", "traits": { - "smithy.api#documentation": "

Represents the settings used to enable server-side encryption on the cluster.

" + "smithy.api#documentation": "

Represents the settings used to enable server-side encryption on the\n cluster.

" } }, "ClusterEndpointEncryptionType": { "target": "com.amazonaws.dax#ClusterEndpointEncryptionType", "traits": { - "smithy.api#documentation": "

The type of encryption the cluster's endpoint should support. Values are:

\n
    \n
  • \n

    \n NONE for no encryption

    \n
  • \n
  • \n

    \n TLS for Transport Layer Security

    \n
  • \n
" + "smithy.api#documentation": "

The type of encryption the cluster's endpoint should support. Values are:

\n
    \n
  • \n

    \n NONE for no encryption

    \n
  • \n
  • \n

    \n TLS for Transport Layer Security

    \n
  • \n
" + } + }, + "NetworkType": { + "target": "com.amazonaws.dax#NetworkType", + "traits": { + "smithy.api#documentation": "

Specifies the IP protocol(s) the cluster uses for network communications. Values\n are:

\n
    \n
  • \n

    \n ipv4 - The cluster is accessible only through IPv4\n addresses

    \n
  • \n
  • \n

    \n ipv6 - The cluster is accessible only through IPv6\n addresses

    \n
  • \n
  • \n

    \n dual_stack - The cluster is accessible through both IPv4 and\n IPv6 addresses.

    \n
  • \n
\n \n

If no explicit NetworkType is provided, the network type is\n derived based on the subnet group's configuration.

\n
" } } }, @@ -1393,6 +1361,9 @@ { "target": "com.amazonaws.dax#SubnetGroupQuotaExceededFault" }, + { + "target": "com.amazonaws.dax#SubnetNotAllowedFault" + }, { "target": "com.amazonaws.dax#SubnetQuotaExceededFault" } @@ -1472,7 +1443,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes one or more nodes from a DAX cluster.

\n \n

You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead.

\n
" + "smithy.api#documentation": "

Removes one or more nodes from a DAX cluster.

\n \n

You cannot use DecreaseReplicationFactor to remove the last node\n in a DAX cluster. If you need to do this, use\n DeleteCluster instead.

\n
" } }, "com.amazonaws.dax#DecreaseReplicationFactorRequest": { @@ -1481,7 +1452,7 @@ "ClusterName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The name of the DAX cluster from which you want to remove nodes.

", + "smithy.api#documentation": "

The name of the DAX cluster from which you want to remove\n nodes.

", "smithy.api#required": {} } }, @@ -1516,7 +1487,7 @@ "Cluster": { "target": "com.amazonaws.dax#Cluster", "traits": { - "smithy.api#documentation": "

A description of the DAX cluster, after you have decreased its replication\n factor.

" + "smithy.api#documentation": "

A description of the DAX cluster, after you have decreased its\n replication factor.

" } } }, @@ -1550,7 +1521,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a previously provisioned DAX cluster.\n DeleteCluster deletes all associated nodes, node endpoints\n and the DAX cluster itself. When you receive a successful response from this action,\n DAX immediately begins deleting the cluster; you cannot cancel or revert this\n action.

" + "smithy.api#documentation": "

Deletes a previously provisioned DAX cluster.\n DeleteCluster deletes all associated nodes, node endpoints and\n the DAX cluster itself. When you receive a successful response from this\n action, DAX immediately begins deleting the cluster; you cannot cancel or\n revert this action.

" } }, "com.amazonaws.dax#DeleteClusterRequest": { @@ -1660,7 +1631,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a subnet group.

\n \n

You cannot delete a subnet group if it is associated with any DAX\n clusters.

\n
" + "smithy.api#documentation": "

Deletes a subnet group.

\n \n

You cannot delete a subnet group if it is associated with any DAX\n clusters.

\n
" } }, "com.amazonaws.dax#DeleteSubnetGroupRequest": { @@ -1715,7 +1686,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about all provisioned DAX clusters if no cluster identifier\n is specified, or about a specific DAX cluster if a cluster identifier is\n supplied.

\n

If the cluster is in the CREATING state, only cluster level information will be\n displayed until all of the nodes are successfully provisioned.

\n

If the cluster is in the DELETING state, only cluster level information will be\n displayed.

\n

If nodes are currently being added to the DAX cluster, node endpoint information\n and creation time for the additional nodes will not be displayed until they are\n completely provisioned. When the DAX cluster state is available,\n the cluster is ready for use.

\n

If nodes are currently being removed from the DAX cluster, no endpoint\n information for the removed nodes is displayed.

" + "smithy.api#documentation": "

Returns information about all provisioned DAX clusters if no cluster identifier is\n specified, or about a specific DAX cluster if a cluster identifier is\n supplied.

\n

If the cluster is in the CREATING state, only cluster level information will be\n displayed until all of the nodes are successfully provisioned.

\n

If the cluster is in the DELETING state, only cluster level information will be\n displayed.

\n

If nodes are currently being added to the DAX cluster, node endpoint information\n and creation time for the additional nodes will not be displayed until they are\n completely provisioned. When the DAX cluster state is\n available, the cluster is ready for use.

\n

If nodes are currently being removed from the DAX cluster, no\n endpoint information for the removed nodes is displayed.

" } }, "com.amazonaws.dax#DescribeClustersRequest": { @@ -1730,7 +1701,7 @@ "MaxResults": { "target": "com.amazonaws.dax#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" } }, "NextToken": { @@ -1756,7 +1727,7 @@ "Clusters": { "target": "com.amazonaws.dax#ClusterList", "traits": { - "smithy.api#documentation": "

The descriptions of your DAX clusters, in response to a\n DescribeClusters request.

" + "smithy.api#documentation": "

The descriptions of your DAX clusters, in response to a\n DescribeClusters request.

" } } }, @@ -1793,7 +1764,7 @@ "MaxResults": { "target": "com.amazonaws.dax#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" } }, "NextToken": { @@ -1819,7 +1790,7 @@ "Parameters": { "target": "com.amazonaws.dax#ParameterList", "traits": { - "smithy.api#documentation": "

A list of parameters. Each element in the list represents one parameter.

" + "smithy.api#documentation": "

A list of parameters. Each element in the list represents one parameter.

" } } }, @@ -1847,7 +1818,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns events related to DAX clusters and parameter groups. You can obtain\n events specific to a particular DAX cluster or parameter group by providing the name\n as a parameter.

\n

By default, only the events occurring within the last 24 hours are returned; however,\n you can retrieve up to 14 days' worth of events if necessary.

" + "smithy.api#documentation": "

Returns events related to DAX clusters and parameter groups. You can\n obtain events specific to a particular DAX cluster or parameter group by\n providing the name as a parameter.

\n

By default, only the events occurring within the last 24 hours are returned;\n however, you can retrieve up to 14 days' worth of events if necessary.

" } }, "com.amazonaws.dax#DescribeEventsRequest": { @@ -1886,7 +1857,7 @@ "MaxResults": { "target": "com.amazonaws.dax#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" } }, "NextToken": { @@ -1912,7 +1883,7 @@ "Events": { "target": "com.amazonaws.dax#EventList", "traits": { - "smithy.api#documentation": "

An array of events. Each element in the array represents one event.

" + "smithy.api#documentation": "

An array of events. Each element in the array represents one event.

" } } }, @@ -1958,7 +1929,7 @@ "MaxResults": { "target": "com.amazonaws.dax#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" } }, "NextToken": { @@ -1984,7 +1955,7 @@ "ParameterGroups": { "target": "com.amazonaws.dax#ParameterGroupList", "traits": { - "smithy.api#documentation": "

An array of parameter groups. Each element in the array represents one parameter group.

" + "smithy.api#documentation": "

An array of parameter groups. Each element in the array represents one parameter\n group.

" } } }, @@ -2037,7 +2008,7 @@ "MaxResults": { "target": "com.amazonaws.dax#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" } }, "NextToken": { @@ -2063,7 +2034,7 @@ "Parameters": { "target": "com.amazonaws.dax#ParameterList", "traits": { - "smithy.api#documentation": "

A list of parameters within a parameter group. Each element in the list represents one parameter.

" + "smithy.api#documentation": "

A list of parameters within a parameter group. Each element in the list represents\n one parameter.

" } } }, @@ -2103,7 +2074,7 @@ "MaxResults": { "target": "com.amazonaws.dax#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" + "smithy.api#documentation": "

The maximum number of results to include in the response. If more results exist\n than the specified MaxResults value, a token is included in the response so\n that the remaining results can be retrieved.

\n

The value for MaxResults must be between 20 and 100.

" } }, "NextToken": { @@ -2129,7 +2100,7 @@ "SubnetGroups": { "target": "com.amazonaws.dax#SubnetGroupList", "traits": { - "smithy.api#documentation": "

An array of subnet groups. Each element in the array represents a single subnet group.

" + "smithy.api#documentation": "

An array of subnet groups. Each element in the array represents a single subnet\n group.

" } } }, @@ -2156,12 +2127,12 @@ "URL": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The URL that applications should use to connect to the endpoint. The default\n ports are 8111 for the \"dax\" protocol and 9111 for the \"daxs\" protocol.

" + "smithy.api#documentation": "

The URL that applications should use to connect to the endpoint. The default ports\n are 8111 for the \"dax\" protocol and 9111 for the \"daxs\" protocol.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the information required for client programs to connect to the\n endpoint for a DAX cluster.

" + "smithy.api#documentation": "

Represents the information required for client programs to connect to the endpoint\n for a DAX cluster.

" } }, "com.amazonaws.dax#Event": { @@ -2193,7 +2164,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a single occurrence of something interesting within the system. Some\n examples of events are creating a DAX cluster, adding or removing a node, or rebooting\n a node.

" + "smithy.api#documentation": "

Represents a single occurrence of something interesting within the system. Some\n examples of events are creating a DAX cluster, adding or removing a node, or rebooting a\n node.

" } }, "com.amazonaws.dax#EventList": { @@ -2267,7 +2238,7 @@ "AvailabilityZones": { "target": "com.amazonaws.dax#AvailabilityZoneList", "traits": { - "smithy.api#documentation": "

The Availability Zones (AZs) in which the cluster nodes will be created. All nodes\n belonging to the cluster are placed in these Availability Zones. Use this parameter if you want\n to distribute the nodes across multiple AZs.

" + "smithy.api#documentation": "

The Availability Zones (AZs) in which the cluster nodes will be created. All nodes\n belonging to the cluster are placed in these Availability Zones. Use this parameter if\n you want to distribute the nodes across multiple AZs.

" } } }, @@ -2281,7 +2252,7 @@ "Cluster": { "target": "com.amazonaws.dax#Cluster", "traits": { - "smithy.api#documentation": "

A description of the DAX cluster. with its new replication factor.

" + "smithy.api#documentation": "

A description of the DAX cluster, with its new replication\n factor.

" } } }, @@ -2344,7 +2315,7 @@ "code": "InvalidClusterState", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The requested DAX cluster is not in the available\n state.

", + "smithy.api#documentation": "

The requested DAX cluster is not in the\n available state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2492,7 +2463,7 @@ } ], "traits": { - "smithy.api#documentation": "

List all of the tags for a DAX cluster. You can call ListTags up to\n 10 times per second, per account.

" + "smithy.api#documentation": "

List all of the tags for a DAX cluster. You can call\n ListTags up to 10 times per second, per account.

" } }, "com.amazonaws.dax#ListTagsRequest": { @@ -2528,7 +2499,7 @@ "NextToken": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

If this value is present, there are additional results to be displayed. To retrieve them, call \n ListTags again, with NextToken set to this value.

" + "smithy.api#documentation": "

If this value is present, there are additional results to be displayed. To retrieve\n them, call ListTags again, with NextToken set to this\n value.

" } } }, @@ -2536,6 +2507,35 @@ "smithy.api#output": {} } }, + "com.amazonaws.dax#NetworkType": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + }, + "DUAL_STACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dual_stack" + } + } + } + }, + "com.amazonaws.dax#NetworkTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.dax#NetworkType" + } + }, "com.amazonaws.dax#Node": { "type": "structure", "members": { @@ -2548,7 +2548,7 @@ "Endpoint": { "target": "com.amazonaws.dax#Endpoint", "traits": { - "smithy.api#documentation": "

The endpoint for the node, consisting of a DNS name and a port number. Client\n applications can connect directly to a node endpoint, if desired (as an alternative to\n allowing DAX client software to intelligently route requests and responses to nodes in\n the DAX cluster.

" + "smithy.api#documentation": "

The endpoint for the node, consisting of a DNS name and a port number. Client\n applications can connect directly to a node endpoint, if desired (as an alternative to\n allowing DAX client software to intelligently route requests and\n responses to nodes in the DAX cluster.

" } }, "NodeCreateTime": { @@ -2638,7 +2638,7 @@ "code": "NodeQuotaForCustomerExceeded", "httpResponseCode": 400 }, - "smithy.api#documentation": "

You have attempted to exceed the maximum number of nodes for your AWS\n account.

", + "smithy.api#documentation": "

You have attempted to exceed the maximum number of nodes for your Amazon Web Services account.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2675,13 +2675,13 @@ "TopicArn": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the topic.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the topic.

" } }, "TopicStatus": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The current state of the topic. A value of “active” means that notifications will\n be sent to the topic. A value of “inactive” means that notifications will not be sent to the\n topic.

" + "smithy.api#documentation": "

The current state of the topic. A value of “active” means that notifications will\n be sent to the topic. A value of “inactive” means that notifications will not be sent to\n the topic.

" } } }, @@ -2774,7 +2774,7 @@ } }, "traits": { - "smithy.api#documentation": "

A named set of parameters that are applied to all of the nodes in a DAX\n cluster.

" + "smithy.api#documentation": "

A named set of parameters that are applied to all of the nodes in a DAX cluster.

" } }, "com.amazonaws.dax#ParameterGroupAlreadyExistsFault": { @@ -2944,7 +2944,7 @@ } ], "traits": { - "smithy.api#documentation": "

Reboots a single node of a DAX cluster. The reboot action takes place\n as soon as possible. During the\n reboot, the node status is set to REBOOTING.

\n \n

\n RebootNode restarts the DAX engine process and does not remove the contents of the cache.

\n
" + "smithy.api#documentation": "

Reboots a single node of a DAX cluster. The reboot action takes\n place as soon as possible. During the reboot, the node status is set to\n REBOOTING.

\n \n

\n RebootNode restarts the DAX engine process and does not remove the\n contents of the cache.

\n
" } }, "com.amazonaws.dax#RebootNodeRequest": { @@ -2953,7 +2953,7 @@ "ClusterName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The name of the DAX cluster containing the node to be rebooted.

", + "smithy.api#documentation": "

The name of the DAX cluster containing the node to be\n rebooted.

", "smithy.api#required": {} } }, @@ -2975,7 +2975,7 @@ "Cluster": { "target": "com.amazonaws.dax#Cluster", "traits": { - "smithy.api#documentation": "

A description of the DAX cluster after a node has been rebooted.

" + "smithy.api#documentation": "

A description of the DAX cluster after a node has been\n rebooted.

" } } }, @@ -2994,7 +2994,7 @@ } }, "traits": { - "smithy.api#documentation": "

The description of the server-side encryption status on the specified DAX cluster.

" + "smithy.api#documentation": "

The description of the server-side encryption status on the specified DAX\n cluster.

" } }, "com.amazonaws.dax#SSEEnabled": { @@ -3006,7 +3006,7 @@ "Enabled": { "target": "com.amazonaws.dax#SSEEnabled", "traits": { - "smithy.api#documentation": "

Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.

", + "smithy.api#documentation": "

Indicates whether server-side encryption is enabled (true) or disabled (false) on\n the cluster.

", "smithy.api#required": {} } } @@ -3101,7 +3101,7 @@ "code": "ServiceQuotaExceeded", "httpResponseCode": 402 }, - "smithy.api#documentation": "

You have reached the maximum number of x509 certificates that can be created for\n encrypted clusters in a 30 day period. Contact AWS customer support to discuss options\n for continuing to create encrypted clusters.

", + "smithy.api#documentation": "

You have reached the maximum number of x509 certificates that can be created for\n encrypted clusters in a 30 day period. Contact Amazon Web Services customer support to\n discuss options for continuing to create encrypted clusters.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -3146,10 +3146,16 @@ "traits": { "smithy.api#documentation": "

The Availability Zone (AZ) for the subnet.

" } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.dax#NetworkTypeList", + "traits": { + "smithy.api#documentation": "

The network types supported by this subnet. Returns an array of strings that can\n include ipv4, ipv6, or both, indicating whether the subnet\n supports IPv4 only, IPv6 only, or dual-stack deployments.

" + } } }, "traits": { - "smithy.api#documentation": "

Represents the subnet associated with a DAX cluster. This parameter refers to\n subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with\n DAX.

" + "smithy.api#documentation": "

Represents the subnet associated with a DAX cluster. This parameter\n refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with\n DAX.

" } }, "com.amazonaws.dax#SubnetGroup": { @@ -3178,10 +3184,16 @@ "traits": { "smithy.api#documentation": "

A list of subnets associated with the subnet group.

" } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.dax#NetworkTypeList", + "traits": { + "smithy.api#documentation": "

The network types supported by this subnet. Returns an array of strings that can\n include ipv4, ipv6, or both, indicating whether the subnet\n group supports IPv4 only, IPv6 only, or dual-stack deployments.

" + } } }, "traits": { - "smithy.api#documentation": "

Represents the output of one of the following actions:

\n
    \n
  • \n

    \n CreateSubnetGroup\n

    \n
  • \n
  • \n

    \n ModifySubnetGroup\n

    \n
  • \n
" + "smithy.api#documentation": "

Represents the output of one of the following actions:

\n
    \n
  • \n

    \n CreateSubnetGroup\n

    \n
  • \n
  • \n

    \n ModifySubnetGroup\n

    \n
  • \n
" } }, "com.amazonaws.dax#SubnetGroupAlreadyExistsFault": { @@ -3293,6 +3305,23 @@ "target": "com.amazonaws.dax#Subnet" } }, + "com.amazonaws.dax#SubnetNotAllowedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dax#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetNotAllowedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified subnet can't be used for the requested network type. This error\n occurs when either there aren't enough subnets of the required network type to create\n the cluster, or when you try to use a subnet that doesn't support the requested network\n type (for example, trying to create a dual-stack cluster with a subnet that doesn't have\n IPv6 CIDR).

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.dax#SubnetQuotaExceededFault": { "type": "structure", "members": { @@ -3319,18 +3348,18 @@ "Key": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have\n one tag with the same key. If you try to add an existing tag (same key), the\n existing tag value will be updated to the new value.

" + "smithy.api#documentation": "

The key for the tag. Tag keys are case sensitive. Every DAX cluster\n can only have one tag with the same key. If you try to add an existing tag (same key),\n the existing tag value will be updated to the new value.

" } }, "Value": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The value of the tag. Tag values are case-sensitive and can be null.

" + "smithy.api#documentation": "

The value of the tag. Tag values are case-sensitive and can be null.

" } } }, "traits": { - "smithy.api#documentation": "

A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single\n DAX cluster.

\n

AWS-assigned tag names and values are automatically assigned the aws:\n prefix, which the user cannot assign. AWS-assigned tag names do not count towards the\n tag limit of 50. User-assigned tag names have the prefix user:.

\n

You cannot backdate the application of a tag.

" + "smithy.api#documentation": "

A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to\n a single DAX cluster.

\n

Amazon Web Services-assigned tag names and values are automatically assigned the\n aws: prefix, which the user cannot assign. Amazon Web Services-assigned\n tag names do not count towards the tag limit of 50. User-assigned tag names have the\n prefix user:.

\n

You cannot backdate the application of a tag.

" } }, "com.amazonaws.dax#TagList": { @@ -3405,7 +3434,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per\n account.

" + "smithy.api#documentation": "

Associates a set of tags with a DAX resource.\n You can call TagResource up to\n 5 times per second, per account.

" } }, "com.amazonaws.dax#TagResourceRequest": { @@ -3414,7 +3443,7 @@ "ResourceName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The name of the DAX resource to which tags should be added.

", + "smithy.api#documentation": "

The name of the DAX resource to which tags should be\n added.

", "smithy.api#required": {} } }, @@ -3476,7 +3505,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the association of tags from a DAX resource. You can call\n UntagResource up to 5 times per second, per account.

" + "smithy.api#documentation": "

Removes the association of tags from a DAX resource. You can call\n UntagResource up to 5 times per second, per account.

" } }, "com.amazonaws.dax#UntagResourceRequest": { @@ -3485,14 +3514,14 @@ "ResourceName": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The name of the DAX resource from which the tags should be removed.

", + "smithy.api#documentation": "

The name of the DAX resource from which the tags should be\n removed.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.dax#KeyList", "traits": { - "smithy.api#documentation": "

A list of tag keys. If the DAX cluster has any tags with these keys, then the tags are removed from the cluster.

", + "smithy.api#documentation": "

A list of tag keys. If the DAX cluster has any tags with these keys,\n then the tags are removed from the cluster.

", "smithy.api#required": {} } } @@ -3547,7 +3576,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the settings for a DAX cluster. You can use this action to change one or\n more cluster configuration parameters by specifying the parameters and the new\n values.

" + "smithy.api#documentation": "

Modifies the settings for a DAX cluster. You can use this action to\n change one or more cluster configuration parameters by specifying the parameters and the\n new values.

" } }, "com.amazonaws.dax#UpdateClusterRequest": { @@ -3581,7 +3610,7 @@ "NotificationTopicStatus": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The current state of the topic. A value of “active” means that notifications will\n be sent to the topic. A value of “inactive” means that notifications will not be sent to the\n topic.

" + "smithy.api#documentation": "

The current state of the topic. A value of “active” means that notifications will\n be sent to the topic. A value of “inactive” means that notifications will not be sent to\n the topic.

" } }, "ParameterGroupName": { @@ -3593,7 +3622,7 @@ "SecurityGroupIds": { "target": "com.amazonaws.dax#SecurityGroupIdentifierList", "traits": { - "smithy.api#documentation": "

A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is not \n specified, DAX assigns the default VPC security group to each node.

" + "smithy.api#documentation": "

A list of user-specified security group IDs to be assigned to each node in the DAX\n cluster. If this parameter is not specified, DAX assigns the default VPC security group\n to each node.

" } } }, @@ -3641,7 +3670,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the parameters of a parameter group. You can modify up to 20\n parameters in a single request by submitting a list parameter name and value\n pairs.

" + "smithy.api#documentation": "

Modifies the parameters of a parameter group. You can modify up to 20 parameters in\n a single request by submitting a list parameter name and value pairs.

" } }, "com.amazonaws.dax#UpdateParameterGroupRequest": { @@ -3657,7 +3686,7 @@ "ParameterNameValues": { "target": "com.amazonaws.dax#ParameterNameValueList", "traits": { - "smithy.api#documentation": "

An array of name-value pairs for the parameters in the group. Each element in the\n array represents a single parameter.

\n \n

\n record-ttl-millis and query-ttl-millis are the only supported parameter names. For more details, see Configuring TTL Settings.

\n
", + "smithy.api#documentation": "

An array of name-value pairs for the parameters in the group. Each element in the\n array represents a single parameter.

\n \n

\n record-ttl-millis and query-ttl-millis are the only\n supported parameter names. For more details, see Configuring TTL Settings.

\n
", "smithy.api#required": {} } } @@ -3701,6 +3730,9 @@ { "target": "com.amazonaws.dax#SubnetInUse" }, + { + "target": "com.amazonaws.dax#SubnetNotAllowedFault" + }, { "target": "com.amazonaws.dax#SubnetQuotaExceededFault" } diff --git a/codegen/sdk/aws-models/deadline.json b/codegen/sdk/aws-models/deadline.json index bcc73eaa40f..c03eb771d67 100644 --- a/codegen/sdk/aws-models/deadline.json +++ b/codegen/sdk/aws-models/deadline.json @@ -22,7 +22,7 @@ "selections": { "target": "com.amazonaws.deadline#AcceleratorSelections", "traits": { - "smithy.api#documentation": "

A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed.

", + "smithy.api#documentation": "

A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances\n that provide these capabilities will be used. For example, if you specify both L4 and T4\n chips, Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip\n installed.

", "smithy.api#required": {} } }, @@ -34,7 +34,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information about the GPU accelerators used for jobs processed by a fleet.

" + "smithy.api#documentation": "

Provides information about the GPU accelerators used for jobs processed by a\n fleet.

" } }, "com.amazonaws.deadline#AcceleratorCountRange": { @@ -55,7 +55,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines the maximum and minimum number of GPU accelerators required for a worker instance..

" + "smithy.api#documentation": "

Defines the maximum and minimum number of GPU accelerators required for a worker\n instance..

" } }, "com.amazonaws.deadline#AcceleratorName": { @@ -102,7 +102,7 @@ "name": { "target": "com.amazonaws.deadline#AcceleratorName", "traits": { - "smithy.api#documentation": "

The name of the chip used by the GPU accelerator.

If you specify l4 as the name of the accelerator, you must specify latest or grid:r570 as the runtime.

The available GPU accelerators are:

  • t4 - NVIDIA T4 Tensor Core GPU

  • a10g - NVIDIA A10G Tensor Core GPU

  • l4 - NVIDIA L4 Tensor Core GPU

  • l40s - NVIDIA L40S Tensor Core GPU

", + "smithy.api#documentation": "

The name of the chip used by the GPU accelerator.

\n

If you specify l4 as the name of the accelerator, you must specify\n latest or grid:r570 as the runtime.

\n

The available GPU accelerators are:

\n
    \n
  • \n

    \n t4 - NVIDIA T4 Tensor Core GPU

    \n
  • \n
  • \n

    \n a10g - NVIDIA A10G Tensor Core GPU

    \n
  • \n
  • \n

    \n l4 - NVIDIA L4 Tensor Core GPU

    \n
  • \n
  • \n

    \n l40s - NVIDIA L40S Tensor Core GPU

    \n
  • \n
", "smithy.api#required": {} } }, @@ -110,7 +110,7 @@ "target": "com.amazonaws.deadline#AcceleratorRuntime", "traits": { "smithy.api#default": "latest", - "smithy.api#documentation": "

Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs.

You can choose from the following runtimes:

  • latest - Use the latest runtime available for the chip. If you specify latest and a new version of the runtime is released, the new version of the runtime is used.

  • grid:r570 - NVIDIA vGPU software 18

  • grid:r535 - NVIDIA vGPU software 16

If you don't specify a runtime, Deadline Cloud uses latest as the default. However, if you have multiple accelerators and specify latest for some and leave others blank, Deadline Cloud raises an exception.

" + "smithy.api#documentation": "

Specifies the runtime driver to use for the GPU accelerator. You must use the same\n runtime for all GPUs.

\n

You can choose from the following runtimes:

\n
    \n
  • \n

    \n latest - Use the latest runtime available for the chip. If you\n specify latest and a new version of the runtime is released, the new\n version of the runtime is used.

    \n
  • \n
  • \n

    \n grid:r570 - NVIDIA vGPU software 18\n

    \n
  • \n
  • \n

    \n grid:r535 - NVIDIA vGPU software 16\n

    \n
  • \n
\n

If you don't specify a runtime, Deadline Cloud uses latest as the default. However,\n if you have multiple accelerators and specify latest for some and leave others\n blank, Deadline Cloud raises an exception.

" } } }, @@ -142,7 +142,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines the maximum and minimum amount of memory, in MiB, to use for the accelerator.

" + "smithy.api#documentation": "

Defines the maximum and minimum amount of memory, in MiB, to use for the\n accelerator.

" } }, "com.amazonaws.deadline#AcceleratorType": { @@ -929,7 +929,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "

Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.

", + "smithy.api#documentation": "

Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are\n scoped down to have read-only access.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -1105,7 +1105,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "

Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.

", + "smithy.api#documentation": "

Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are\n scoped down to have read-only access.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -1546,7 +1546,7 @@ "farmId": { "target": "com.amazonaws.deadline#FarmId", "traits": { - "smithy.api#documentation": "

The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.

", + "smithy.api#documentation": "

The farm ID of the worker that's fetching job details. The worker must have an\n assignment on a job to fetch job details.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1554,7 +1554,7 @@ "fleetId": { "target": "com.amazonaws.deadline#FleetId", "traits": { - "smithy.api#documentation": "

The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.

", + "smithy.api#documentation": "

The fleet ID of the worker that's fetching job details. The worker must have an\n assignment on a job to fetch job details.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1630,7 +1630,7 @@ "description": { "target": "com.amazonaws.deadline#Description", "traits": { - "smithy.api#documentation": "

A description for the budget action to add.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

A description for the budget action to add.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } } }, @@ -1804,14 +1804,14 @@ "status": { "target": "com.amazonaws.deadline#BudgetStatus", "traits": { - "smithy.api#documentation": "

The status of the budget.

  • ACTIVE–The budget is being evaluated.

  • INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

", + "smithy.api#documentation": "

The status of the budget.

\n
    \n
  • \n

    \n ACTIVE–The budget is being evaluated.

    \n
  • \n
  • \n

    \n INACTIVE–The budget is inactive. This can include Expired,\n Canceled, or deleted Deleted statuses.

    \n
  • \n
", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the budget summary to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the budget summary to update.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, @@ -1821,7 +1821,7 @@ "smithy.api#deprecated": { "message": "ListBudgets no longer supports description. Use GetBudget if description is needed." }, - "smithy.api#documentation": "

The description of the budget summary.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the budget summary.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "approximateDollarLimit": { @@ -2010,7 +2010,7 @@ } }, "traits": { - "smithy.api#documentation": "

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

", + "smithy.api#documentation": "

Your request has conflicting operations. This can occur if you're trying to perform more\n than one operation on the same resource at the same time.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -2148,7 +2148,7 @@ "targetS3Location": { "target": "com.amazonaws.deadline#S3Location", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket name and key where you would like to add a copy of the job template.

", + "smithy.api#documentation": "

The Amazon S3 bucket name and key where you would like to add a copy of the job\n template.

", "smithy.api#required": {} } } @@ -2266,7 +2266,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the budget.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the budget.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, @@ -2274,7 +2274,7 @@ "target": "com.amazonaws.deadline#Description", "traits": { "smithy.api#default": "", - "smithy.api#documentation": "

The description of the budget.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the budget.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "approximateDollarLimit": { @@ -2358,7 +2358,7 @@ "deadline:TagResource" ] }, - "smithy.api#documentation": "

Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.

", + "smithy.api#documentation": "

Creates a farm to allow space for queues and fleets. Farms are the space where the\n components of your renders gather and are pieced together in the cloud. Farms contain\n budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for\n large projects.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -2384,7 +2384,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the farm.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the farm.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, @@ -2392,7 +2392,7 @@ "target": "com.amazonaws.deadline#Description", "traits": { "smithy.api#default": "", - "smithy.api#documentation": "

The description of the farm.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the farm.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "kmsKeyArn": { @@ -2473,7 +2473,7 @@ "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.

", + "smithy.api#documentation": "

Creates a fleet. Fleets gather information relating to compute, or capacity, for renders\n within your farms. You can choose to manage your own capacity or opt to have fleets fully\n managed by Deadline Cloud.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -2507,7 +2507,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the fleet.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the fleet.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, @@ -2515,7 +2515,7 @@ "target": "com.amazonaws.deadline#Description", "traits": { "smithy.api#default": "", - "smithy.api#documentation": "

The description of the fleet.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the fleet.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "roleArn": { @@ -2535,14 +2535,14 @@ "maxWorkerCount": { "target": "com.amazonaws.deadline#MinZeroMaxInteger", "traits": { - "smithy.api#documentation": "

The maximum number of workers for the fleet.

Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.

", + "smithy.api#documentation": "

The maximum number of workers for the fleet.

\n

Deadline Cloud limits the number of workers to less than or equal to the fleet's\n maximum worker count. The service maintains eventual consistency for the worker count. If\n you make multiple rapid calls to CreateWorker before the field updates, you\n might exceed your fleet's maximum worker count. For example, if your\n maxWorkerCount is 10 and you currently have 9 workers, making two quick\n CreateWorker calls might successfully create 2 workers instead of 1,\n resulting in 11 total workers.

", "smithy.api#required": {} } }, "configuration": { "target": "com.amazonaws.deadline#FleetConfiguration", "traits": { - "smithy.api#documentation": "

The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.

", + "smithy.api#documentation": "

The configuration settings for the fleet. Customer managed fleets are self-managed.\n Service managed Amazon EC2 fleets are managed by Deadline Cloud.

", "smithy.api#required": {} } }, @@ -2555,7 +2555,7 @@ "hostConfiguration": { "target": "com.amazonaws.deadline#HostConfiguration", "traits": { - "smithy.api#documentation": "

Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

" + "smithy.api#documentation": "

Provides a script that runs as a worker is starting up that you can use to provide\n additional configuration for workers in your fleet.

" } } }, @@ -2615,7 +2615,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "

Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.

", + "smithy.api#documentation": "

Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule\n and run work on available workers. For more information, see Deadline Cloud\n jobs.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -2669,7 +2669,7 @@ "priority": { "target": "com.amazonaws.deadline#JobPriority", "traits": { - "smithy.api#documentation": "

The priority of the job. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.

", + "smithy.api#documentation": "

The priority of the job. The highest priority (first scheduled) is 100. When two jobs\n have the same priority, the oldest job is scheduled first.

", "smithy.api#required": {} } }, @@ -2682,7 +2682,7 @@ "attachments": { "target": "com.amazonaws.deadline#Attachments", "traits": { - "smithy.api#documentation": "

The attachments for the job. Attach files required for the job to run to a render job.

" + "smithy.api#documentation": "

The attachments for the job. Attach files required for the job to run to a render\n job.

" } }, "storageProfileId": { @@ -2695,7 +2695,7 @@ "target": "com.amazonaws.deadline#CreateJobTargetTaskRunStatus", "traits": { "smithy.api#default": "READY", - "smithy.api#documentation": "

The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.

" + "smithy.api#documentation": "

The initial job status when it is created. Jobs that are created with a\n SUSPENDED status will not run until manually requeued.

" } }, "maxFailedTasksCount": { @@ -2715,7 +2715,7 @@ "maxWorkerCount": { "target": "com.amazonaws.deadline#MaxWorkerCount", "traits": { - "smithy.api#documentation": "

The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.

You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.

If you don't specify the maxWorkerCount, Deadline Cloud won't throttle the number of workers used to process the job.

" + "smithy.api#documentation": "

The maximum number of worker hosts that can concurrently process a job. When the\n maxWorkerCount is reached, no more workers will be assigned to process the\n job, even if the fleets assigned to the job's queue has available workers.

\n

You can't set the maxWorkerCount to 0. If you set it to -1, there is no\n maximum number of workers.

\n

If you don't specify the maxWorkerCount, Deadline Cloud won't throttle\n the number of workers used to process the job.

" } }, "sourceJobId": { @@ -2804,7 +2804,7 @@ "ec2:DescribeVpcEndpoints" ] }, - "smithy.api#documentation": "

Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.

", + "smithy.api#documentation": "

Creates a license endpoint to integrate your various licensed software used for\n rendering on Deadline Cloud.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -2918,7 +2918,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "

Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.

You must add the amountRequirementName to a step in a job template to declare the limit requirement.

", + "smithy.api#documentation": "

Creates a limit that manages the distribution of shared resources, such as floating\n licenses. A limit can throttle work assignments, help manage workloads, and track current\n usage. Before you use a limit, you must associate the limit with one or more queues.

\n

You must add the amountRequirementName to a step in a job template to\n declare the limit requirement.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -2944,21 +2944,21 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the limit.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the limit.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, "amountRequirementName": { "target": "com.amazonaws.deadline#AmountRequirementName", "traits": { - "smithy.api#documentation": "

The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.

", + "smithy.api#documentation": "

The value that you specify as the name in the amounts field of\n the hostRequirements in a step of a job template to declare the limit\n requirement.

", "smithy.api#required": {} } }, "maxCount": { "target": "com.amazonaws.deadline#MaxCount", "traits": { - "smithy.api#documentation": "

The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.

The maxCount must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.

", + "smithy.api#documentation": "

The maximum number of resources constrained by this limit. When all of the resources are\n in use, steps that require the limit won't be scheduled until the resource is\n available.

\n

The maxCount must not be 0. If the value is -1, there is no restriction on\n the number of resources that can be acquired for this limit.

", "smithy.api#required": {} } }, @@ -2974,7 +2974,7 @@ "target": "com.amazonaws.deadline#Description", "traits": { "smithy.api#default": "", - "smithy.api#documentation": "

A description of the limit. A description helps you identify the purpose of the limit.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

A description of the limit. A description helps you identify the purpose of the\n limit.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } } }, @@ -2988,7 +2988,7 @@ "limitId": { "target": "com.amazonaws.deadline#LimitId", "traits": { - "smithy.api#documentation": "

A unique identifier for the limit. Use this identifier in other operations, such as CreateQueueLimitAssociation and DeleteLimit.

", + "smithy.api#documentation": "

A unique identifier for the limit. Use this identifier in other operations, such as\n CreateQueueLimitAssociation and DeleteLimit.

", "smithy.api#required": {} } } @@ -3040,7 +3040,7 @@ "iam:PassRole" ] }, - "smithy.api#documentation": "

Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.

", + "smithy.api#documentation": "

Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and\n fleets. After you submit a job, you can track the progress of the tasks and steps that make\n up the job, and then download the job's results.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -3066,7 +3066,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The name that you give the monitor that is displayed in the Deadline Cloud console.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The name that you give the monitor that is displayed in the Deadline Cloud console.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, @@ -3080,14 +3080,14 @@ "subdomain": { "target": "com.amazonaws.deadline#Subdomain", "traits": { - "smithy.api#documentation": "

The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

", + "smithy.api#documentation": "

The subdomain to use when creating the monitor URL. The full URL of the monitor is\n subdomain.Region.deadlinecloud.amazonaws.com.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.deadline#IamRoleArn", "traits": { - "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#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the monitor uses to connect to Deadline Cloud. Every user\n that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud\n resources.

", "smithy.api#required": {} } }, @@ -3168,7 +3168,7 @@ "s3:ListBucket" ] }, - "smithy.api#documentation": "

Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.

", + "smithy.api#documentation": "

Creates a queue to coordinate the order in which jobs run on a farm. A queue can also\n specify where to pull resources and indicate where to output completed jobs.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -3258,7 +3258,7 @@ "priority": { "target": "com.amazonaws.deadline#Priority", "traits": { - "smithy.api#documentation": "

Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority (activated first and deactivated last). If two environments share the same priority value, the environment created first takes higher priority.

", + "smithy.api#documentation": "

Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the\n highest priority (activated first and deactivated last). If two environments share the same\n priority value, the environment created first takes higher priority.

", "smithy.api#required": {} } }, @@ -3419,7 +3419,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "

Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same amountRequirementName to the same queue.

", + "smithy.api#documentation": "

Associates a limit with a particular queue. After the limit is associated, all workers\n for jobs that specify the limit associated with the queue are subject to the limit. You\n can't associate two limits with the same amountRequirementName to the same\n queue.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -3498,7 +3498,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the queue.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the queue.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, @@ -3506,7 +3506,7 @@ "target": "com.amazonaws.deadline#Description", "traits": { "smithy.api#default": "", - "smithy.api#documentation": "

The description of the queue.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the queue.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "defaultBudgetAction": { @@ -3519,7 +3519,7 @@ "jobAttachmentSettings": { "target": "com.amazonaws.deadline#JobAttachmentSettings", "traits": { - "smithy.api#documentation": "

The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

" + "smithy.api#documentation": "

The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3\n prefix.

" } }, "roleArn": { @@ -3608,7 +3608,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "

Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.

", + "smithy.api#documentation": "

Creates a storage profile that specifies the operating system, file type, and file\n location of resources used on a farm.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -3642,7 +3642,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the storage profile.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the storage profile.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, @@ -3720,7 +3720,7 @@ "deadline:ListTagsForResource" ] }, - "smithy.api#documentation": "

Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.

Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.

", + "smithy.api#documentation": "

Creates a worker. A worker tells your instance how much processing power (vCPU), and\n memory (GiB) you’ll need to assemble the digital assets held within a particular instance.\n You can specify certain instance types to use, or let the worker know which instances types\n to exclude.

\n

Deadline Cloud limits the number of workers to less than or equal to the fleet's\n maximum worker count. The service maintains eventual consistency for the worker count. If\n you make multiple rapid calls to CreateWorker before the field updates, you\n might exceed your fleet's maximum worker count. For example, if your\n maxWorkerCount is 10 and you currently have 9 workers, making two quick\n CreateWorker calls might successfully create 2 workers instead of 1,\n resulting in 11 total workers.

", "smithy.api#endpoint": { "hostPrefix": "scheduling." }, @@ -3850,7 +3850,7 @@ "tagPropagationMode": { "target": "com.amazonaws.deadline#TagPropagationMode", "traits": { - "smithy.api#documentation": "

Specifies whether tags associated with a fleet are attached to workers when the worker is launched.

When the tagPropagationMode is set to PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH any tag associated with a fleet is attached to workers when they launch. If the tags for a fleet change, the tags associated with running workers do not change.

If you don't specify tagPropagationMode, the default is NO_PROPAGATION.

" + "smithy.api#documentation": "

Specifies whether tags associated with a fleet are attached to workers when the worker\n is launched.

\n

When the tagPropagationMode is set to\n PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH any tag associated with a fleet is\n attached to workers when they launch. If the tags for a fleet change, the tags associated\n with running workers do not change.

\n

If you don't specify tagPropagationMode, the default is\n NO_PROPAGATION.

" } } }, @@ -4144,7 +4144,7 @@ "x-amz-apigw-id" ] }, - "smithy.api#documentation": "

The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions specific to their job function.

With Deadline Cloud, content production teams can deploy resources for their workforce securely in the cloud, reducing the costs of added physical infrastructure. Keep your content production operations secure, while allowing your contributors to access the tools they need, such as scalable high-speed storage, licenses, and cost management services.

", + "smithy.api#documentation": "

The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your\n projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions\n specific to their job function.

\n

With Deadline Cloud, content production teams can deploy resources for their workforce\n securely in the cloud, reducing the costs of added physical infrastructure. Keep your\n content production operations secure, while allowing your contributors to access the tools\n they need, such as scalable high-speed storage, licenses, and cost management\n services.

", "smithy.api#title": "AWSDeadlineCloud", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -4654,17 +4654,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4678,17 +4667,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4702,17 +4680,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4726,17 +4693,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5186,7 +5142,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "

Removes a limit from the specified farm. Before you delete a limit you must use the DeleteQueueLimitAssociation operation to remove the association with any queues.

", + "smithy.api#documentation": "

Removes a limit from the specified farm. Before you delete a limit you must use the\n DeleteQueueLimitAssociation operation to remove the association with any\n queues.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -5337,7 +5293,7 @@ "sso:DeleteApplication" ] }, - "smithy.api#documentation": "

Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.

", + "smithy.api#documentation": "

Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and\n attach farms to the monitor.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -5355,7 +5311,7 @@ "monitorId": { "target": "com.amazonaws.deadline#MonitorId", "traits": { - "smithy.api#documentation": "

The unique identifier of the monitor to delete. This ID is returned by the CreateMonitor operation, and is included in the response to the GetMonitor operation.

", + "smithy.api#documentation": "

The unique identifier of the monitor to delete. This ID is returned by the\n CreateMonitor operation, and is included in the response to the\n GetMonitor operation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5408,7 +5364,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "

Deletes a queue.

You can't recover the jobs in a queue if you delete the queue. Deleting the queue also deletes the jobs in that queue.

", + "smithy.api#documentation": "

Deletes a queue.

\n \n

You can't recover the jobs in a queue if you delete the queue. Deleting the queue\n also deletes the jobs in that queue.

\n
", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -5632,7 +5588,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "

Removes the association between a queue and a limit. You must use the UpdateQueueLimitAssociation operation to set the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately. Use the GetQueueLimitAssociation operation to see if the status changed to STOPPED before deleting the association.

", + "smithy.api#documentation": "

Removes the association between a queue and a limit. You must use the\n UpdateQueueLimitAssociation operation to set the status to\n STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or\n STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately.\n Use the GetQueueLimitAssociation operation to see if the status changed to\n STOPPED before deleting the association.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -5650,7 +5606,7 @@ "farmId": { "target": "com.amazonaws.deadline#FarmId", "traits": { - "smithy.api#documentation": "

The unique identifier of the farm that contains the queue and limit to disassociate.

", + "smithy.api#documentation": "

The unique identifier of the farm that contains the queue and limit to\n disassociate.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6390,6 +6346,12 @@ "traits": { "smithy.api#enumValue": "spot" } + }, + "WAIT_AND_SAVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "wait-and-save" + } } } }, @@ -6771,7 +6733,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the farm.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the farm.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, @@ -7204,6 +7166,12 @@ "traits": { "smithy.api#enumValue": "UPDATE_FAILED" } + }, + "SUSPENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUSPENDED" + } } } }, @@ -7234,7 +7202,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the fleet summary to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the fleet summary to update.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, @@ -7245,6 +7213,12 @@ "smithy.api#required": {} } }, + "statusMessage": { + "target": "com.amazonaws.deadline#String", + "traits": { + "smithy.api#documentation": "

A message that communicates a suspended status of the fleet.

" + } + }, "autoScalingStatus": { "target": "com.amazonaws.deadline#AutoScalingStatus", "traits": { @@ -7415,21 +7389,21 @@ "status": { "target": "com.amazonaws.deadline#BudgetStatus", "traits": { - "smithy.api#documentation": "

The status of the budget.

  • ACTIVE–Get a budget being evaluated.

  • INACTIVE–Get an inactive budget. This can include expired, canceled, or deleted statuses.

", + "smithy.api#documentation": "

The status of the budget.

\n
    \n
  • \n

    \n ACTIVE–Get a budget being evaluated.

    \n
  • \n
  • \n

    \n INACTIVE–Get an inactive budget. This can include expired,\n canceled, or deleted statuses.

    \n
  • \n
", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the budget.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the budget.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.deadline#Description", "traits": { - "smithy.api#documentation": "

The description of the budget.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the budget.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "approximateDollarLimit": { @@ -7571,14 +7545,14 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the farm.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the farm.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.deadline#Description", "traits": { - "smithy.api#documentation": "

The description of the farm.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the farm.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "kmsKeyArn": { @@ -7747,14 +7721,14 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the fleet.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the fleet.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.deadline#Description", "traits": { - "smithy.api#documentation": "

The description of the fleet.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the fleet.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "status": { @@ -7764,10 +7738,16 @@ "smithy.api#required": {} } }, + "statusMessage": { + "target": "com.amazonaws.deadline#String", + "traits": { + "smithy.api#documentation": "

A message that communicates a suspended status of the fleet.

" + } + }, "autoScalingStatus": { "target": "com.amazonaws.deadline#AutoScalingStatus", "traits": { - "smithy.api#documentation": "

The Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING.

" + "smithy.api#documentation": "

The Auto Scaling status of the fleet. Either GROWING, STEADY, or\n SHRINKING.

" } }, "targetWorkerCount": { @@ -7807,13 +7787,13 @@ "hostConfiguration": { "target": "com.amazonaws.deadline#HostConfiguration", "traits": { - "smithy.api#documentation": "

The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

" + "smithy.api#documentation": "

The script that runs as a worker is starting up that you can use to provide additional\n configuration for workers in your fleet.

" } }, "capabilities": { "target": "com.amazonaws.deadline#FleetCapabilities", "traits": { - "smithy.api#documentation": "

Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.

" + "smithy.api#documentation": "

Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to\n attribute names and values.

" } }, "roleArn": { @@ -8169,13 +8149,13 @@ "description": { "target": "com.amazonaws.deadline#JobDescription", "traits": { - "smithy.api#documentation": "

The description of the job.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the job.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "maxWorkerCount": { "target": "com.amazonaws.deadline#MaxWorkerCount", "traits": { - "smithy.api#documentation": "

The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.

If you don't set the maxWorkerCount when you create a job, this value is not returned in the response.

" + "smithy.api#documentation": "

The maximum number of worker hosts that can concurrently process a job. When the\n maxWorkerCount is reached, no more workers will be assigned to process the\n job, even if the fleets assigned to the job's queue has available workers.

\n

If you don't set the maxWorkerCount when you create a job, this value is\n not returned in the response.

" } }, "sourceJobId": { @@ -8436,21 +8416,21 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the limit.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the limit.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, "amountRequirementName": { "target": "com.amazonaws.deadline#AmountRequirementName", "traits": { - "smithy.api#documentation": "

The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.

", + "smithy.api#documentation": "

The value that you specify as the name in the amounts field of\n the hostRequirements in a step of a job template to declare the limit\n requirement.

", "smithy.api#required": {} } }, "maxCount": { "target": "com.amazonaws.deadline#MaxCount", "traits": { - "smithy.api#documentation": "

The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.

The maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.

", + "smithy.api#documentation": "

The maximum number of resources constrained by this limit. When all of the resources are\n in use, steps that require the limit won't be scheduled until the resource is\n available.

\n

The maxValue must not be 0. If the value is -1, there is no restriction on\n the number of resources that can be acquired for this limit.

", "smithy.api#required": {} } }, @@ -8497,14 +8477,14 @@ "currentCount": { "target": "com.amazonaws.deadline#MinZeroMaxInteger", "traits": { - "smithy.api#documentation": "

The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.

", + "smithy.api#documentation": "

The number of resources from the limit that are being used by jobs. The result is\n delayed and may not be the count at the time that you called the operation.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.deadline#Description", "traits": { - "smithy.api#documentation": "

The description of the limit that helps identify what the limit is used for.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the limit that helps identify what the limit is used for.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } } }, @@ -8561,7 +8541,7 @@ "monitorId": { "target": "com.amazonaws.deadline#MonitorId", "traits": { - "smithy.api#documentation": "

The unique identifier for the monitor. This ID is returned by the CreateMonitor operation.

", + "smithy.api#documentation": "

The unique identifier for the monitor. This ID is returned by the\n CreateMonitor operation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8584,28 +8564,28 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The name used to identify the monitor on the Deadline Cloud console.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The name used to identify the monitor on the Deadline Cloud console.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, "subdomain": { "target": "com.amazonaws.deadline#Subdomain", "traits": { - "smithy.api#documentation": "

The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

", + "smithy.api#documentation": "

The subdomain used for the monitor URL. The full URL of the monitor is\n subdomain.Region.deadlinecloud.amazonaws.com.

", "smithy.api#required": {} } }, "url": { "target": "com.amazonaws.deadline#Url", "traits": { - "smithy.api#documentation": "

The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

", + "smithy.api#documentation": "

The complete URL of the monitor. The full URL of the monitor is\n subdomain.Region.deadlinecloud.amazonaws.com.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.deadline#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to\n access Deadline Cloud resources.

", "smithy.api#required": {} } }, @@ -9234,14 +9214,14 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the queue.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the queue.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.deadline#Description", "traits": { - "smithy.api#documentation": "

The description of the queue.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the queue.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "farmId": { @@ -9254,7 +9234,7 @@ "status": { "target": "com.amazonaws.deadline#QueueStatus", "traits": { - "smithy.api#documentation": "

The status of the queue.

  • ACTIVE–The queue is active.

  • SCHEDULING–The queue is scheduling.

  • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

", + "smithy.api#documentation": "

The status of the queue.

\n
    \n
  • \n

    \n ACTIVE–The queue is active.

    \n
  • \n
  • \n

    \n SCHEDULING–The queue is scheduling.

    \n
  • \n
  • \n

    \n SCHEDULING_BLOCKED–The queue scheduling is blocked. See the\n provided reason.

    \n
  • \n
", "smithy.api#required": {} } }, @@ -9524,7 +9504,7 @@ "processExitCode": { "target": "com.amazonaws.deadline#ProcessExitCode", "traits": { - "smithy.api#documentation": "

The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.

" + "smithy.api#documentation": "

The process exit code. The default Deadline Cloud worker agent converts unsigned\n 32-bit exit codes to signed 32-bit exit codes.

" } }, "progressMessage": { @@ -9543,7 +9523,7 @@ "acquiredLimits": { "target": "com.amazonaws.deadline#AcquiredLimits", "traits": { - "smithy.api#documentation": "

The limits and their amounts acquired during a session action. If no limits were acquired during the session, this field isn't returned.

" + "smithy.api#documentation": "

The limits and their amounts acquired during a session action. If no limits were\n acquired during the session, this field isn't returned.

" } }, "manifests": { @@ -9716,7 +9696,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "

Gets a set of statistics for queues or farms. Before you can call the GetSessionStatisticsAggregation operation, you must first call the StartSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.

", + "smithy.api#documentation": "

Gets a set of statistics for queues or farms. Before you can call the\n GetSessionStatisticsAggregation operation, you must first call the\n StartSessionsStatisticsAggregation operation. Statistics are available for\n 1 hour after you call the StartSessionsStatisticsAggregation operation.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -9740,7 +9720,7 @@ "farmId": { "target": "com.amazonaws.deadline#FarmId", "traits": { - "smithy.api#documentation": "

The identifier of the farm to include in the statistics. This should be the same as the farm ID used in the call to the StartSessionsStatisticsAggregation operation.

", + "smithy.api#documentation": "

The identifier of the farm to include in the statistics. This should be the same as the\n farm ID used in the call to the StartSessionsStatisticsAggregation\n operation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9748,7 +9728,7 @@ "aggregationId": { "target": "com.amazonaws.deadline#AggregationId", "traits": { - "smithy.api#documentation": "

The identifier returned by the StartSessionsStatisticsAggregation operation that identifies the aggregated statistics.

", + "smithy.api#documentation": "

The identifier returned by the StartSessionsStatisticsAggregation operation\n that identifies the aggregated statistics.

", "smithy.api#httpQuery": "aggregationId", "smithy.api#required": {} } @@ -9791,7 +9771,7 @@ "status": { "target": "com.amazonaws.deadline#SessionsStatisticsAggregationStatus", "traits": { - "smithy.api#documentation": "

The status of the aggregated results. An aggregation may fail or time out if the results are too large. If this happens, you can call the StartSessionsStatisticsAggregation operation after you reduce the aggregation time frame, reduce the number of queues or fleets in the aggregation, or increase the period length.

If you call the StartSessionsStatisticsAggregation operation when the status is IN_PROGRESS, you will receive a ThrottlingException.

", + "smithy.api#documentation": "

The status of the aggregated results. An aggregation may fail or time out if the results\n are too large. If this happens, you can call the\n StartSessionsStatisticsAggregation operation after you reduce the\n aggregation time frame, reduce the number of queues or fleets in the aggregation, or\n increase the period length.

\n

If you call the StartSessionsStatisticsAggregation operation when the\n status is IN_PROGRESS, you will receive a\n ThrottlingException.

", "smithy.api#required": {} } }, @@ -10012,7 +9992,7 @@ "description": { "target": "com.amazonaws.deadline#StepDescription", "traits": { - "smithy.api#documentation": "

The description of the step.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the step.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } } }, @@ -10155,7 +10135,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the storage profile connected to a queue.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the storage profile connected to a queue.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, @@ -10214,7 +10194,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the storage profile.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the storage profile.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, @@ -10608,7 +10588,7 @@ "scriptBody": { "target": "com.amazonaws.deadline#HostConfigurationScript", "traits": { - "smithy.api#documentation": "

The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the STARTING state and before the worker processes tasks.

For more information about using the script, see Run scripts as an administrator to configure workers in the Deadline Cloud Developer Guide.

The script runs as an administrative user (sudo root on Linux, as an Administrator on Windows).

", + "smithy.api#documentation": "

The text of the script that runs as a worker is starting up that you can use to provide\n additional configuration for workers in your fleet. The script runs after a worker enters\n the STARTING state and before the worker processes tasks.

\n

For more information about using the script, see Run scripts as an\n administrator to configure workers in the Deadline Cloud Developer\n Guide.

\n \n

The script runs as an administrative user (sudo root on Linux, as an\n Administrator on Windows).

\n
", "smithy.api#required": {} } }, @@ -10616,12 +10596,12 @@ "target": "com.amazonaws.deadline#HostConfigurationScriptTimeoutSeconds", "traits": { "smithy.api#default": 300, - "smithy.api#documentation": "

The maximum time that the host configuration can run. If the timeout expires, the worker enters the NOT RESPONDING state and shuts down. You are charged for the time that the worker is running the host configuration script.

You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers.

The default is 300 seconds (5 minutes).

" + "smithy.api#documentation": "

The maximum time that the host configuration can run. If the timeout expires, the worker\n enters the NOT RESPONDING state and shuts down. You are charged for the time\n that the worker is running the host configuration script.

\n \n

You should configure your fleet for a maximum of one worker while testing your host\n configuration script to avoid starting additional workers.

\n
\n

The default is 300 seconds (5 minutes).

" } } }, "traits": { - "smithy.api#documentation": "

Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

To remove a script from a fleet, use the UpdateFleet operation with the hostConfiguration scriptBody parameter set to an empty string (\"\").

" + "smithy.api#documentation": "

Provides a script that runs as a worker is starting up that you can use to provide\n additional configuration for workers in your fleet.

\n

To remove a script from a fleet, use the UpdateFleet\n operation with the hostConfiguration\n scriptBody parameter set to an empty string (\"\").

" } }, "com.amazonaws.deadline#HostConfigurationScript": { @@ -11491,7 +11471,7 @@ "runAs": { "target": "com.amazonaws.deadline#RunAs", "traits": { - "smithy.api#documentation": "

Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.

", + "smithy.api#documentation": "

Specifies whether the job should run using the queue's system user or if the job should\n run using the worker agent system user.

", "smithy.api#required": {} } } @@ -11542,7 +11522,7 @@ "taskRunStatus": { "target": "com.amazonaws.deadline#TaskRunStatus", "traits": { - "smithy.api#documentation": "

The task run status for the job.

  • PENDING–pending and waiting for resources.

  • READY–ready to be processed.

  • ASSIGNED–assigned and will run next on a worker.

  • SCHEDULED–scheduled to be run on a worker.

  • INTERRUPTING–being interrupted.

  • RUNNING–running on a worker.

  • SUSPENDED–the task is suspended.

  • CANCELED–the task has been canceled.

  • FAILED–the task has failed.

  • SUCCEEDED–the task has succeeded.

" + "smithy.api#documentation": "

The task run status for the job.

\n
    \n
  • \n

    \n PENDING–pending and waiting for resources.

    \n
  • \n
  • \n

    \n READY–ready to be processed.

    \n
  • \n
  • \n

    \n ASSIGNED–assigned and will run next on a worker.

    \n
  • \n
  • \n

    \n SCHEDULED–scheduled to be run on a worker.

    \n
  • \n
  • \n

    \n INTERRUPTING–being interrupted.

    \n
  • \n
  • \n

    \n RUNNING–running on a worker.

    \n
  • \n
  • \n

    \n SUSPENDED–the task is suspended.

    \n
  • \n
  • \n

    \n CANCELED–the task has been canceled.

    \n
  • \n
  • \n

    \n FAILED–the task has failed.

    \n
  • \n
  • \n

    \n SUCCEEDED–the task has succeeded.

    \n
  • \n
" } }, "targetTaskRunStatus": { @@ -11626,7 +11606,7 @@ "maxWorkerCount": { "target": "com.amazonaws.deadline#MaxWorkerCount", "traits": { - "smithy.api#documentation": "

The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.

You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.

If you don't specify the maxWorkerCount, the default is -1.

" + "smithy.api#documentation": "

The maximum number of worker hosts that can concurrently process a job. When the\n maxWorkerCount is reached, no more workers will be assigned to process the\n job, even if the fleets assigned to the job's queue has available workers.

\n

You can't set the maxWorkerCount to 0. If you set it to -1, there is no\n maximum number of workers.

\n

If you don't specify the maxWorkerCount, the default is -1.

" } }, "sourceJobId": { @@ -11725,7 +11705,7 @@ "taskRunStatus": { "target": "com.amazonaws.deadline#TaskRunStatus", "traits": { - "smithy.api#documentation": "

The task run status for the job.

  • PENDING–pending and waiting for resources.

  • READY–ready to be processed.

  • ASSIGNED–assigned and will run next on a worker.

  • SCHEDULED–scheduled to be run on a worker.

  • INTERRUPTING–being interrupted.

  • RUNNING–running on a worker.

  • SUSPENDED–the task is suspended.

  • CANCELED–the task has been canceled.

  • FAILED–the task has failed.

  • SUCCEEDED–the task has succeeded.

" + "smithy.api#documentation": "

The task run status for the job.

\n
    \n
  • \n

    \n PENDING–pending and waiting for resources.

    \n
  • \n
  • \n

    \n READY–ready to be processed.

    \n
  • \n
  • \n

    \n ASSIGNED–assigned and will run next on a worker.

    \n
  • \n
  • \n

    \n SCHEDULED–scheduled to be run on a worker.

    \n
  • \n
  • \n

    \n INTERRUPTING–being interrupted.

    \n
  • \n
  • \n

    \n RUNNING–running on a worker.

    \n
  • \n
  • \n

    \n SUSPENDED–the task is suspended.

    \n
  • \n
  • \n

    \n CANCELED–the task has been canceled.

    \n
  • \n
  • \n

    \n FAILED–the task has failed.

    \n
  • \n
  • \n

    \n SUCCEEDED–the task has succeeded.

    \n
  • \n
" } }, "targetTaskRunStatus": { @@ -11761,7 +11741,7 @@ "maxWorkerCount": { "target": "com.amazonaws.deadline#MaxWorkerCount", "traits": { - "smithy.api#documentation": "

The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.

You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.

If you don't specify the maxWorkerCount, the default is -1.

" + "smithy.api#documentation": "

The maximum number of worker hosts that can concurrently process a job. When the\n maxWorkerCount is reached, no more workers will be assigned to process the\n job, even if the fleets assigned to the job's queue has available workers.

\n

You can't set the maxWorkerCount to 0. If you set it to -1, there is no\n maximum number of workers.

\n

If you don't specify the maxWorkerCount, the default is -1.

" } }, "sourceJobId": { @@ -11981,21 +11961,21 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the limit used in lists to identify the limit.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The name of the limit used in lists to identify the limit.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, "amountRequirementName": { "target": "com.amazonaws.deadline#AmountRequirementName", "traits": { - "smithy.api#documentation": "

The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.

", + "smithy.api#documentation": "

The value that you specify as the name in the amounts field of\n the hostRequirements in a step of a job template to declare the limit\n requirement.

", "smithy.api#required": {} } }, "maxCount": { "target": "com.amazonaws.deadline#MaxCount", "traits": { - "smithy.api#documentation": "

The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.

The maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.

", + "smithy.api#documentation": "

The maximum number of resources constrained by this limit. When all of the resources are\n in use, steps that require the limit won't be scheduled until the resource is\n available.

\n

The maxValue must not be 0. If the value is -1, there is no restriction on\n the number of resources that can be acquired for this limit.

", "smithy.api#required": {} } }, @@ -12042,7 +12022,7 @@ "currentCount": { "target": "com.amazonaws.deadline#MinZeroMaxInteger", "traits": { - "smithy.api#documentation": "

The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.

", + "smithy.api#documentation": "

The number of resources from the limit that are being used by jobs. The result is\n delayed and may not be the count at the time that you called the operation.

", "smithy.api#required": {} } } @@ -12651,7 +12631,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display names of a list of fleets.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display names of a list of fleets.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#httpQuery": "displayName" } }, @@ -13442,7 +13422,7 @@ "monitors": { "target": "com.amazonaws.deadline#MonitorSummaries", "traits": { - "smithy.api#documentation": "

A list of MonitorSummary objects that describe your monitors in the Deadline Cloud.

", + "smithy.api#documentation": "

A list of MonitorSummary objects that describe your monitors in the\n Deadline Cloud.

", "smithy.api#required": {} } } @@ -13749,14 +13729,14 @@ "queueId": { "target": "com.amazonaws.deadline#QueueId", "traits": { - "smithy.api#documentation": "

Specifies that the operation should return only the queue limit associations for the specified queue. If you specify both the queueId and the limitId, only the specified limit is returned if it exists.

", + "smithy.api#documentation": "

Specifies that the operation should return only the queue limit associations for the\n specified queue. If you specify both the queueId and the limitId,\n only the specified limit is returned if it exists.

", "smithy.api#httpQuery": "queueId" } }, "limitId": { "target": "com.amazonaws.deadline#LimitId", "traits": { - "smithy.api#documentation": "

Specifies that the operation should return only the queue limit associations for the specified limit. If you specify both the queueId and the limitId, only the specified limit is returned if it exists.

", + "smithy.api#documentation": "

Specifies that the operation should return only the queue limit associations for the\n specified limit. If you specify both the queueId and the limitId,\n only the specified limit is returned if it exists.

", "smithy.api#httpQuery": "limitId" } }, @@ -13794,7 +13774,7 @@ "queueLimitAssociations": { "target": "com.amazonaws.deadline#QueueLimitAssociationSummaries", "traits": { - "smithy.api#documentation": "

A list of associations between limits and queues in the farm specified in the request.

", + "smithy.api#documentation": "

A list of associations between limits and queues in the farm specified in the\n request.

", "smithy.api#required": {} } }, @@ -13998,7 +13978,7 @@ "status": { "target": "com.amazonaws.deadline#QueueStatus", "traits": { - "smithy.api#documentation": "

The status of the queues listed.

  • ACTIVE–The queues are active.

  • SCHEDULING–The queues are scheduling.

  • SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.

", + "smithy.api#documentation": "

The status of the queues listed.

\n
    \n
  • \n

    \n ACTIVE–The queues are active.

    \n
  • \n
  • \n

    \n SCHEDULING–The queues are scheduling.

    \n
  • \n
  • \n

    \n SCHEDULING_BLOCKED–The queue scheduling is blocked for these\n queues.

    \n
  • \n
", "smithy.api#httpQuery": "status" } }, @@ -15829,28 +15809,28 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the monitor that displays on the Deadline Cloud console.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The name of the monitor that displays on the Deadline Cloud console.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, "subdomain": { "target": "com.amazonaws.deadline#Subdomain", "traits": { - "smithy.api#documentation": "

The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

", + "smithy.api#documentation": "

The subdomain used for the monitor URL. The full URL of the monitor is\n subdomain.Region.deadlinecloud.amazonaws.com.

", "smithy.api#required": {} } }, "url": { "target": "com.amazonaws.deadline#Url", "traits": { - "smithy.api#documentation": "

The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

", + "smithy.api#documentation": "

The complete URL of the monitor. The full URL of the monitor is\n subdomain.Region.deadlinecloud.amazonaws.com.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.deadline#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to\n access Deadline Cloud resources.

", "smithy.api#required": {} } }, @@ -16354,7 +16334,7 @@ "status": { "target": "com.amazonaws.deadline#QueueFleetAssociationStatus", "traits": { - "smithy.api#documentation": "

The status of task scheduling in the queue-fleet association.

  • ACTIVE–Association is active.

  • STOP_SCHEDULING_AND_COMPLETE_TASKS–Association has stopped scheduling new tasks and is completing current tasks.

  • STOP_SCHEDULING_AND_CANCEL_TASKS–Association has stopped scheduling new tasks and is canceling current tasks.

  • STOPPED–Association has been stopped.

", + "smithy.api#documentation": "

The status of task scheduling in the queue-fleet association.

\n
    \n
  • \n

    \n ACTIVE–Association is active.

    \n
  • \n
  • \n

    \n STOP_SCHEDULING_AND_COMPLETE_TASKS–Association has stopped\n scheduling new tasks and is completing current tasks.

    \n
  • \n
  • \n

    \n STOP_SCHEDULING_AND_CANCEL_TASKS–Association has stopped\n scheduling new tasks and is canceling current tasks.

    \n
  • \n
  • \n

    \n STOPPED–Association has been stopped.

    \n
  • \n
", "smithy.api#required": {} } }, @@ -16487,7 +16467,7 @@ "status": { "target": "com.amazonaws.deadline#QueueLimitAssociationStatus", "traits": { - "smithy.api#documentation": "

The status of task scheduling in the queue-limit association.

  • ACTIVE - Association is active.

  • STOP_LIMIT_USAGE_AND_COMPLETE_TASKS - Association has stopped scheduling new tasks and is completing current tasks.

  • STOP_LIMIT_USAGE_AND_CANCEL_TASKS - Association has stopped scheduling new tasks and is canceling current tasks.

  • STOPPED - Association has been stopped.

", + "smithy.api#documentation": "

The status of task scheduling in the queue-limit association.

\n
    \n
  • \n

    \n ACTIVE - Association is active.

    \n
  • \n
  • \n

    \n STOP_LIMIT_USAGE_AND_COMPLETE_TASKS - Association has stopped\n scheduling new tasks and is completing current tasks.

    \n
  • \n
  • \n

    \n STOP_LIMIT_USAGE_AND_CANCEL_TASKS - Association has stopped\n scheduling new tasks and is canceling current tasks.

    \n
  • \n
  • \n

    \n STOPPED - Association has been stopped.

    \n
  • \n
", "smithy.api#required": {} } } @@ -16688,7 +16668,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the queue summary to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the queue summary to update.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, @@ -16821,7 +16801,7 @@ "description": { "target": "com.amazonaws.deadline#Description", "traits": { - "smithy.api#documentation": "

The budget action description.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The budget action description.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } } }, @@ -16977,7 +16957,7 @@ } }, "traits": { - "smithy.api#documentation": "

The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().

" + "smithy.api#documentation": "

The filter expression, AND or OR, to use\nwhen searching among a group of search strings in a resource.\n\nYou can use two groupings per search each within parenthesis ().

" } }, "com.amazonaws.deadline#SearchJobs": { @@ -17053,7 +17033,7 @@ "filterExpressions": { "target": "com.amazonaws.deadline#SearchGroupedFilterExpressions", "traits": { - "smithy.api#documentation": "

The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().

" + "smithy.api#documentation": "

The filter expression, AND or OR, to use\nwhen searching among a group of search strings in a resource.\n\nYou can use two groupings per search each within parenthesis ().

" } }, "sortExpressions": { @@ -17234,7 +17214,7 @@ "filterExpressions": { "target": "com.amazonaws.deadline#SearchGroupedFilterExpressions", "traits": { - "smithy.api#documentation": "

The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().

" + "smithy.api#documentation": "

The filter expression, AND or OR, to use\nwhen searching among a group of search strings in a resource.\n\nYou can use two groupings per search each within parenthesis ().

" } }, "sortExpressions": { @@ -17377,7 +17357,7 @@ "filterExpressions": { "target": "com.amazonaws.deadline#SearchGroupedFilterExpressions", "traits": { - "smithy.api#documentation": "

The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().

" + "smithy.api#documentation": "

The filter expression, AND or OR, to use\nwhen searching among a group of search strings in a resource.\n\nYou can use two groupings per search each within parenthesis ().

" } }, "sortExpressions": { @@ -17464,7 +17444,7 @@ "target": "com.amazonaws.deadline#SearchTermMatchingType", "traits": { "smithy.api#default": "FUZZY_MATCH", - "smithy.api#documentation": "

Specifies how Deadline Cloud matches your search term in the results. If you don't specify a matchType the default is FUZZY_MATCH.

  • FUZZY_MATCH - Matches if a portion of the search term is found in the result.

  • CONTAINS - Matches if the exact search term is contained in the result.

" + "smithy.api#documentation": "

Specifies how Deadline Cloud matches your search term in the results. If you don't\n specify a matchType the default is FUZZY_MATCH.

\n
    \n
  • \n

    \n FUZZY_MATCH - Matches if a portion of the search term is found in the\n result.

    \n
  • \n
  • \n

    \n CONTAINS - Matches if the exact search term is contained in the\n result.

    \n
  • \n
" } } }, @@ -17562,7 +17542,7 @@ "filterExpressions": { "target": "com.amazonaws.deadline#SearchGroupedFilterExpressions", "traits": { - "smithy.api#documentation": "

The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().

" + "smithy.api#documentation": "

The filter expression, AND or OR, to use\nwhen searching among a group of search strings in a resource.\n\nYou can use two groupings per search each within parenthesis ().

" } }, "sortExpressions": { @@ -17724,7 +17704,7 @@ "acceleratorCapabilities": { "target": "com.amazonaws.deadline#AcceleratorCapabilities", "traits": { - "smithy.api#documentation": "

Describes the GPU accelerator capabilities required for worker host instances in this fleet.

" + "smithy.api#documentation": "

Describes the GPU accelerator capabilities required for worker host instances in this\n fleet.

" } }, "allowedInstanceTypes": { @@ -17839,7 +17819,7 @@ } }, "traits": { - "smithy.api#documentation": "

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.

", + "smithy.api#documentation": "

You exceeded your service quota. Service quotas, also referred to as limits, are the\n maximum number of service resources or operations for your Amazon Web Services account.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -18077,7 +18057,7 @@ "workerUpdatedAt": { "target": "com.amazonaws.deadline#Timestamp", "traits": { - "smithy.api#documentation": "

The Linux timestamp of the last date and time that the session action was updated.

" + "smithy.api#documentation": "

The Linux timestamp of the last date and time that the session action was\n updated.

" } }, "progressPercent": { @@ -18270,7 +18250,7 @@ "queueIds": { "target": "com.amazonaws.deadline#QueueIds", "traits": { - "smithy.api#documentation": "

One to 10 queue IDs that specify the queues to return statistics for. If you specify the queueIds field, you can't specify the fleetIds field.

", + "smithy.api#documentation": "

One to 10 queue IDs that specify the queues to return statistics for. If you specify the\n queueIds field, you can't specify the fleetIds field.

", "smithy.api#length": { "min": 1, "max": 10 @@ -18280,7 +18260,7 @@ "fleetIds": { "target": "com.amazonaws.deadline#FleetIds", "traits": { - "smithy.api#documentation": "

One to 10 fleet IDs that specify the fleets to return statistics for. If you specify the fleetIds field, you can't specify the queueIds field.

", + "smithy.api#documentation": "

One to 10 fleet IDs that specify the fleets to return statistics for. If you specify the\n fleetIds field, you can't specify the queueIds field.

", "smithy.api#length": { "min": 1, "max": 10 @@ -18289,7 +18269,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the fleet IDs or queue IDs to return statistics. You can specify only fleet IDs or queue IDS, not both.

" + "smithy.api#documentation": "

Specifies the fleet IDs or queue IDs to return statistics. You can specify only fleet\n IDs or queue IDS, not both.

" } }, "com.amazonaws.deadline#SortOrder": { @@ -18342,7 +18322,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "

Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. You can only have one running aggregation for your Deadline Cloud farm. Call the GetSessionsStatisticsAggregation operation and check the status field to see if an aggregation is running. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.

", + "smithy.api#documentation": "

Starts an asynchronous request for getting aggregated statistics about queues and farms.\n Get the statistics using the GetSessionsStatisticsAggregation operation. You\n can only have one running aggregation for your Deadline Cloud farm. Call the\n GetSessionsStatisticsAggregation operation and check the\n status field to see if an aggregation is running. Statistics are available\n for 1 hour after you call the StartSessionsStatisticsAggregation\n operation.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -18360,7 +18340,7 @@ "farmId": { "target": "com.amazonaws.deadline#FarmId", "traits": { - "smithy.api#documentation": "

The identifier of the farm that contains queues or fleets to return statistics for.

", + "smithy.api#documentation": "

The identifier of the farm that contains queues or fleets to return statistics\n for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18425,7 +18405,7 @@ "aggregationId": { "target": "com.amazonaws.deadline#AggregationId", "traits": { - "smithy.api#documentation": "

A unique identifier for the aggregated statistics. Use this identifier with the GetAggregatedStatisticsForSessions operation to return the statistics.

", + "smithy.api#documentation": "

A unique identifier for the aggregated statistics. Use this identifier with the\n GetAggregatedStatisticsForSessions operation to return the\n statistics.

", "smithy.api#required": {} } } @@ -18507,7 +18487,7 @@ "costInUsd": { "target": "com.amazonaws.deadline#Stats", "traits": { - "smithy.api#documentation": "

How the statistics should appear in USD. Options include: minimum, maximum, average or sum.

", + "smithy.api#documentation": "

How the statistics should appear in USD. Options include: minimum, maximum, average or\n sum.

", "smithy.api#required": {} } }, @@ -19021,7 +19001,7 @@ "taskRunStatus": { "target": "com.amazonaws.deadline#TaskRunStatus", "traits": { - "smithy.api#documentation": "

The task run status for the job.

  • PENDING–pending and waiting for resources.

  • READY–ready to be processed.

  • ASSIGNED–assigned and will run next on a worker.

  • SCHEDULED–scheduled to be run on a worker.

  • INTERRUPTING–being interrupted.

  • RUNNING–running on a worker.

  • SUSPENDED–the task is suspended.

  • CANCELED–the task has been canceled.

  • FAILED–the task has failed.

  • SUCCEEDED–the task has succeeded.

" + "smithy.api#documentation": "

The task run status for the job.

\n
    \n
  • \n

    \n PENDING–pending and waiting for resources.

    \n
  • \n
  • \n

    \n READY–ready to be processed.

    \n
  • \n
  • \n

    \n ASSIGNED–assigned and will run next on a worker.

    \n
  • \n
  • \n

    \n SCHEDULED–scheduled to be run on a worker.

    \n
  • \n
  • \n

    \n INTERRUPTING–being interrupted.

    \n
  • \n
  • \n

    \n RUNNING–running on a worker.

    \n
  • \n
  • \n

    \n SUSPENDED–the task is suspended.

    \n
  • \n
  • \n

    \n CANCELED–the task has been canceled.

    \n
  • \n
  • \n

    \n FAILED–the task has failed.

    \n
  • \n
  • \n

    \n SUCCEEDED–the task has succeeded.

    \n
  • \n
" } }, "targetTaskRunStatus": { @@ -19128,7 +19108,7 @@ "taskRunStatus": { "target": "com.amazonaws.deadline#TaskRunStatus", "traits": { - "smithy.api#documentation": "

The task run status for the job.

  • PENDING–pending and waiting for resources.

  • READY–ready to process.

  • ASSIGNED–assigned and will run next on a worker.

  • SCHEDULED–scheduled to run on a worker.

  • INTERRUPTING–being interrupted.

  • RUNNING–running on a worker.

  • SUSPENDED–the task is suspended.

  • CANCELED–the task has been canceled.

  • FAILED–the task has failed.

  • SUCCEEDED–the task has succeeded.

", + "smithy.api#documentation": "

The task run status for the job.

\n
    \n
  • \n

    \n PENDING–pending and waiting for resources.

    \n
  • \n
  • \n

    \n READY–ready to process.

    \n
  • \n
  • \n

    \n ASSIGNED–assigned and will run next on a worker.

    \n
  • \n
  • \n

    \n SCHEDULED–scheduled to run on a worker.

    \n
  • \n
  • \n

    \n INTERRUPTING–being interrupted.

    \n
  • \n
  • \n

    \n RUNNING–running on a worker.

    \n
  • \n
  • \n

    \n SUSPENDED–the task is suspended.

    \n
  • \n
  • \n

    \n CANCELED–the task has been canceled.

    \n
  • \n
  • \n

    \n FAILED–the task has failed.

    \n
  • \n
  • \n

    \n SUCCEEDED–the task has succeeded.

    \n
  • \n
", "smithy.api#required": {} } }, @@ -19289,7 +19269,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the storage profile summary to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

", + "smithy.api#documentation": "

The display name of the storage profile summary to update.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
", "smithy.api#required": {} } }, @@ -20349,19 +20329,19 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the budget to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The display name of the budget to update.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "description": { "target": "com.amazonaws.deadline#Description", "traits": { - "smithy.api#documentation": "

The description of the budget to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the budget to update.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "status": { "target": "com.amazonaws.deadline#BudgetStatus", "traits": { - "smithy.api#documentation": "

Updates the status of the budget.

  • ACTIVE–The budget is being evaluated.

  • INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

" + "smithy.api#documentation": "

Updates the status of the budget.

\n
    \n
  • \n

    \n ACTIVE–The budget is being evaluated.

    \n
  • \n
  • \n

    \n INACTIVE–The budget is inactive. This can include Expired,\n Canceled, or deleted Deleted statuses.

    \n
  • \n
" } }, "approximateDollarLimit": { @@ -20373,7 +20353,7 @@ "actionsToAdd": { "target": "com.amazonaws.deadline#BudgetActionsToAdd", "traits": { - "smithy.api#documentation": "

The budget actions to add. Budget actions specify what happens when the budget runs out.

" + "smithy.api#documentation": "

The budget actions to add. Budget actions specify what happens when the budget runs\n out.

" } }, "actionsToRemove": { @@ -20459,13 +20439,13 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the farm to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The display name of the farm to update.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "description": { "target": "com.amazonaws.deadline#Description", "traits": { - "smithy.api#documentation": "

The description of the farm to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the farm to update.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } } }, @@ -20562,13 +20542,13 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the fleet to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The display name of the fleet to update.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "description": { "target": "com.amazonaws.deadline#Description", "traits": { - "smithy.api#documentation": "

The description of the fleet to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the fleet to update.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "roleArn": { @@ -20586,7 +20566,7 @@ "maxWorkerCount": { "target": "com.amazonaws.deadline#MinZeroMaxInteger", "traits": { - "smithy.api#documentation": "

The maximum number of workers in the fleet.

Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.

" + "smithy.api#documentation": "

The maximum number of workers in the fleet.

\n

Deadline Cloud limits the number of workers to less than or equal to the fleet's\n maximum worker count. The service maintains eventual consistency for the worker count. If\n you make multiple rapid calls to CreateWorker before the field updates, you\n might exceed your fleet's maximum worker count. For example, if your\n maxWorkerCount is 10 and you currently have 9 workers, making two quick\n CreateWorker calls might successfully create 2 workers instead of 1,\n resulting in 11 total workers.

" } }, "configuration": { @@ -20598,7 +20578,7 @@ "hostConfiguration": { "target": "com.amazonaws.deadline#HostConfiguration", "traits": { - "smithy.api#documentation": "

Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

" + "smithy.api#documentation": "

Provides a script that runs as a worker is starting up that you can use to provide\n additional configuration for workers in your fleet.

" } } }, @@ -20655,7 +20635,7 @@ } } }, - "smithy.api#documentation": "

Updates a job.

When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.

An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.

", + "smithy.api#documentation": "

Updates a job.

\n

When you change the status of the job to ARCHIVED, the job can't be\n scheduled or archived.

\n \n

An archived jobs and its steps and tasks are deleted after 120 days. The job can't be\n recovered.

\n
", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -20716,13 +20696,13 @@ "lifecycleStatus": { "target": "com.amazonaws.deadline#UpdateJobLifecycleStatus", "traits": { - "smithy.api#documentation": "

The status of a job in its lifecycle. When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.

An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.

" + "smithy.api#documentation": "

The status of a job in its lifecycle. When you change the status of the job to\n ARCHIVED, the job can't be scheduled or archived.

\n \n

An archived jobs and its steps and tasks are deleted after 120 days. The job can't be\n recovered.

\n
" } }, "maxWorkerCount": { "target": "com.amazonaws.deadline#MaxWorkerCount", "traits": { - "smithy.api#documentation": "

The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.

You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.

If you don't specify the maxWorkerCount, the default is -1.

The maximum number of workers that can process tasks in the job.

" + "smithy.api#documentation": "

The maximum number of worker hosts that can concurrently process a job. When the\n maxWorkerCount is reached, no more workers will be assigned to process the\n job, even if the fleets assigned to the job's queue has available workers.

\n

You can't set the maxWorkerCount to 0. If you set it to -1, there is no\n maximum number of workers.

\n

If you don't specify the maxWorkerCount, the default is -1.

\n

The maximum number of workers that can process tasks in the job.

" } }, "farmId": { @@ -20828,19 +20808,19 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The new display name of the limit.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The new display name of the limit.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "description": { "target": "com.amazonaws.deadline#Description", "traits": { - "smithy.api#documentation": "

The new description of the limit.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The new description of the limit.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "maxCount": { "target": "com.amazonaws.deadline#MaxCount", "traits": { - "smithy.api#documentation": "

The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.

If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number.

The maxCount must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.

" + "smithy.api#documentation": "

The maximum number of resources constrained by this limit. When all of the resources are\n in use, steps that require the limit won't be scheduled until the resource is\n available.

\n

If more than the new maximum number is currently in use, running jobs finish but no new\n jobs are started until the number of resources in use is below the new maximum\n number.

\n

The maxCount must not be 0. If the value is -1, there is no restriction on\n the number of resources that can be acquired for this limit.

" } } }, @@ -20891,7 +20871,7 @@ "iam:PassRole" ] }, - "smithy.api#documentation": "

Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.

", + "smithy.api#documentation": "

Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings\n when you call UpdateMonitor.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -20923,7 +20903,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The new value to use for the monitor's display name.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The new value to use for the monitor's display name.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "roleArn": { @@ -21254,7 +21234,7 @@ "identitystore:ListGroupMembershipsForMember" ] }, - "smithy.api#documentation": "

Updates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE* values, there will be a delay before the status transitions to the STOPPED state.

", + "smithy.api#documentation": "

Updates the status of the queue. If you set the status to one of the\n STOP_LIMIT_USAGE* values, there will be a delay before the status\n transitions to the STOPPED state.

", "smithy.api#endpoint": { "hostPrefix": "management." }, @@ -21296,7 +21276,7 @@ "status": { "target": "com.amazonaws.deadline#UpdateQueueLimitAssociationStatus", "traits": { - "smithy.api#documentation": "

Sets the status of the limit. You can mark the limit active, or you can stop usage of the limit and either complete existing tasks or cancel any existing tasks immediately.

", + "smithy.api#documentation": "

Sets the status of the limit. You can mark the limit active, or you can stop usage of\n the limit and either complete existing tasks or cancel any existing tasks immediately.\n

", "smithy.api#required": {} } } @@ -21373,13 +21353,13 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the queue to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The display name of the queue to update.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "description": { "target": "com.amazonaws.deadline#Description", "traits": { - "smithy.api#documentation": "

The description of the queue to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The description of the queue to update.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "defaultBudgetAction": { @@ -21391,7 +21371,7 @@ "jobAttachmentSettings": { "target": "com.amazonaws.deadline#JobAttachmentSettings", "traits": { - "smithy.api#documentation": "

The job attachment settings to update for the queue.

" + "smithy.api#documentation": "

The job attachment settings to update for the\n queue.

" } }, "roleArn": { @@ -21748,7 +21728,7 @@ "displayName": { "target": "com.amazonaws.deadline#ResourceName", "traits": { - "smithy.api#documentation": "

The display name of the storage profile to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

" + "smithy.api#documentation": "

The display name of the storage profile to update.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n
" } }, "osFamily": { @@ -22015,7 +21995,7 @@ "hostConfiguration": { "target": "com.amazonaws.deadline#HostConfiguration", "traits": { - "smithy.api#documentation": "

The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

" + "smithy.api#documentation": "

The script that runs as a worker is starting up that you can use to provide additional\n configuration for workers in your fleet.

" } } }, @@ -22173,7 +22153,7 @@ "processExitCode": { "target": "com.amazonaws.deadline#ProcessExitCode", "traits": { - "smithy.api#documentation": "

The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.

" + "smithy.api#documentation": "

The process exit code. The default Deadline Cloud worker agent converts unsigned\n 32-bit exit codes to signed 32-bit exit codes.

" } }, "progressMessage": { @@ -22212,12 +22192,12 @@ "manifests": { "target": "com.amazonaws.deadline#TaskRunManifestPropertiesListRequest", "traits": { - "smithy.api#documentation": "

A list of output manifest properties reported by the worker agent, with each entry corresponding to a manifest property in the job.

" + "smithy.api#documentation": "

A list of output manifest properties reported by the worker\n agent, with each entry corresponding to a manifest property in the job.

" } } }, "traits": { - "smithy.api#documentation": "

The updated session action information as it relates to completion and progress of the session.

" + "smithy.api#documentation": "

The updated session action information as it relates to completion and progress of the\n session.

" } }, "com.amazonaws.deadline#UpdatedSessionActions": { @@ -22457,7 +22437,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

", + "smithy.api#documentation": "

The request isn't valid. This can occur if your request contains malformed JSON or\n unsupported characters.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/codegen/sdk/aws-models/detective.json b/codegen/sdk/aws-models/detective.json index f503ae133de..70c572b9699 100644 --- a/codegen/sdk/aws-models/detective.json +++ b/codegen/sdk/aws-models/detective.json @@ -1052,17 +1052,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1076,17 +1065,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1100,17 +1078,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1124,17 +1091,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1148,17 +1104,6 @@ "UseDualStack": false } }, - { - "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": { @@ -1172,17 +1117,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1197,49 +1131,53 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://api.detective-fips.us-isof-south-1.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective-fips.us-isof-south-1.csp.hci.ic.gov" + "url": "https://api.detective.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://api.detective-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.detective.us-isof-south-1.csp.hci.ic.gov" + "url": "https://api.detective.eusc-de-east-1.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } diff --git a/codegen/sdk/aws-models/device-farm.json b/codegen/sdk/aws-models/device-farm.json index 5fee72a5628..c990a6c6277 100644 --- a/codegen/sdk/aws-models/device-farm.json +++ b/codegen/sdk/aws-models/device-farm.json @@ -2849,17 +2849,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2873,17 +2862,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2897,17 +2875,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2921,17 +2888,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/devops-guru.json b/codegen/sdk/aws-models/devops-guru.json index 8abb9b615e9..bc6e00e58e9 100644 --- a/codegen/sdk/aws-models/devops-guru.json +++ b/codegen/sdk/aws-models/devops-guru.json @@ -1170,17 +1170,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1194,17 +1183,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1218,17 +1196,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1242,17 +1209,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/direct-connect.json b/codegen/sdk/aws-models/direct-connect.json index 9facc50c825..037228e03e5 100644 --- a/codegen/sdk/aws-models/direct-connect.json +++ b/codegen/sdk/aws-models/direct-connect.json @@ -759,7 +759,13 @@ "target": "com.amazonaws.directconnect#ASN", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

" + "smithy.api#documentation": "

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
" + } + }, + "asnLong": { + "target": "com.amazonaws.directconnect#LongAsn", + "traits": { + "smithy.api#documentation": "

The long ASN for the BGP peer. The valid range is from 1 to 4294967294 for BGP configuration.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
" } }, "authKey": { @@ -1395,6 +1401,12 @@ "traits": { "smithy.api#documentation": "

The connections.

" } + }, + "nextToken": { + "target": "com.amazonaws.directconnect#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + } } } }, @@ -2146,7 +2158,13 @@ "target": "com.amazonaws.directconnect#ASN", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

" + "smithy.api#documentation": "

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
" + } + }, + "asnLong": { + "target": "com.amazonaws.directconnect#LongAsn", + "traits": { + "smithy.api#documentation": "

The long ASN for the BGP peer to be deleted from a Direct Connect virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
" } }, "customerAddress": { @@ -2658,6 +2676,18 @@ "traits": { "smithy.api#documentation": "

The ID of the connection.

" } + }, + "maxResults": { + "target": "com.amazonaws.directconnect#MaxResultSetSize", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

\n

If MaxResults is given a value larger than 100, only 100 results are\n returned.

" + } + }, + "nextToken": { + "target": "com.amazonaws.directconnect#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } } }, "traits": { @@ -3033,6 +3063,18 @@ "smithy.api#documentation": "

The ID of the interconnect or LAG.

", "smithy.api#required": {} } + }, + "maxResults": { + "target": "com.amazonaws.directconnect#MaxResultSetSize", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

\n

If MaxResults is given a value larger than 100, only 100 results are\n returned.

" + } + }, + "nextToken": { + "target": "com.amazonaws.directconnect#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } } }, "traits": { @@ -3129,6 +3171,18 @@ "traits": { "smithy.api#documentation": "

The ID of the interconnect.

" } + }, + "maxResults": { + "target": "com.amazonaws.directconnect#MaxResultSetSize", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

\n

If MaxResults is given a value larger than 100, only 100 results are\n returned.

" + } + }, + "nextToken": { + "target": "com.amazonaws.directconnect#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } } }, "traits": { @@ -3163,6 +3217,18 @@ "traits": { "smithy.api#documentation": "

The ID of the LAG.

" } + }, + "maxResults": { + "target": "com.amazonaws.directconnect#MaxResultSetSize", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

\n

If MaxResults is given a value larger than 100, only 100 results are\n returned.

" + } + }, + "nextToken": { + "target": "com.amazonaws.directconnect#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } } }, "traits": { @@ -3396,7 +3462,7 @@ } ], "traits": { - "smithy.api#documentation": "

Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer\n than 15 minutes before you make the request are also returned. If you specify a\n connection ID, only the virtual interfaces associated with the connection are returned.\n If you specify a virtual interface ID, then only a single virtual interface is returned.

\n

A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.

" + "smithy.api#documentation": "

Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer\n than 15 minutes before you make the request are also returned. If you specify a\n connection ID, only the virtual interfaces associated with the connection are returned.\n If you specify a virtual interface ID, then only a single virtual interface is returned.

\n

A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.

\n
    \n
  • \n

    If you're using an asn, the response includes ASN value in both the asn and asnLong fields.

    \n
  • \n
  • \n

    If you're using asnLong, the response returns a value of 0 (zero) for the asn attribute because it exceeds the highest ASN value of 2,147,483,647 that it can support

    \n
  • \n
" } }, "com.amazonaws.directconnect#DescribeVirtualInterfacesRequest": { @@ -3413,6 +3479,18 @@ "traits": { "smithy.api#documentation": "

The ID of the virtual interface.

" } + }, + "maxResults": { + "target": "com.amazonaws.directconnect#MaxResultSetSize", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

\n

If MaxResults is given a value larger than 100, only 100 results are\n returned.

" + } + }, + "nextToken": { + "target": "com.amazonaws.directconnect#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } } }, "traits": { @@ -3449,7 +3527,7 @@ "amazonSideAsn": { "target": "com.amazonaws.directconnect#LongAsn", "traits": { - "smithy.api#documentation": "

The autonomous system number (ASN) for the Amazon side of the connection.

" + "smithy.api#documentation": "

The autonomous system number (AS) for the Amazon side of the connection.

" } }, "ownerAccount": { @@ -4203,6 +4281,12 @@ "traits": { "smithy.api#documentation": "

The interconnects.

" } + }, + "nextToken": { + "target": "com.amazonaws.directconnect#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + } } } }, @@ -4413,6 +4497,12 @@ "traits": { "smithy.api#documentation": "

The LAGs.

" } + }, + "nextToken": { + "target": "com.amazonaws.directconnect#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + } } } }, @@ -4661,7 +4751,13 @@ "target": "com.amazonaws.directconnect#ASN", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

" + "smithy.api#documentation": "

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

" + } + }, + "asnLong": { + "target": "com.amazonaws.directconnect#LongAsn", + "traits": { + "smithy.api#documentation": "

The long ASN for a new BGP peer. The valid range is from 1 to 4294967294.

" } }, "authKey": { @@ -4715,8 +4811,13 @@ "target": "com.amazonaws.directconnect#ASN", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

The valid values are 1-2147483647.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
\n

The valid values are 1-2147483646.

" + } + }, + "asnLong": { + "target": "com.amazonaws.directconnect#LongAsn", + "traits": { + "smithy.api#documentation": "

The long ASN for a new private virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
" } }, "mtu": { @@ -4800,8 +4901,13 @@ "target": "com.amazonaws.directconnect#ASN", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

The valid values are 1-2147483647.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
\n

The valid values are 1-2147483646.

" + } + }, + "asnLong": { + "target": "com.amazonaws.directconnect#LongAsn", + "traits": { + "smithy.api#documentation": "

The ASN when allocating a new private virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
" } }, "mtu": { @@ -4867,8 +4973,13 @@ "target": "com.amazonaws.directconnect#ASN", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

The valid values are 1-2147483647.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
" + } + }, + "asnLong": { + "target": "com.amazonaws.directconnect#LongAsn", + "traits": { + "smithy.api#documentation": "

The long ASN for a new public virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
" } }, "authKey": { @@ -4934,8 +5045,13 @@ "target": "com.amazonaws.directconnect#ASN", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

The valid values are 1-2147483647.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
\n

The valid values are 1-2147483646.

" + } + }, + "asnLong": { + "target": "com.amazonaws.directconnect#LongAsn", + "traits": { + "smithy.api#documentation": "

The ASN when allocating a new public virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
" } }, "authKey": { @@ -4999,7 +5115,13 @@ "target": "com.amazonaws.directconnect#ASN", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

The valid values are 1-2147483647.

" + "smithy.api#documentation": "

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
" + } + }, + "asnLong": { + "target": "com.amazonaws.directconnect#LongAsn", + "traits": { + "smithy.api#documentation": "

The long ASN for a new transit virtual interface.The valid range is from 1 to 4294967294 for BGP configuration.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
" } }, "mtu": { @@ -5075,7 +5197,13 @@ "target": "com.amazonaws.directconnect#ASN", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

The valid values are 1-2147483647.

" + "smithy.api#documentation": "

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
\n

The valid values are 1-2147483646.

" + } + }, + "asnLong": { + "target": "com.amazonaws.directconnect#LongAsn", + "traits": { + "smithy.api#documentation": "

The ASN when allocating a new transit virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
" } }, "mtu": { @@ -6190,17 +6318,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6214,17 +6331,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -6238,17 +6344,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6262,17 +6357,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -7174,13 +7258,19 @@ "target": "com.amazonaws.directconnect#ASN", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

The valid values are 1-2147483647.

" + "smithy.api#documentation": "

The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use asnLong instead.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
" + } + }, + "asnLong": { + "target": "com.amazonaws.directconnect#LongAsn", + "traits": { + "smithy.api#documentation": "

The long ASN for the virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.

\n \n

You can use asnLong or asn, but not both. We recommend using asnLong as it supports a greater pool of numbers.

\n
    \n
  • \n

    The asnLong attribute accepts both ASN and long ASN\n ranges.

    \n
  • \n
  • \n

    If you provide a value in the same API call for both asn\n and asnLong, the API will only accept the value for\n asnLong.

    \n
  • \n
\n
" } }, "amazonSideAsn": { "target": "com.amazonaws.directconnect#LongAsn", "traits": { - "smithy.api#documentation": "

The autonomous system number (ASN) for the Amazon side of the connection.

" + "smithy.api#documentation": "

The autonomous system number (AS) for the Amazon side of the connection.

" } }, "authKey": { @@ -7443,6 +7533,12 @@ "traits": { "smithy.api#documentation": "

The virtual interfaces

" } + }, + "nextToken": { + "target": "com.amazonaws.directconnect#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + } } } }, diff --git a/codegen/sdk/aws-models/directory-service-data.json b/codegen/sdk/aws-models/directory-service-data.json index fcc5c4eef66..fb50b036ae8 100644 --- a/codegen/sdk/aws-models/directory-service-data.json +++ b/codegen/sdk/aws-models/directory-service-data.json @@ -1651,17 +1651,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1675,17 +1664,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1699,17 +1677,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1723,17 +1690,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/directory-service.json b/codegen/sdk/aws-models/directory-service.json index 447af2bc577..db3bdab922f 100644 --- a/codegen/sdk/aws-models/directory-service.json +++ b/codegen/sdk/aws-models/directory-service.json @@ -198,7 +198,7 @@ "target": "com.amazonaws.directoryservice#UpdateSecurityGroupForDirectoryControllers", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If set to true, updates the inbound and outbound rules of the security group that has\n the description: \"Amazon Web Services created security group for directory ID\n directory controllers.\" Following are the new rules:

\n

Inbound:

\n
    \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source:\n Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source:\n Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: DNS (UDP), Protocol: UDP, Range: 53, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: DNS (TCP), Protocol: TCP, Range: 53, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: LDAP, Protocol: TCP, Range: 389, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: All ICMP, Protocol: All, Range: N/A, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
\n

\n

Outbound:

\n
    \n
  • \n

    Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0

    \n
  • \n
\n

These security rules impact an internal network interface that is not exposed\n publicly.

" + "smithy.api#documentation": "

If set to true, updates the inbound and outbound rules of the security group that has\n the description: \"Amazon Web Services created security group for directory ID\n directory controllers.\" Following are the new rules:

\n

Inbound:

\n
    \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: Managed Microsoft AD VPC IPv4\n CIDR

    \n
  • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: Managed Microsoft AD VPC IPv4\n CIDR

    \n
  • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: Managed Microsoft AD VPC IPv4\n CIDR

    \n
  • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: Managed Microsoft AD VPC IPv4\n CIDR

    \n
  • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: Managed Microsoft AD VPC IPv4\n CIDR

    \n
  • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: Managed Microsoft AD VPC IPv4\n CIDR

    \n
  • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: Managed Microsoft AD VPC IPv4\n CIDR

    \n
  • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: Managed Microsoft AD VPC IPv4\n CIDR

    \n
  • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: Managed Microsoft AD VPC IPv4\n CIDR

    \n
  • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: Managed Microsoft AD VPC IPv4\n CIDR

    \n
  • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: Managed Microsoft AD VPC IPv4\n CIDR

    \n
  • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: Managed Microsoft AD VPC\n IPv4 CIDR

    \n
  • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: Managed Microsoft AD VPC\n IPv4 CIDR

    \n
  • \n
  • \n

    Type: DNS (UDP), Protocol: UDP, Range: 53, Source: Managed Microsoft AD VPC IPv4\n CIDR

    \n
  • \n
  • \n

    Type: DNS (TCP), Protocol: TCP, Range: 53, Source: Managed Microsoft AD VPC IPv4\n CIDR

    \n
  • \n
  • \n

    Type: LDAP, Protocol: TCP, Range: 389, Source: Managed Microsoft AD VPC IPv4 CIDR

    \n
  • \n
  • \n

    Type: All ICMP, Protocol: All, Range: N/A, Source: Managed Microsoft AD VPC IPv4\n CIDR

    \n
  • \n
\n

\n

Outbound:

\n
    \n
  • \n

    Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0

    \n
  • \n
\n

These security rules impact an internal network interface that is not exposed\n publicly.

" } } }, @@ -804,6 +804,50 @@ "target": "com.amazonaws.directoryservice#AvailabilityZone" } }, + "com.amazonaws.directoryservice#CaEnrollmentPolicyStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabling" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + }, + "IMPAIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Impaired" + } + } + } + }, + "com.amazonaws.directoryservice#CaEnrollmentPolicyStatusReason": { + "type": "string" + }, "com.amazonaws.directoryservice#CancelSchemaExtension": { "type": "operation", "input": { @@ -1124,6 +1168,18 @@ "target": "com.amazonaws.directoryservice#CidrIp" } }, + "com.amazonaws.directoryservice#CidrIpv6": { + "type": "string", + "traits": { + "smithy.api#pattern": "^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){1,7}:)|(([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2})|(([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3})|(([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4})|(([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5})|([0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))|(:((:[0-9a-fA-F]{1,4}){1,7}|:)))\\/(12[0-8]|1[01][0-9]|[1-9]?[0-9])$" + } + }, + "com.amazonaws.directoryservice#CidrIpv6s": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservice#CidrIpv6" + } + }, "com.amazonaws.directoryservice#ClientAuthenticationSettingInfo": { "type": "structure", "members": { @@ -1286,6 +1342,12 @@ "smithy.api#documentation": "

The IP addresses of the remote DNS server associated with RemoteDomainName. This is the\n IP address of the DNS server that your conditional forwarder points to.

" } }, + "DnsIpv6Addrs": { + "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses of the remote DNS server associated with RemoteDomainName. This is the\n IPv6 address of the DNS server that your conditional forwarder points to.

" + } + }, "ReplicationScope": { "target": "com.amazonaws.directoryservice#ReplicationScope", "traits": { @@ -1404,6 +1466,12 @@ "traits": { "smithy.api#documentation": "

The tags to be assigned to AD Connector.

" } + }, + "NetworkType": { + "target": "com.amazonaws.directoryservice#NetworkType", + "traits": { + "smithy.api#documentation": "

The network type for your directory. The default value is IPv4 or\n IPv6 based on the provided subnet capabilities.

" + } } }, "traits": { @@ -1727,8 +1795,15 @@ "DnsIpAddrs": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { - "smithy.api#documentation": "

The IP addresses of the remote DNS server associated with RemoteDomainName.

", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": [], + "smithy.api#documentation": "

The IP addresses of the remote DNS server associated with RemoteDomainName.

" + } + }, + "DnsIpv6Addrs": { + "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses of the remote DNS server associated with RemoteDomainName.

" } } }, @@ -1841,6 +1916,12 @@ "traits": { "smithy.api#documentation": "

The tags to be assigned to the Simple AD directory.

" } + }, + "NetworkType": { + "target": "com.amazonaws.directoryservice#NetworkType", + "traits": { + "smithy.api#documentation": "

The network type for your directory. Simple AD supports IPv4 and Dual-stack only.

" + } } }, "traits": { @@ -2099,6 +2180,12 @@ "traits": { "smithy.api#documentation": "

The tags to be assigned to the Managed Microsoft AD directory.

" } + }, + "NetworkType": { + "target": "com.amazonaws.directoryservice#NetworkType", + "traits": { + "smithy.api#documentation": "

\n The network type for your domain. The default value is IPv4 or IPv6\n based on the provided subnet capabilities.

" + } } }, "traits": { @@ -2306,6 +2393,12 @@ "smithy.api#documentation": "

The IP addresses of the remote DNS server associated with RemoteDomainName.

" } }, + "ConditionalForwarderIpv6Addrs": { + "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses of the remote DNS server associated with RemoteDomainName.

" + } + }, "SelectiveAuth": { "target": "com.amazonaws.directoryservice#SelectiveAuth", "traits": { @@ -2999,6 +3092,87 @@ "smithy.api#output": {} } }, + "com.amazonaws.directoryservice#DescribeCAEnrollmentPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservice#DescribeCAEnrollmentPolicyRequest" + }, + "output": { + "target": "com.amazonaws.directoryservice#DescribeCAEnrollmentPolicyResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservice#ClientException" + }, + { + "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#ServiceException" + }, + { + "target": "com.amazonaws.directoryservice#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves detailed information about the certificate authority (CA) enrollment policy for\n the specified directory. This policy determines how client certificates are automatically enrolled and\n managed through Amazon Web Services Private Certificate Authority.

" + } + }, + "com.amazonaws.directoryservice#DescribeCAEnrollmentPolicyRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory for which to retrieve the CA enrollment policy\n information.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the inputs for the DescribeCAEnrollmentPolicy operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservice#DescribeCAEnrollmentPolicyResult": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory associated with this CA enrollment policy.

" + } + }, + "PcaConnectorArn": { + "target": "com.amazonaws.directoryservice#PcaConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Private Certificate Authority (PCA) connector\n that is configured for automatic certificate enrollment in this directory.

" + } + }, + "CaEnrollmentPolicyStatus": { + "target": "com.amazonaws.directoryservice#CaEnrollmentPolicyStatus", + "traits": { + "smithy.api#documentation": "

The current status of the CA enrollment policy. This indicates if automatic certificate\n enrollment is currently active, inactive, or in a transitional state.

\n

Valid values:

\n
    \n
  • \n

    \n IN_PROGRESS - The policy is being activated T

    \n
  • \n
  • \n

    \n SUCCESS - The policy is active and automatic certificate enrollment is\n operational

    \n
  • \n
  • \n

    \n FAILED - The policy activation or deactivation failed

    \n
  • \n
  • \n

    \n DISABLING - The policy is being deactivated

    \n
  • \n
  • \n

    \n DISABLED - The policy is inactive and automatic certificate enrollment is\n not available

    \n
  • \n
  • \n

    \n IMPAIRED - Network connectivity is impaired.

    \n
  • \n
" + } + }, + "LastUpdatedDateTime": { + "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", + "traits": { + "smithy.api#documentation": "

The date and time when the CA enrollment policy was last modified or updated.

" + } + }, + "CaEnrollmentPolicyStatusReason": { + "target": "com.amazonaws.directoryservice#CaEnrollmentPolicyStatusReason", + "traits": { + "smithy.api#documentation": "

Additional information explaining the current status of the CA enrollment policy,\n particularly useful when the policy is in an error or transitional state.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of the DescribeCAEnrollmentPolicy operation.

", + "smithy.api#output": {} + } + }, "com.amazonaws.directoryservice#DescribeCertificate": { "type": "operation", "input": { @@ -3366,7 +3540,7 @@ "DirectoryDescriptions": { "target": "com.amazonaws.directoryservice#DirectoryDescriptions", "traits": { - "smithy.api#documentation": "

The list of available DirectoryDescription objects that were retrieved.

\n

It is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.

" + "smithy.api#documentation": "

The list of available DirectoryDescription objects that were\n retrieved.

\n

It is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.

" } }, "NextToken": { @@ -4548,8 +4722,15 @@ "CustomerDnsIps": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { - "smithy.api#documentation": "

A list of one or more IP addresses of DNS servers or domain controllers in your\n self-managed directory.

", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": [], + "smithy.api#documentation": "

The IP addresses of DNS servers or domain controllers in your\n self-managed directory.

" + } + }, + "CustomerDnsIpsV6": { + "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses of DNS servers or domain controllers in your\n self-managed directory.

" } }, "CustomerUserName": { @@ -4561,7 +4742,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information for the ConnectDirectory operation when an AD\n Connector directory is being created.

" + "smithy.api#documentation": "

Contains connection settings for creating an AD\n Connector with the ConnectDirectory action.

" } }, "com.amazonaws.directoryservice#DirectoryConnectSettingsDescription": { @@ -4594,7 +4775,7 @@ "AvailabilityZones": { "target": "com.amazonaws.directoryservice#AvailabilityZones", "traits": { - "smithy.api#documentation": "

A list of the Availability Zones that the directory is in.

" + "smithy.api#documentation": "

The Availability Zones that the directory is in.

" } }, "ConnectIps": { @@ -4602,6 +4783,12 @@ "traits": { "smithy.api#documentation": "

The IP addresses of the AD Connector servers.

" } + }, + "ConnectIpsV6": { + "target": "com.amazonaws.directoryservice#IpV6Addrs", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses of the AD Connector servers.

" + } } }, "traits": { @@ -4644,13 +4831,13 @@ "Alias": { "target": "com.amazonaws.directoryservice#AliasName", "traits": { - "smithy.api#documentation": "

The alias for the directory. If no alias has been created for the directory, the alias is\n the directory identifier, such as d-XXXXXXXXXX.

" + "smithy.api#documentation": "

The alias for the directory. If no alias exists, the alias is the directory identifier,\n such as d-XXXXXXXXXX.

" } }, "AccessUrl": { "target": "com.amazonaws.directoryservice#AccessUrl", "traits": { - "smithy.api#documentation": "

The access URL for the directory, such as\n http://.awsapps.com. If no alias has been created for the\n directory, is the directory identifier, such as\n d-XXXXXXXXXX.

" + "smithy.api#documentation": "

The access URL for the directory, such as\n http://.awsapps.com. If no alias exists,\n is the directory identifier, such as\n d-XXXXXXXXXX.

" } }, "Description": { @@ -4662,7 +4849,13 @@ "DnsIpAddrs": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { - "smithy.api#documentation": "

The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD\n directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers.\n For an AD Connector directory, these are the IP addresses of the DNS servers or domain\n controllers in your self-managed directory to which the AD Connector is connected.

" + "smithy.api#documentation": "

The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD\n directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers.\n For an AD Connector directory, these are the IP addresses of self-managed directory to which\n the AD Connector is connected.

" + } + }, + "DnsIpv6Addrs": { + "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD\n directory, these are the IPv6 addresses of the Simple AD or Microsoft AD directory servers.\n For an AD Connector directory, these are the IPv6 addresses of the DNS servers or domain\n controllers in your self-managed directory to which the AD Connector is connected.

" } }, "Stage": { @@ -4692,13 +4885,13 @@ "LaunchTime": { "target": "com.amazonaws.directoryservice#LaunchTime", "traits": { - "smithy.api#documentation": "

Specifies when the directory was created.

" + "smithy.api#documentation": "

The date and time when the directory was created.

" } }, "StageLastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { - "smithy.api#documentation": "

The date and time that the stage was last updated.

" + "smithy.api#documentation": "

The date and time when the stage was last updated.

" } }, "Type": { @@ -4710,19 +4903,19 @@ "VpcSettings": { "target": "com.amazonaws.directoryservice#DirectoryVpcSettingsDescription", "traits": { - "smithy.api#documentation": "

A DirectoryVpcSettingsDescription object that contains additional\n information about a directory. This member is only present if the directory is a Simple AD\n or Managed Microsoft AD directory.

" + "smithy.api#documentation": "

A DirectoryVpcSettingsDescription object that contains additional\n information about a directory. Present only for Simple AD and Managed Microsoft AD\n directories.

" } }, "ConnectSettings": { "target": "com.amazonaws.directoryservice#DirectoryConnectSettingsDescription", "traits": { - "smithy.api#documentation": "

A DirectoryConnectSettingsDescription object that contains additional\n information about an AD Connector directory. This member is only present if the directory is\n an AD Connector directory.

" + "smithy.api#documentation": "

\n DirectoryConnectSettingsDescription object that contains additional\n information about an AD Connector directory. Present only for AD Connector\n directories.

" } }, "RadiusSettings": { "target": "com.amazonaws.directoryservice#RadiusSettings", "traits": { - "smithy.api#documentation": "

A RadiusSettings object that contains information about the RADIUS\n server configured for this directory.

" + "smithy.api#documentation": "

Information about the RadiusSettings object configured for this\n directory.

" } }, "RadiusStatus": { @@ -4741,7 +4934,7 @@ "target": "com.amazonaws.directoryservice#SsoEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.

" + "smithy.api#documentation": "

Indicates whether single sign-on is enabled for the directory. For more information, see\n EnableSso and DisableSso.

" } }, "DesiredNumberOfDomainControllers": { @@ -4773,6 +4966,12 @@ "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.

" } + }, + "NetworkType": { + "target": "com.amazonaws.directoryservice#NetworkType", + "traits": { + "smithy.api#documentation": "

The network type of the directory.

" + } } }, "traits": { @@ -4817,6 +5016,12 @@ "traits": { "smithy.api#enumValue": "Standard" } + }, + "HYBRID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hybrid" + } } } }, @@ -5027,6 +5232,9 @@ { "target": "com.amazonaws.directoryservice#DescribeADAssessment" }, + { + "target": "com.amazonaws.directoryservice#DescribeCAEnrollmentPolicy" + }, { "target": "com.amazonaws.directoryservice#DescribeCertificate" }, @@ -5072,6 +5280,9 @@ { "target": "com.amazonaws.directoryservice#DescribeUpdateDirectory" }, + { + "target": "com.amazonaws.directoryservice#DisableCAEnrollmentPolicy" + }, { "target": "com.amazonaws.directoryservice#DisableClientAuthentication" }, @@ -5087,6 +5298,9 @@ { "target": "com.amazonaws.directoryservice#DisableSso" }, + { + "target": "com.amazonaws.directoryservice#EnableCAEnrollmentPolicy" + }, { "target": "com.amazonaws.directoryservice#EnableClientAuthentication" }, @@ -6041,17 +6255,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6065,17 +6268,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -6089,17 +6281,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6113,17 +6294,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -6209,6 +6379,20 @@ } } }, + "com.amazonaws.directoryservice#DirectorySizeUpdateSettings": { + "type": "structure", + "members": { + "DirectorySize": { + "target": "com.amazonaws.directoryservice#DirectorySize", + "traits": { + "smithy.api#documentation": "

The target directory size for the update operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the directory size configuration for update operations.

" + } + }, "com.amazonaws.directoryservice#DirectoryStage": { "type": "enum", "members": { @@ -6384,6 +6568,83 @@ "smithy.api#documentation": "

Contains information about the directory.

" } }, + "com.amazonaws.directoryservice#DisableAlreadyInProgressException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.directoryservice#ExceptionMessage" + }, + "RequestId": { + "target": "com.amazonaws.directoryservice#RequestId" + } + }, + "traits": { + "smithy.api#documentation": "

A disable operation for CA enrollment policy is already in progress for this directory.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.directoryservice#DisableCAEnrollmentPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservice#DisableCAEnrollmentPolicyRequest" + }, + "output": { + "target": "com.amazonaws.directoryservice#DisableCAEnrollmentPolicyResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservice#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservice#ClientException" + }, + { + "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservice#DisableAlreadyInProgressException" + }, + { + "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#InvalidParameterException" + }, + { + "target": "com.amazonaws.directoryservice#ServiceException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables the certificate authority (CA) enrollment policy for the specified directory. This stops\n automatic certificate enrollment and management for domain-joined clients, but does not affect\n existing certificates.

\n \n

Disabling the CA enrollment policy prevents new certificates from being automatically\n enrolled, but existing certificates remain valid and functional until they expire.

\n
" + } + }, + "com.amazonaws.directoryservice#DisableCAEnrollmentPolicyRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory for which to disable the CA enrollment policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the inputs for the DisableCAEnrollmentPolicy operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservice#DisableCAEnrollmentPolicyResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Contains the results of the DisableCAEnrollmentPolicy operation.

", + "smithy.api#output": {} + } + }, "com.amazonaws.directoryservice#DisableClientAuthentication": { "type": "operation", "input": { @@ -6477,7 +6738,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deactivates access to directory data via the Directory Service Data API for the specified\n directory. For\n more information, see Directory Service Data API Reference.

" + "smithy.api#documentation": "

Deactivates access to directory data via the Directory Service Data API for the specified directory. For\n more information, see Directory Service Data API Reference.

" } }, "com.amazonaws.directoryservice#DisableDirectoryDataAccessRequest": { @@ -6586,7 +6847,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In\n User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

", + "smithy.api#documentation": "

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User\n Service (RADIUS) server for an AD Connector or Microsoft AD directory.

", "smithy.api#examples": [ { "title": "To disable radius", @@ -6706,6 +6967,12 @@ "target": "com.amazonaws.directoryservice#IpAddr" } }, + "com.amazonaws.directoryservice#DnsIpv6Addrs": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservice#Ipv6Addr" + } + }, "com.amazonaws.directoryservice#DomainController": { "type": "structure", "members": { @@ -6727,6 +6994,12 @@ "smithy.api#documentation": "

The IP address of the domain controller.

" } }, + "DnsIpv6Addr": { + "target": "com.amazonaws.directoryservice#Ipv6Addr", + "traits": { + "smithy.api#documentation": "

The IPv6 address of the domain controller.

" + } + }, "VpcId": { "target": "com.amazonaws.directoryservice#VpcId", "traits": { @@ -6863,6 +7136,93 @@ "target": "com.amazonaws.directoryservice#DomainController" } }, + "com.amazonaws.directoryservice#EnableAlreadyInProgressException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.directoryservice#ExceptionMessage" + }, + "RequestId": { + "target": "com.amazonaws.directoryservice#RequestId" + } + }, + "traits": { + "smithy.api#documentation": "

An enable operation for CA enrollment policy is already in progress for this directory.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.directoryservice#EnableCAEnrollmentPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservice#EnableCAEnrollmentPolicyRequest" + }, + "output": { + "target": "com.amazonaws.directoryservice#EnableCAEnrollmentPolicyResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservice#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservice#ClientException" + }, + { + "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservice#EnableAlreadyInProgressException" + }, + { + "target": "com.amazonaws.directoryservice#EntityAlreadyExistsException" + }, + { + "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#InvalidParameterException" + }, + { + "target": "com.amazonaws.directoryservice#ServiceException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables certificate authority (CA) enrollment policy for the specified directory. This allows\n domain-joined clients to automatically request and receive certificates from the specified\n Amazon Web Services Private Certificate Authority.

\n \n

Before enabling CA enrollment, ensure that the PCA connector is properly configured and\n accessible from the directory. The connector must be in an active state and have the\n necessary permissions.

\n
" + } + }, + "com.amazonaws.directoryservice#EnableCAEnrollmentPolicyRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory for which to enable the CA enrollment policy.

", + "smithy.api#required": {} + } + }, + "PcaConnectorArn": { + "target": "com.amazonaws.directoryservice#PcaConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Private Certificate Authority (PCA) connector to use\n for automatic certificate enrollment. This connector must be properly configured and\n accessible from the directory.

\n

The ARN format is:\n arn:aws:pca-connector-ad:region:account-id:connector/connector-id\n \n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the inputs for the EnableCAEnrollmentPolicy operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservice#EnableCAEnrollmentPolicyResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Contains the results of the EnableCAEnrollmentPolicy operation.

", + "smithy.api#output": {} + } + }, "com.amazonaws.directoryservice#EnableClientAuthentication": { "type": "operation", "input": { @@ -7760,7 +8120,13 @@ "CidrIp": { "target": "com.amazonaws.directoryservice#CidrIp", "traits": { - "smithy.api#documentation": "

IP address block using CIDR format, for example 10.0.0.0/24. This is often the\n address block of the DNS server used for your self-managed domain. For a single IP address\n use a CIDR address block with /32. For example 10.0.0.0/32.

" + "smithy.api#documentation": "

IP address block in CIDR format, such as 10.0.0.0/24. This is often the address block of\n the DNS server used for your self-managed domain. For a single IP address, use a CIDR\n address block with /32. For example, 10.0.0.0/32.

" + } + }, + "CidrIpv6": { + "target": "com.amazonaws.directoryservice#CidrIpv6", + "traits": { + "smithy.api#documentation": "

IPv6 address block in CIDR format, such as 2001:db8::/32. This is often the address\n block of the DNS server used for your self-managed domain. For a single IPv6 address, use a\n CIDR address block with /128. For example, 2001:db8::1/128.

" } }, "Description": { @@ -7771,7 +8137,7 @@ } }, "traits": { - "smithy.api#documentation": "

IP address block. This is often the address block of the DNS server used for your\n self-managed domain.

" + "smithy.api#documentation": "

Contains the IP address block. This is often the address block of the DNS server used\n for your self-managed domain.

" } }, "com.amazonaws.directoryservice#IpRouteInfo": { @@ -7789,6 +8155,12 @@ "smithy.api#documentation": "

IP address block in the IpRoute.

" } }, + "CidrIpv6": { + "target": "com.amazonaws.directoryservice#CidrIpv6", + "traits": { + "smithy.api#documentation": "

IPv6 address block in the IpRoute.

" + } + }, "IpRouteStatusMsg": { "target": "com.amazonaws.directoryservice#IpRouteStatusMsg", "traits": { @@ -7889,6 +8261,18 @@ "target": "com.amazonaws.directoryservice#IpRouteInfo" } }, + "com.amazonaws.directoryservice#IpV6Addrs": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservice#Ipv6Addr" + } + }, + "com.amazonaws.directoryservice#Ipv6Addr": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$" + } + }, "com.amazonaws.directoryservice#LDAPSSettingInfo": { "type": "structure", "members": { @@ -8218,7 +8602,7 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

Identifier (ID) of the directory for which you want to retrieve the IP\n addresses.

", + "smithy.api#documentation": "

Identifier (ID) of the directory for which you want to retrieve the IP addresses.

", "smithy.api#required": {} } }, @@ -8231,7 +8615,7 @@ "Limit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { - "smithy.api#documentation": "

Maximum number of items to return. If this value is zero, the maximum number of items\n is specified by the limitations of the operation.

" + "smithy.api#documentation": "

Maximum number of items to return. If this value is zero, the maximum number of items is\n specified by the limitations of the operation.

" } } }, @@ -8587,6 +8971,49 @@ "smithy.api#default": false } }, + "com.amazonaws.directoryservice#NetworkType": { + "type": "enum", + "members": { + "DUAL_STACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Dual-stack" + } + }, + "IPV4_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPv4" + } + }, + "IPV6_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPv6" + } + } + } + }, + "com.amazonaws.directoryservice#NetworkUpdateSettings": { + "type": "structure", + "members": { + "NetworkType": { + "target": "com.amazonaws.directoryservice#NetworkType", + "traits": { + "smithy.api#documentation": "

The target network type for the directory update.

" + } + }, + "CustomerDnsIpsV6": { + "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", + "traits": { + "smithy.api#documentation": "

IPv6 addresses of DNS servers or domain controllers in the self-managed directory.\n Required only when updating an AD Connector directory.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the network configuration for directory update operations.

" + } + }, "com.amazonaws.directoryservice#NextToken": { "type": "string" }, @@ -8631,12 +9058,12 @@ "OSVersion": { "target": "com.amazonaws.directoryservice#OSVersion", "traits": { - "smithy.api#documentation": "

OS version that the directory needs to be updated to.

" + "smithy.api#documentation": "

OS version that the directory needs to be updated to.

" } } }, "traits": { - "smithy.api#documentation": "

OS version that the directory needs to be updated to.

" + "smithy.api#documentation": "

OS version that the directory needs to be updated to.

" } }, "com.amazonaws.directoryservice#OSVersion": { @@ -8701,6 +9128,12 @@ "smithy.api#documentation": "

IP address of the directory’s domain controllers.

" } }, + "DnsIpv6Addrs": { + "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", + "traits": { + "smithy.api#documentation": "

IPv6 addresses of the directory’s domain controllers.

" + } + }, "VpcSettings": { "target": "com.amazonaws.directoryservice#DirectoryVpcSettingsDescription", "traits": { @@ -8710,18 +9143,24 @@ "RadiusSettings": { "target": "com.amazonaws.directoryservice#RadiusSettings", "traits": { - "smithy.api#documentation": "

A RadiusSettings object that contains information about the RADIUS\n server.

" + "smithy.api#documentation": "

Information about the RadiusSettings object server configuration.

" } }, "RadiusStatus": { "target": "com.amazonaws.directoryservice#RadiusStatus", "traits": { - "smithy.api#documentation": "

Information about the status of the RADIUS server.

" + "smithy.api#documentation": "

The status of the RADIUS server.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.directoryservice#NetworkType", + "traits": { + "smithy.api#documentation": "

Network type of the directory in the directory owner account.

" } } }, "traits": { - "smithy.api#documentation": "

Describes the directory owner account details that have been shared to the directory\n consumer account.

" + "smithy.api#documentation": "

Contains the directory owner account details shared with the directory consumer\n account.

" } }, "com.amazonaws.directoryservice#PageLimit": { @@ -8740,6 +9179,12 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.directoryservice#PcaConnectorArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + } + }, "com.amazonaws.directoryservice#PortNumber": { "type": "integer", "traits": { @@ -8803,13 +9248,19 @@ "RadiusServers": { "target": "com.amazonaws.directoryservice#Servers", "traits": { - "smithy.api#documentation": "

An array of strings that contains the fully qualified domain name (FQDN) or IP\n addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server\n load balancer.

" + "smithy.api#documentation": "

The fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints,\n or the FQDN or IP addresses of your RADIUS server load balancer.

" + } + }, + "RadiusServersIpv6": { + "target": "com.amazonaws.directoryservice#Servers", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses of the RADIUS server endpoints or RADIUS server\n load balancer.

" } }, "RadiusPort": { "target": "com.amazonaws.directoryservice#PortNumber", "traits": { - "smithy.api#documentation": "

The port that your RADIUS server is using for communications. Your self-managed\n network must allow inbound traffic over this port from the Directory Service servers.

" + "smithy.api#documentation": "

The port that your RADIUS server is using for communications. Your self-managed network\n must allow inbound traffic over this port from the Directory Service servers.

" } }, "RadiusTimeout": { @@ -8822,7 +9273,7 @@ "target": "com.amazonaws.directoryservice#RadiusRetries", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of times that communication with the RADIUS server is retried after the initial attempt.

" + "smithy.api#documentation": "

The maximum number of times that communication with the RADIUS server is retried after\n the initial attempt.

" } }, "SharedSecret": { @@ -9303,15 +9754,22 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

Identifier (ID) of the directory from which you want to remove the IP\n addresses.

", + "smithy.api#documentation": "

Identifier (ID) of the directory from which you want to remove the IP addresses.

", "smithy.api#required": {} } }, "CidrIps": { "target": "com.amazonaws.directoryservice#CidrIps", "traits": { - "smithy.api#documentation": "

IP address blocks that you want to remove.

", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": [], + "smithy.api#documentation": "

IP address blocks that you want to remove.

" + } + }, + "CidrIpv6s": { + "target": "com.amazonaws.directoryservice#CidrIpv6s", + "traits": { + "smithy.api#documentation": "

IPv6 address blocks that you want to remove.

" } } }, @@ -11090,8 +11548,15 @@ "DnsIpAddrs": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { - "smithy.api#documentation": "

The updated IP addresses of the remote DNS server associated with the conditional\n forwarder.

", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": [], + "smithy.api#documentation": "

The updated IP addresses of the remote DNS server associated with the conditional\n forwarder.

" + } + }, + "DnsIpv6Addrs": { + "target": "com.amazonaws.directoryservice#DnsIpv6Addrs", + "traits": { + "smithy.api#documentation": "

The updated IPv6 addresses of the remote DNS server associated with the conditional\n forwarder.

" } } }, @@ -11146,7 +11611,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the directory for a particular update type.

" + "smithy.api#documentation": "

Updates directory configuration for the specified update type.

" } }, "com.amazonaws.directoryservice#UpdateDirectorySetupRequest": { @@ -11155,28 +11620,40 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The identifier of the directory on which you want to perform the update.

", + "smithy.api#documentation": "

The identifier of the directory to update.

", "smithy.api#required": {} } }, "UpdateType": { "target": "com.amazonaws.directoryservice#UpdateType", "traits": { - "smithy.api#documentation": "

The type of update that needs to be performed on the directory. For example, OS.

", + "smithy.api#documentation": "

The type of update to perform on the directory.

", "smithy.api#required": {} } }, "OSUpdateSettings": { "target": "com.amazonaws.directoryservice#OSUpdateSettings", "traits": { - "smithy.api#documentation": "

The settings for the OS update that needs to be performed on the directory.

" + "smithy.api#documentation": "

Operating system configuration to apply during the directory update operation.

" + } + }, + "DirectorySizeUpdateSettings": { + "target": "com.amazonaws.directoryservice#DirectorySizeUpdateSettings", + "traits": { + "smithy.api#documentation": "

Directory size configuration to apply during the update operation.

" + } + }, + "NetworkUpdateSettings": { + "target": "com.amazonaws.directoryservice#NetworkUpdateSettings", + "traits": { + "smithy.api#documentation": "

Network configuration to apply during the directory update operation.

" } }, "CreateSnapshotBeforeUpdate": { "target": "com.amazonaws.directoryservice#CreateSnapshotBeforeUpdate", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The boolean that specifies if a snapshot for the directory needs to be taken before\n updating the directory.

" + "smithy.api#documentation": "

Specifies whether to create a directory snapshot before performing the update.

" } } }, @@ -11323,7 +11800,7 @@ } }, "traits": { - "smithy.api#documentation": "

An entry of update information related to a requested update type.

" + "smithy.api#documentation": "

An entry of update information related to a requested update type.

" } }, "com.amazonaws.directoryservice#UpdateNumberOfDomainControllers": { @@ -11413,7 +11890,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the Remote Authentication Dial In User Service (RADIUS) server information\n for an AD Connector or Microsoft AD directory.

", + "smithy.api#documentation": "

Updates the Remote Authentication Dial In User Service (RADIUS) server information for\n an AD Connector or Microsoft AD directory.

", "smithy.api#examples": [ { "title": "To update Radius", @@ -11647,6 +12124,18 @@ "traits": { "smithy.api#enumValue": "OS" } + }, + "NETWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK" + } + }, + "SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIZE" + } } } }, diff --git a/codegen/sdk/aws-models/dlm.json b/codegen/sdk/aws-models/dlm.json index e6a6e6e1490..b4cd4a61043 100644 --- a/codegen/sdk/aws-models/dlm.json +++ b/codegen/sdk/aws-models/dlm.json @@ -3359,17 +3359,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3383,17 +3372,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3407,17 +3385,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3431,17 +3398,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/docdb-elastic.json b/codegen/sdk/aws-models/docdb-elastic.json index dc7fc486647..9a2a720fe81 100644 --- a/codegen/sdk/aws-models/docdb-elastic.json +++ b/codegen/sdk/aws-models/docdb-elastic.json @@ -728,17 +728,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -752,17 +741,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -776,17 +754,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -800,17 +767,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/docdb.json b/codegen/sdk/aws-models/docdb.json index b898e6b733d..470a168f9e6 100644 --- a/codegen/sdk/aws-models/docdb.json +++ b/codegen/sdk/aws-models/docdb.json @@ -1207,17 +1207,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1231,17 +1220,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1255,17 +1233,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1279,17 +1246,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/drs.json b/codegen/sdk/aws-models/drs.json index f0b1e2d8b4a..a879a3baa66 100644 --- a/codegen/sdk/aws-models/drs.json +++ b/codegen/sdk/aws-models/drs.json @@ -3336,17 +3336,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3360,17 +3349,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3384,17 +3362,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3408,17 +3375,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/dsql.json b/codegen/sdk/aws-models/dsql.json index a57e249db47..75e0bc54f15 100644 --- a/codegen/sdk/aws-models/dsql.json +++ b/codegen/sdk/aws-models/dsql.json @@ -676,102 +676,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://dsql-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://dsql.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://dsql-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://dsql.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://dsql-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://dsql.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://dsql-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://dsql.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { diff --git a/codegen/sdk/aws-models/dynamodb-streams.json b/codegen/sdk/aws-models/dynamodb-streams.json index f8545ff3b81..a0c888349c9 100644 --- a/codegen/sdk/aws-models/dynamodb-streams.json +++ b/codegen/sdk/aws-models/dynamodb-streams.json @@ -237,12 +237,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, @@ -262,6 +256,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": [ @@ -293,152 +293,158 @@ "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": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ { - "ref": "UseDualStack" - }, - true - ] + "ref": "Region" + } + ], + "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] - } + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false ] }, { "fn": "booleanEquals", "argv": [ - true, + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://streams-dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsDualStack" + "name" ] - } + }, + "aws" ] - } - ], - "rules": [ + }, { - "conditions": [], - "endpoint": { - "url": "https://streams.dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], - "type": "tree" + "endpoint": { + "url": "https://streams-dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ { "fn": "getAttr", @@ -446,541 +452,505 @@ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] }, + "aws-cn" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, true ] } ], - "rules": [ + "endpoint": { + "url": "https://streams-dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ { - "conditions": [ + "fn": "stringEquals", + "argv": [ { - "fn": "stringEquals", + "fn": "getAttr", "argv": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] + "ref": "PartitionResult" }, - "aws-us-gov" + "name" ] - } - ], - "endpoint": { - "url": "https://streams.dynamodb.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + "aws-cn" + ] }, { - "conditions": [], - "endpoint": { - "url": "https://streams.dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], - "type": "tree" + "endpoint": { + "url": "https://streams-dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsDualStack" + "name" ] - } + }, + "aws-us-gov" ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://streams.dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ + }, { - "ref": "Region" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] }, - "local" - ] - } - ], - "endpoint": { - "url": "http://localhost:8000", - "properties": { - "authSchemes": [ { - "name": "sigv4", - "signingName": "dynamodb", - "signingRegion": "us-east-1" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } - ] + ], + "endpoint": { + "url": "https://streams-dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ { - "fn": "stringEquals", - "argv": [ - "aws", + "conditions": [ { - "fn": "getAttr", + "fn": "stringEquals", "argv": [ { - "ref": "PartitionResult" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] }, - "name" + "aws-us-gov" ] - } - ] - } - ], - "endpoint": { - "url": "https://streams.dynamodb.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-cn", + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "name" + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true ] } - ] - } - ], - "endpoint": { - "url": "https://streams.dynamodb.{Region}.amazonaws.com.cn", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ + ], + "endpoint": { + "url": "https://streams-dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, { - "fn": "getAttr", + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "name" + false ] } - ] - } - ], - "endpoint": { - "url": "https://streams.dynamodb.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ + ], + "endpoint": { + "url": "https://streams.dynamodb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { - "fn": "stringEquals", - "argv": [ - "aws-iso", + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "name" + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true ] } - ] - } - ], - "endpoint": { - "url": "https://streams.dynamodb.{Region}.c2s.ic.gov", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ + ], + "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://streams.dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, { - "fn": "stringEquals", - "argv": [ - "aws-iso-b", + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "name" + false ] } - ] - } - ], - "endpoint": { - "url": "https://streams.dynamodb.{Region}.sc2s.sgov.gov", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://streams.dynamodb.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.eu-south-1.amazonaws.com" + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://streams.dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "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://streams.dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://streams.dynamodb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { - "url": "https://streams.dynamodb.eu-west-1.amazonaws.com" + "url": "https://example.com" } }, "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false + "Endpoint": "https://example.com", + "UseFIPS": false } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with fips enabled", "expect": { - "endpoint": { - "url": "https://streams.dynamodb.eu-west-2.amazonaws.com" - } + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false + "Endpoint": "https://example.com", + "UseFIPS": true } }, { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { - "endpoint": { - "url": "https://streams.dynamodb.eu-west-3.amazonaws.com" - } + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "eu-west-3", + "Endpoint": "https://example.com", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region local with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "dynamodb", - "signingRegion": "us-east-1" - } - ] - }, - "url": "http://localhost:8000" + "url": "https://streams-dynamodb-fips.us-east-1.api.aws" } }, "params": { - "Region": "local", - "UseFIPS": false, - "UseDualStack": false + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://streams.dynamodb.me-south-1.amazonaws.com" + "url": "https://streams.dynamodb-fips.us-east-1.amazonaws.com" } }, "params": { - "Region": "me-south-1", - "UseFIPS": false, + "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://streams.dynamodb.sa-east-1.amazonaws.com" + "url": "https://streams-dynamodb.us-east-1.api.aws" } }, "params": { - "Region": "sa-east-1", + "Region": "us-east-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { @@ -997,96 +967,44 @@ } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://streams.dynamodb.us-east-2.amazonaws.com" + "url": "https://streams-dynamodb-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", + "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://streams.dynamodb-fips.us-east-1.amazonaws.com" + "url": "https://streams.dynamodb-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { - "Region": "us-east-1", + "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://streams.dynamodb.us-east-1.api.aws" + "url": "https://streams-dynamodb.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { - "Region": "us-east-1", + "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1101,70 +1019,44 @@ } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://streams.dynamodb-fips.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://streams-dynamodb-fips.us-gov-west-1.api.aws" } }, "params": { - "Region": "cn-north-1", + "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://streams.dynamodb-fips.cn-north-1.amazonaws.com.cn" + "url": "https://streams.dynamodb.us-gov-west-1.amazonaws.com" } }, "params": { - "Region": "cn-north-1", + "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://streams.dynamodb.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://streams-dynamodb.us-gov-west-1.api.aws" } }, "params": { - "Region": "cn-north-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://streams.dynamodb.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1179,44 +1071,18 @@ } }, { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://streams.dynamodb.us-gov-west-1.amazonaws.com" + "url": "https://streams.dynamodb-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "Region": "us-gov-west-1", + "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://streams.dynamodb.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1231,40 +1097,18 @@ } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://streams.dynamodb-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://streams.dynamodb-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "Region": "us-iso-east-1", + "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1279,89 +1123,81 @@ } }, { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://streams.dynamodb-fips.us-isob-east-1.sc2s.sgov.gov" + "url": "https://streams.dynamodb-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { - "Region": "us-isob-east-1", + "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://streams.dynamodb.eu-isoe-west-1.cloud.adc-e.uk" + } }, "params": { - "Region": "us-isob-east-1", + "Region": "eu-isoe-west-1", "UseFIPS": false, - "UseDualStack": true + "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 disabled", "expect": { "endpoint": { - "url": "https://example.com" + "url": "https://streams.dynamodb-fips.us-isof-south-1.csp.hci.ic.gov" } }, "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" + "Region": "us-isof-south-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://example.com" + "url": "https://streams.dynamodb.us-isof-south-1.csp.hci.ic.gov" } }, "params": { + "Region": "us-isof-south-1", "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + "endpoint": { + "url": "https://streams.dynamodb-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-east-1", + "Region": "eusc-de-east-1", "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + "endpoint": { + "url": "https://streams.dynamodb.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-east-1", + "Region": "eusc-de-east-1", "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" + "UseDualStack": false } }, { diff --git a/codegen/sdk/aws-models/dynamodb.json b/codegen/sdk/aws-models/dynamodb.json index 487f28ab6c9..6145b5bd3d0 100644 --- a/codegen/sdk/aws-models/dynamodb.json +++ b/codegen/sdk/aws-models/dynamodb.json @@ -475,6 +475,9 @@ "smithy.api#documentation": "

Represents the settings of a target tracking scaling policy that will be\n modified.

" } }, + "com.amazonaws.dynamodb#AvailabilityErrorMessage": { + "type": "string" + }, "com.amazonaws.dynamodb#Backfilling": { "type": "boolean" }, @@ -785,6 +788,9 @@ }, { "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" } ], "traits": { @@ -852,6 +858,9 @@ }, { "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" } ], "traits": { @@ -1181,6 +1190,9 @@ }, { "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" } ], "traits": { @@ -1798,6 +1810,23 @@ } } }, + "com.amazonaws.dynamodb#ContributorInsightsMode": { + "type": "enum", + "members": { + "ACCESSED_AND_THROTTLED_KEYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESSED_AND_THROTTLED_KEYS" + } + }, + "THROTTLED_KEYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THROTTLED_KEYS" + } + } + } + }, "com.amazonaws.dynamodb#ContributorInsightsRule": { "type": "string", "traits": { @@ -1871,6 +1900,12 @@ "traits": { "smithy.api#documentation": "

Describes the current status for contributor insights for the given table and index,\n if applicable.

" } + }, + "ContributorInsightsMode": { + "target": "com.amazonaws.dynamodb#ContributorInsightsMode", + "traits": { + "smithy.api#documentation": "

Indicates the current mode of CloudWatch Contributor Insights, specifying whether it\n tracks all access and throttled events or throttled events only for the DynamoDB\n table or index.

" + } } }, "traits": { @@ -2524,6 +2559,9 @@ { "target": "com.amazonaws.dynamodb#ResourceNotFoundException" }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + }, { "target": "com.amazonaws.dynamodb#TransactionConflictException" } @@ -3069,6 +3107,12 @@ "traits": { "smithy.api#documentation": "

Returns information about the last failure that was encountered.

\n

The most common exceptions for a FAILED status are:

\n
    \n
  • \n

    LimitExceededException - Per-account Amazon CloudWatch Contributor Insights\n rule limit reached. Please disable Contributor Insights for other tables/indexes\n OR disable Contributor Insights rules before retrying.

    \n
  • \n
  • \n

    AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be\n modified due to insufficient permissions.

    \n
  • \n
  • \n

    AccessDeniedException - Failed to create service-linked role for Contributor\n Insights due to insufficient permissions.

    \n
  • \n
  • \n

    InternalServerError - Failed to create Amazon CloudWatch Contributor Insights\n rules. Please retry request.

    \n
  • \n
" } + }, + "ContributorInsightsMode": { + "target": "com.amazonaws.dynamodb#ContributorInsightsMode", + "traits": { + "smithy.api#documentation": "

The mode of CloudWatch Contributor Insights for DynamoDB that determines\n which events are emitted. Can be set to track all access and throttled events or throttled\n events only.

" + } } }, "traits": { @@ -4150,9 +4194,9 @@ "properties": { "authSchemes": [ { - "signingRegion": "us-east-1", + "name": "sigv4", "signingName": "dynamodb", - "name": "sigv4" + "signingRegion": "us-east-1" } ] }, @@ -5640,17 +5684,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5664,17 +5697,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5688,17 +5710,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5712,17 +5723,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -7866,9 +7866,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -7902,9 +7902,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -7954,9 +7954,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -7982,9 +7982,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8010,9 +8010,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8038,9 +8038,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8066,9 +8066,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8094,9 +8094,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8169,9 +8169,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8207,9 +8207,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8245,9 +8245,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8283,9 +8283,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8352,9 +8352,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8402,9 +8402,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8429,9 +8429,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8491,9 +8491,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8527,9 +8527,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8579,9 +8579,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8607,9 +8607,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8635,9 +8635,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8663,9 +8663,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8691,9 +8691,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8719,9 +8719,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8794,9 +8794,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8832,9 +8832,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8870,9 +8870,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8908,9 +8908,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -8977,9 +8977,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9027,9 +9027,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9054,9 +9054,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9116,9 +9116,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9152,9 +9152,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9204,9 +9204,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9232,9 +9232,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9260,9 +9260,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9288,9 +9288,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9316,9 +9316,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9344,9 +9344,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9419,9 +9419,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9457,9 +9457,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9495,9 +9495,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9533,9 +9533,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9602,9 +9602,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9652,9 +9652,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -9679,9 +9679,9 @@ "properties": { "authSchemes": [ { + "signingName": "dynamodb", "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "dynamodb" + "signingRegion": "us-east-1" } ] }, @@ -12607,19 +12607,6 @@ "Region": "cn-north-1" } }, - { - "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "AccountId": "111111111111", - "AccountIdEndpointMode": "preferred", - "Region": "us-iso-east-1" - } - }, { "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", "expect": { @@ -12635,19 +12622,6 @@ "Region": "us-iso-east-1" } }, - { - "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "AccountId": "111111111111", - "AccountIdEndpointMode": "preferred", - "Region": "us-iso-east-1" - } - }, { "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", "expect": { @@ -12840,19 +12814,6 @@ "Region": "us-iso-east-1" } }, - { - "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", - "AccountIdEndpointMode": "preferred", - "Region": "us-iso-east-1" - } - }, { "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", "expect": { @@ -12868,19 +12829,6 @@ "Region": "us-iso-east-1" } }, - { - "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", - "AccountIdEndpointMode": "preferred", - "Region": "us-iso-east-1" - } - }, { "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", "expect": { @@ -12983,21 +12931,6 @@ "Region": "us-iso-east-1" } }, - { - "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "ResourceArnList": [ - "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" - ], - "AccountIdEndpointMode": "preferred", - "Region": "us-iso-east-1" - } - }, { "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", "expect": { @@ -13015,21 +12948,6 @@ "Region": "us-iso-east-1" } }, - { - "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "ResourceArnList": [ - "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" - ], - "AccountIdEndpointMode": "preferred", - "Region": "us-iso-east-1" - } - }, { "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", "expect": { @@ -13739,6 +13657,9 @@ { "target": "com.amazonaws.dynamodb#ResourceNotFoundException" }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + }, { "target": "com.amazonaws.dynamodb#TransactionConflictException" } @@ -13848,6 +13769,9 @@ { "target": "com.amazonaws.dynamodb#ResourceNotFoundException" }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + }, { "target": "com.amazonaws.dynamodb#TransactionCanceledException" }, @@ -14484,6 +14408,9 @@ }, { "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" } ], "traits": { @@ -17229,10 +17156,16 @@ "traits": { "smithy.api#documentation": "

You exceeded your maximum allowed provisioned throughput.

" } + }, + "ThrottlingReasons": { + "target": "com.amazonaws.dynamodb#ThrottlingReasonList", + "traits": { + "smithy.api#documentation": "

A list of ThrottlingReason that\n provide detailed diagnostic information about why the request was throttled.\n

" + } } }, "traits": { - "smithy.api#documentation": "

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB\n automatically retry requests that receive this exception. Your request is eventually\n successful, unless your retry queue is too large to finish. Reduce the frequency of\n requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

", + "smithy.api#documentation": "

The request was denied due to request throttling. For detailed information about\n why the request was throttled and the ARN of the impacted resource, find the ThrottlingReason field in the returned exception. The Amazon Web Services\n SDKs for DynamoDB automatically retry requests that receive this exception.\n Your request is eventually successful, unless your retry queue is too large to finish.\n Reduce the frequency of requests and use exponential backoff. For more information, go\n to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

", "smithy.api#error": "client" } }, @@ -17329,6 +17262,9 @@ { "target": "com.amazonaws.dynamodb#ResourceNotFoundException" }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + }, { "target": "com.amazonaws.dynamodb#TransactionConflictException" } @@ -17606,6 +17542,9 @@ }, { "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" } ], "traits": { @@ -17805,6 +17744,9 @@ "smithy.api#output": {} } }, + "com.amazonaws.dynamodb#Reason": { + "type": "string" + }, "com.amazonaws.dynamodb#RecoveryPeriodInDays": { "type": "integer", "traits": { @@ -18501,13 +18443,22 @@ "members": { "message": { "target": "com.amazonaws.dynamodb#ErrorMessage" + }, + "ThrottlingReasons": { + "target": "com.amazonaws.dynamodb#ThrottlingReasonList", + "traits": { + "smithy.api#documentation": "

A list of ThrottlingReason that\n provide detailed diagnostic information about why the request was throttled.\n

" + } } }, "traits": { - "smithy.api#documentation": "

Throughput exceeds the current throughput quota for your account. Please contact\n Amazon Web ServicesSupport to request a\n quota increase.

", + "smithy.api#documentation": "

Throughput exceeds the current throughput quota for your account. For detailed\n information about why the request was throttled and the ARN of the impacted resource,\n find the ThrottlingReason field in the returned exception. Contact Amazon Web Services Support to request a quota\n increase.

", "smithy.api#error": "client" } }, + "com.amazonaws.dynamodb#Resource": { + "type": "string" + }, "com.amazonaws.dynamodb#ResourceArnString": { "type": "string", "traits": { @@ -19159,6 +19110,9 @@ }, { "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" } ], "traits": { @@ -20146,6 +20100,55 @@ } } }, + "com.amazonaws.dynamodb#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#AvailabilityErrorMessage" + }, + "throttlingReasons": { + "target": "com.amazonaws.dynamodb#ThrottlingReasonList", + "traits": { + "smithy.api#documentation": "

A list of ThrottlingReason that\n provide detailed diagnostic information about why the request was throttled.\n

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "Throttling", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was denied due to request throttling. For detailed information about why\n the request was throttled and the ARN of the impacted resource, find the ThrottlingReason field in the returned exception.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.dynamodb#ThrottlingReason": { + "type": "structure", + "members": { + "reason": { + "target": "com.amazonaws.dynamodb#Reason", + "traits": { + "smithy.api#documentation": "

The reason for throttling. The throttling reason follows a specific format:\n ResourceType+OperationType+LimitType:

\n
    \n
  • \n

    Resource Type (What is being throttled): Table or Index

    \n
  • \n
  • \n

    Operation Type (What kind of operation): Read or Write

    \n
  • \n
  • \n

    Limit Type (Why the throttling occurred):

    \n
      \n
    • \n

      \n ProvisionedThroughputExceeded: The request rate is\n exceeding the provisioned throughput capacity (read or write capacity\n units) configured for a table or a global secondary index (GSI) in\n provisioned capacity mode.

      \n
    • \n
    • \n

      \n AccountLimitExceeded: The request rate has caused a table\n or global secondary index (GSI) in on-demand mode to exceed the per-table account-level service quotas for read/write\n throughput in the current Amazon Web Services Region.

      \n
    • \n
    • \n

      \n KeyRangeThroughputExceeded: The request rate directed at\n a specific partition key value has exceeded the internal partition-level throughput limits, indicating\n uneven access patterns across the table's or GSI's key space.

      \n
    • \n
    • \n

      \n MaxOnDemandThroughputExceeded: The request rate has\n exceeded the configured maximum throughput limits set for a table or\n index in on-demand capacity mode.

      \n
    • \n
    \n
  • \n
\n

Examples of complete throttling reasons:

\n
    \n
  • \n

    TableReadProvisionedThroughputExceeded

    \n
  • \n
  • \n

    IndexWriteAccountLimitExceeded

    \n
  • \n
\n

This helps identify exactly what resource is being throttled, what type of operation\n caused it, and why the throttling occurred.

" + } + }, + "resource": { + "target": "com.amazonaws.dynamodb#Resource", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DynamoDB table or index that experienced the\n throttling event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the specific reason why a DynamoDB request was throttled and the\n ARN of the impacted resource. This helps identify exactly what resource is being throttled, \n what type of operation caused it, and why the throttling occurred.

" + } + }, + "com.amazonaws.dynamodb#ThrottlingReasonList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ThrottlingReason" + } + }, "com.amazonaws.dynamodb#TimeRangeLowerBound": { "type": "timestamp" }, @@ -20286,6 +20289,9 @@ { "target": "com.amazonaws.dynamodb#ResourceNotFoundException" }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + }, { "target": "com.amazonaws.dynamodb#TransactionCanceledException" } @@ -20414,6 +20420,9 @@ { "target": "com.amazonaws.dynamodb#ResourceNotFoundException" }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + }, { "target": "com.amazonaws.dynamodb#TransactionCanceledException" }, @@ -20749,6 +20758,12 @@ "smithy.api#documentation": "

Represents the contributor insights action.

", "smithy.api#required": {} } + }, + "ContributorInsightsMode": { + "target": "com.amazonaws.dynamodb#ContributorInsightsMode", + "traits": { + "smithy.api#documentation": "

Specifies whether to track all access and throttled events or throttled events only for\n the DynamoDB table or index.

" + } } }, "traits": { @@ -20775,6 +20790,12 @@ "traits": { "smithy.api#documentation": "

The status of contributor insights

" } + }, + "ContributorInsightsMode": { + "target": "com.amazonaws.dynamodb#ContributorInsightsMode", + "traits": { + "smithy.api#documentation": "

The updated mode of CloudWatch Contributor Insights that determines whether to monitor\n all access and throttled events or to track throttled events exclusively.

" + } } }, "traits": { @@ -21030,6 +21051,9 @@ { "target": "com.amazonaws.dynamodb#ResourceNotFoundException" }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + }, { "target": "com.amazonaws.dynamodb#TransactionConflictException" } diff --git a/codegen/sdk/aws-models/ebs.json b/codegen/sdk/aws-models/ebs.json index fc22ffd34c9..f9dc9296c05 100644 --- a/codegen/sdk/aws-models/ebs.json +++ b/codegen/sdk/aws-models/ebs.json @@ -1221,17 +1221,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1245,17 +1234,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1269,17 +1247,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1293,17 +1260,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/ec2-instance-connect.json b/codegen/sdk/aws-models/ec2-instance-connect.json index fd4d0b22abb..8ae6858010c 100644 --- a/codegen/sdk/aws-models/ec2-instance-connect.json +++ b/codegen/sdk/aws-models/ec2-instance-connect.json @@ -526,17 +526,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -550,17 +539,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -574,17 +552,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -598,17 +565,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index b1ed9af5966..b51d3c0e6e2 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.json @@ -2595,6 +2595,9 @@ { "target": "com.amazonaws.ec2#CreateImage" }, + { + "target": "com.amazonaws.ec2#CreateImageUsageReport" + }, { "target": "com.amazonaws.ec2#CreateInstanceConnectEndpoint" }, @@ -2850,6 +2853,9 @@ { "target": "com.amazonaws.ec2#DeleteFpgaImage" }, + { + "target": "com.amazonaws.ec2#DeleteImageUsageReport" + }, { "target": "com.amazonaws.ec2#DeleteInstanceConnectEndpoint" }, @@ -3228,9 +3234,18 @@ { "target": "com.amazonaws.ec2#DescribeImageAttribute" }, + { + "target": "com.amazonaws.ec2#DescribeImageReferences" + }, { "target": "com.amazonaws.ec2#DescribeImages" }, + { + "target": "com.amazonaws.ec2#DescribeImageUsageReportEntries" + }, + { + "target": "com.amazonaws.ec2#DescribeImageUsageReports" + }, { "target": "com.amazonaws.ec2#DescribeImportImageTasks" }, @@ -4032,6 +4047,9 @@ { "target": "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributes" }, + { + "target": "com.amazonaws.ec2#ModifyInstanceConnectEndpoint" + }, { "target": "com.amazonaws.ec2#ModifyInstanceCpuOptions" }, @@ -5382,17 +5400,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5406,17 +5413,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5430,17 +5426,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5454,17 +5439,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -7433,6 +7407,12 @@ "smithy.api#documentation": "

The ID of the internet gateway or virtual private gateway.

" } }, + "PublicIpv4Pool": { + "target": "com.amazonaws.ec2#Ipv4PoolEc2Id", + "traits": { + "smithy.api#documentation": "

The ID of a public IPv4 pool. A public IPv4 pool is a pool of IPv4 addresses that you've brought to Amazon Web Services with BYOIP.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -8718,6 +8698,23 @@ "smithy.api#documentation": "

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic \n\t\t\tautomatically uses it. However, some UDP-based applications are designed to handle network packets that are \n\t\t\tout of order, without a need for retransmission, such as live video broadcasting or other near-real-time \n\t\t\tapplications. For UDP traffic, you can specify whether to use ENA Express, based on your application \n\t\t\tenvironment needs.

" } }, + "com.amazonaws.ec2#AttachmentLimitType": { + "type": "enum", + "members": { + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "shared" + } + }, + "DEDICATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dedicated" + } + } + } + }, "com.amazonaws.ec2#AttachmentStatus": { "type": "enum", "members": { @@ -9882,7 +9879,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "smithy.api#documentation": "

The device name. For available device names, see Device names for volumes.

", "smithy.api#xmlName": "deviceName" } }, @@ -13931,6 +13928,14 @@ "smithy.api#xmlName": "clientIp" } }, + "ClientIpv6Address": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientIpv6Address", + "smithy.api#documentation": "

The IPv6 address assigned to the client connection when using a dual-stack Client VPN endpoint. This field is only populated when the endpoint is configured for dual-stack addressing, and the client is using IPv6 for connectivity.

", + "smithy.api#xmlName": "clientIpv6Address" + } + }, "CommonName": { "target": "com.amazonaws.ec2#String", "traits": { @@ -14235,6 +14240,22 @@ "smithy.api#documentation": "

Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.

", "smithy.api#xmlName": "disconnectOnSessionTimeout" } + }, + "EndpointIpAddressType": { + "target": "com.amazonaws.ec2#EndpointIpAddressType", + "traits": { + "aws.protocols#ec2QueryName": "EndpointIpAddressType", + "smithy.api#documentation": "

The IP address type of the Client VPN endpoint. Possible values are ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.

", + "smithy.api#xmlName": "endpointIpAddressType" + } + }, + "TrafficIpAddressType": { + "target": "com.amazonaws.ec2#TrafficIpAddressType", + "traits": { + "aws.protocols#ec2QueryName": "TrafficIpAddressType", + "smithy.api#documentation": "

The IP address type of the Client VPN endpoint. Possible values are either ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.

", + "smithy.api#xmlName": "trafficIpAddressType" + } } }, "traits": { @@ -15320,7 +15341,7 @@ "target": "com.amazonaws.ec2#CopyImageResult" }, "traits": { - "smithy.api#documentation": "

Initiates an AMI copy operation. You can copy an AMI from one Region to another, or from a\n Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to\n another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.

\n

When you copy an AMI from one Region to another, the destination Region is the current\n Region.

\n

When you copy an AMI from a Region to an Outpost, specify the ARN of the Outpost as the\n destination. Backing snapshots copied to an Outpost are encrypted by default using the default\n encryption key for the Region or the key that you specify. Outposts do not support unencrypted\n snapshots.

\n

For information about the prerequisites when copying an AMI, see Copy an Amazon EC2 AMI in the\n Amazon EC2 User Guide.

", + "smithy.api#documentation": "

Initiates an AMI copy operation. You must specify the source AMI ID and both the source\n and destination locations. The copy operation must be initiated in the destination\n Region.

\n

\n CopyImage supports the following source to destination copies:\n

\n
    \n
  • \n

    Region to Region

    \n
  • \n
  • \n

    Region to Outpost

    \n
  • \n
  • \n

    Parent Region to Local Zone

    \n
  • \n
  • \n

    Local Zone to parent Region

    \n
  • \n
  • \n

    Between Local Zones with the same parent Region (only supported for certain Local\n Zones)

    \n
  • \n
\n

\n CopyImage does not support the following source to destination copies:\n

\n
    \n
  • \n

    Local Zone to non-parent Regions

    \n
  • \n
  • \n

    Between Local Zones with different parent Regions

    \n
  • \n
  • \n

    Local Zone to Outpost

    \n
  • \n
  • \n

    Outpost to Local Zone

    \n
  • \n
  • \n

    Outpost to Region

    \n
  • \n
  • \n

    Between Outposts

    \n
  • \n
  • \n

    Within same Outpost

    \n
  • \n
  • \n

    Cross-partition copies (use CreateStoreImageTask instead)

    \n
  • \n
\n

\n Destination specification\n

\n
    \n
  • \n

    Region to Region: The destination Region is the Region in which you initiate the copy\n operation.

    \n
  • \n
  • \n

    Region to Outpost: Specify the destination using the\n DestinationOutpostArn parameter (the ARN of the Outpost)

    \n
  • \n
  • \n

    Region to Local Zone, and Local Zone to Local Zone copies: Specify the destination\n using the DestinationAvailabilityZone parameter (the name of the destination\n Local Zone) or DestinationAvailabilityZoneId parameter (the ID of the\n destination Local Zone).

    \n
  • \n
\n

\n Snapshot encryption\n

\n
    \n
  • \n

    Region to Outpost: Backing snapshots copied to an Outpost are encrypted by default\n using the default encryption key for the Region or the key that you specify. Outposts do\n not support unencrypted snapshots.

    \n
  • \n
  • \n

    Region to Local Zone, and Local Zone to Local Zone: Not all Local Zones require\n encrypted snapshots. In Local Zones that require encrypted snapshots, backing snapshots\n are automatically encrypted during copy. In Local Zones where encryption is not required,\n snapshots retain their original encryption state (encrypted or unencrypted) by\n default.

    \n
  • \n
\n

For more information, including the required permissions for copying an AMI, see Copy an Amazon EC2 AMI in the\n Amazon EC2 User Guide.

", "smithy.api#examples": [ { "title": "To copy an AMI to another region", @@ -15351,14 +15372,14 @@ "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

A description for the new AMI in the destination Region.

" + "smithy.api#documentation": "

A description for the new AMI.

" } }, "Encrypted": { "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#documentation": "

Specifies whether the destination snapshots of the copied image should be encrypted. You\n can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an\n encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default\n Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Use encryption with\n EBS-backed AMIs in the Amazon EC2 User Guide.

", + "smithy.api#documentation": "

Specifies whether to encrypt the snapshots of the copied image.

\n

You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted\n copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a\n non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Use encryption with\n EBS-backed AMIs in the Amazon EC2 User Guide.

", "smithy.api#xmlName": "encrypted" } }, @@ -15374,7 +15395,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the new AMI in the destination Region.

", + "smithy.api#documentation": "

The name of the new AMI.

", "smithy.api#required": {} } }, @@ -15397,13 +15418,13 @@ "DestinationOutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this\n parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the\n Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from\n one Outpost to another, or within the same Outpost.

\n

For more information, see Copy AMIs from an Amazon Web Services Region\n to an Outpost in the Amazon EBS User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost for the new AMI.

\n

Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The\n AMI must be in the Region of the destination Outpost. You can't copy an AMI from an Outpost to\n a Region, from one Outpost to another, or within the same Outpost.

\n

For more information, see Copy AMIs from an Amazon Web Services Region\n to an Outpost in the Amazon EBS User Guide.

\n

Only one of DestinationAvailabilityZone,\n DestinationAvailabilityZoneId, or DestinationOutpostArn can be\n specified.

" } }, "CopyImageTags": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether to include your user-defined AMI tags when copying the AMI.

\n

The following tags will not be copied:

\n
    \n
  • \n

    System tags (prefixed with aws:)

    \n
  • \n
  • \n

    For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services\n accounts

    \n
  • \n
\n

Default: Your user-defined AMI tags are not copied.

" + "smithy.api#documentation": "

Specifies whether to copy your user-defined AMI tags to the new AMI.

\n

The following tags are not be copied:

\n
    \n
  • \n

    System tags (prefixed with aws:)

    \n
  • \n
  • \n

    For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services\n accounts

    \n
  • \n
\n

Default: Your user-defined AMI tags are not copied.

" } }, "TagSpecifications": { @@ -15416,7 +15437,19 @@ "SnapshotCopyCompletionDurationMinutes": { "target": "com.amazonaws.ec2#Long", "traits": { - "smithy.api#documentation": "

Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy.\n The specified completion duration applies to each of the snapshots associated with the AMI.\n Each snapshot associated with the AMI will be completed within the specified completion\n duration, with copy throughput automatically adjusted for each snapshot based on its size to\n meet the timing target.

\n

If you do not specify a value, the AMI copy operation is completed on a best-effort \n basis.

\n

For more information, see Time-based copies for Amazon EBS snapshots and\n EBS-backed AMIs.

" + "smithy.api#documentation": "

Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy.\n The specified completion duration applies to each of the snapshots associated with the AMI.\n Each snapshot associated with the AMI will be completed within the specified completion\n duration, with copy throughput automatically adjusted for each snapshot based on its size to\n meet the timing target.

\n

If you do not specify a value, the AMI copy operation is completed on a best-effort \n basis.

\n \n

This parameter is not supported when copying an AMI to or from a Local Zone, or to an\n Outpost.

\n
\n

For more information, see Time-based copies for Amazon EBS snapshots and\n EBS-backed AMIs.

" + } + }, + "DestinationAvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Local Zone for the new AMI (for example, cn-north-1-pkx-1a).

\n

Only one of DestinationAvailabilityZone,\n DestinationAvailabilityZoneId, or DestinationOutpostArn can be\n specified.

" + } + }, + "DestinationAvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ID of the Local Zone for the new AMI (for example, cnn1-pkx1-az1).

\n

Only one of DestinationAvailabilityZone,\n DestinationAvailabilityZoneId, or DestinationOutpostArn can be\n specified.

" } }, "DryRun": { @@ -15459,7 +15492,7 @@ "target": "com.amazonaws.ec2#CopySnapshotResult" }, "traits": { - "smithy.api#documentation": "

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a\n snapshot within the same Region, from one Region to another, or from a Region to an Outpost. \n You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within \n the same Outpost.

\n

You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

\n

When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. \n \tCopies of unencrypted snapshots remain unencrypted, unless you enable encryption for the \n \tsnapshot copy operation. By default, encrypted snapshot copies use the default KMS key; \n \thowever, you can specify a different KMS key. To copy an encrypted \n \tsnapshot that has been shared from another account, you must have permissions for the KMS key \n \tused to encrypt the snapshot.

\n

Snapshots copied to an Outpost are encrypted by default using the default encryption key\n for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information,\n see Amazon EBS\n local snapshots on Outposts in the Amazon EBS User Guide.

\n

Snapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.

\n

For more information, see Copy an Amazon EBS snapshot in the\n Amazon EBS User Guide.

", + "smithy.api#documentation": "

Creates an exact copy of an Amazon EBS snapshot.

\n

The location of the source snapshot determines whether you can copy it or not, \n and the allowed destinations for the snapshot copy.

\n
    \n
  • \n

    If the source snapshot is in a Region, you can copy it within that Region, \n to another Region, to an Outpost associated with that Region, or to a Local \n Zone in that Region.

    \n
  • \n
  • \n

    If the source snapshot is in a Local Zone, you can copy it within that Local Zone, \n to another Local Zone in the same zone group, or to the parent Region of the Local \n Zone.

    \n
  • \n
  • \n

    If the source snapshot is on an Outpost, you can't copy it.

    \n
  • \n
\n

When copying snapshots to a Region, the encryption outcome for the snapshot copy depends on the \n Amazon EBS encryption by default setting for the destination Region, the encryption status of the source \n snapshot, and the encryption parameters you specify in the request. For more information, see \n Encryption and snapshot copying.

\n

Snapshots copied to an Outpost must be encrypted. Unencrypted snapshots are not supported \n on Outposts. For more information, \n Amazon EBS local snapshots on Outposts.

\n \n

Snapshots copies have an arbitrary source volume ID. Do not use this volume ID for \n any purpose.

\n
\n

For more information, see Copy an Amazon EBS snapshot in the\n Amazon EBS User Guide.

", "smithy.api#examples": [ { "title": "To copy a snapshot", @@ -15489,7 +15522,7 @@ "DestinationOutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only \n\t\tspecify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. \n\t\tThe snapshot must be in the Region for the destination Outpost. You cannot copy a \n\t\tsnapshot from an Outpost to a Region, from one Outpost to another, or within the same \n\t\tOutpost.

\n

For more information, see \n \t\tCopy snapshots from an Amazon Web Services Region to an Outpost in the \n \t\tAmazon EBS User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot.

\n \n

Only supported when copying a snapshot to an Outpost.

\n
\n

For more information, see \n \t\tCopy snapshots from an Amazon Web Services Region to an Outpost in the \n Amazon EBS User Guide.

" } }, "DestinationRegion": { @@ -15504,7 +15537,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#documentation": "

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, \n enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots \n are encrypted, even if you omit this parameter and encryption by default is not enabled. You \n cannot set this parameter to false. For more information, see Amazon EBS encryption in the \n Amazon EBS User Guide.

", + "smithy.api#documentation": "

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, \n enable encryption using this parameter. Otherwise, omit this parameter. Copies of encrypted \n snapshots are encrypted, even if you omit this parameter and encryption by default is not \n enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the \n Amazon EBS User Guide.

", "smithy.api#xmlName": "encrypted" } }, @@ -15550,7 +15583,13 @@ "CompletionDurationMinutes": { "target": "com.amazonaws.ec2#SnapshotCompletionDurationMinutesRequest", "traits": { - "smithy.api#documentation": "

Specify a completion duration, in 15 minute increments, to initiate a time-based snapshot \n copy. Time-based snapshot copy operations complete within the specified duration. For more \n information, see \n Time-based copies.

\n

If you do not specify a value, the snapshot copy operation is completed on a \n best-effort basis.

" + "smithy.api#documentation": "\n

Not supported when copying snapshots to or from Local Zones or Outposts.

\n
\n

Specify a completion duration, in 15 minute increments, to initiate a time-based snapshot \n copy. Time-based snapshot copy operations complete within the specified duration. For more \n information, see \n Time-based copies.

\n

If you do not specify a value, the snapshot copy operation is completed on a \n best-effort basis.

" + } + }, + "DestinationAvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Local Zone, for example, cn-north-1-pkx-1a to which to copy the \n snapshot.

\n \n

Only supported when copying a snapshot to a Local Zone.

\n
" } }, "DryRun": { @@ -16255,9 +16294,7 @@ "ClientCidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.

" } }, "ServerCertificateArn": { @@ -16383,6 +16420,18 @@ "traits": { "smithy.api#documentation": "

Indicates whether the client VPN session is disconnected after the maximum timeout specified in SessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. \n The default value is true.

" } + }, + "EndpointIpAddressType": { + "target": "com.amazonaws.ec2#EndpointIpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the Client VPN endpoint. Valid values are ipv4\n\t\t\t(default) for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6\n\t\t\taddressing. When set to dual-stack, clients can connect to the endpoint\n\t\t\tusing either IPv4 or IPv6 addresses..

" + } + }, + "TrafficIpAddressType": { + "target": "com.amazonaws.ec2#TrafficIpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for traffic within the Client VPN tunnel. Valid values are ipv4 (default) for IPv4 traffic only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 traffic. When set to dual-stack, clients can access both IPv4 and IPv6 resources through the VPN .

" + } } }, "traits": { @@ -16750,9 +16799,7 @@ "AvailabilityZone": { "target": "com.amazonaws.ec2#AvailabilityZoneName", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Availability Zone in which to create the default subnet.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Availability Zone in which to create the default subnet.

\n

Either AvailabilityZone or AvailabilityZoneId must be specified,\n but not both.

" } }, "DryRun": { @@ -16766,6 +16813,12 @@ "traits": { "smithy.api#documentation": "

Indicates whether to create an IPv6 only subnet. If you already have a default subnet\n for this Availability Zone, you must delete it before you can create an IPv6 only subnet.

" } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#AvailabilityZoneId", + "traits": { + "smithy.api#documentation": "

The ID of the Availability Zone.

\n

Either AvailabilityZone or AvailabilityZoneId must be specified,\n but not both.

" + } } }, "traits": { @@ -17468,7 +17521,7 @@ "target": "com.amazonaws.ec2#CreateFpgaImageResult" }, "traits": { - "smithy.api#documentation": "

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

\n

The create operation is asynchronous. To verify that the AFI is ready for use, \n check the output logs.

\n

An AFI contains the FPGA bitstream that is ready to download to an FPGA. \n You can securely deploy an AFI on multiple FPGA-accelerated instances.\n For more information, see the Amazon Web Services FPGA Hardware Development Kit.

" + "smithy.api#documentation": "

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

\n

The create operation is asynchronous. To verify that the AFI was successfully \n created and is ready for use, check the output logs.

\n

An AFI contains the FPGA bitstream that is ready to download to an FPGA. \n You can securely deploy an AFI on multiple FPGA-accelerated instances.\n For more information, see the Amazon Web Services FPGA Hardware Development Kit.

" } }, "com.amazonaws.ec2#CreateFpgaImageRequest": { @@ -17649,6 +17702,86 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#CreateImageUsageReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateImageUsageReportRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateImageUsageReportResult" + }, + "traits": { + "smithy.api#documentation": "

Creates a report that shows how your image is used across other Amazon Web Services accounts. The report\n provides visibility into which accounts are using the specified image, and how many resources\n (EC2 instances or launch templates) are referencing it.

\n

For more information, see View your AMI usage in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#CreateImageUsageReportRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the image to report on.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "ResourceTypes": { + "target": "com.amazonaws.ec2#ImageUsageResourceTypeRequestList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The resource types to include in the report.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ResourceType" + } + }, + "AccountIds": { + "target": "com.amazonaws.ec2#ImageUsageReportUserIdStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account IDs to include in the report. To include all accounts, omit this\n parameter.

", + "smithy.api#xmlName": "AccountId" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the report on creation. The ResourceType must be set to\n image-usage-report; any other value will cause the report creation to\n fail.

\n

To tag a report after it has been created, see CreateTags.

", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateImageUsageReportResult": { + "type": "structure", + "members": { + "ReportId": { + "target": "com.amazonaws.ec2#ImageUsageReportId", + "traits": { + "aws.protocols#ec2QueryName": "ReportId", + "smithy.api#documentation": "

The ID of the report.

", + "smithy.api#xmlName": "reportId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#CreateInstanceConnectEndpoint": { "type": "operation", "input": { @@ -23826,9 +23959,13 @@ "AvailabilityZone": { "target": "com.amazonaws.ec2#AvailabilityZoneName", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Availability Zone in which to create the volume. For example, us-east-1a.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the Availability Zone in which to create the volume. For example, us-east-1a.

\n

Either AvailabilityZone or AvailabilityZoneId must be specified,\n but not both.

" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#AvailabilityZoneId", + "traits": { + "smithy.api#documentation": "

The ID of the Availability Zone in which to create the volume. For example, use1-az1.

\n

Either AvailabilityZone or AvailabilityZoneId must be specified,\n but not both.

" } }, "Encrypted": { @@ -23842,7 +23979,7 @@ "Iops": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents \n the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline \n performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

\n

The following are the supported values for each volume type:

\n
    \n
  • \n

    \n gp3: 3,000 - 16,000 IOPS

    \n
  • \n
  • \n

    \n io1: 100 - 64,000 IOPS

    \n
  • \n
  • \n

    \n io2: 100 - 256,000 IOPS

    \n
  • \n
\n

For io2 volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

\n

This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS.\n This parameter is not supported for gp2, st1, sc1, or standard volumes.

" + "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents \n the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline \n performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

\n

The following are the supported values for each volume type:

\n
    \n
  • \n

    \n gp3: 3,000 - 80,000 IOPS

    \n
  • \n
  • \n

    \n io1: 100 - 64,000 IOPS

    \n
  • \n
  • \n

    \n io2: 100 - 256,000 IOPS

    \n
  • \n
\n

For io2 volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

\n

This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS.\n This parameter is not supported for gp2, st1, sc1, or standard volumes.

" } }, "KmsKeyId": { @@ -23860,7 +23997,7 @@ "Size": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.\n If you specify a snapshot, the default is the snapshot size. You can specify a volume \n size that is equal to or larger than the snapshot size.

\n

The following are the supported volumes sizes for each volume type:

\n
    \n
  • \n

    \n gp2 and gp3: 1 - 16,384 GiB

    \n
  • \n
  • \n

    \n io1: 4 - 16,384 GiB

    \n
  • \n
  • \n

    \n io2: 4 - 65,536 GiB

    \n
  • \n
  • \n

    \n st1 and sc1: 125 - 16,384 GiB

    \n
  • \n
  • \n

    \n standard: 1 - 1024 GiB

    \n
  • \n
" + "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.\n If you specify a snapshot, the default is the snapshot size. You can specify a volume \n size that is equal to or larger than the snapshot size.

\n

The following are the supported volumes sizes for each volume type:

\n
    \n
  • \n

    \n gp2: 1 - 16,384 GiB

    \n
  • \n
  • \n

    \n gp3: 1 - 65,536 GiB

    \n
  • \n
  • \n

    \n io1: 4 - 16,384 GiB

    \n
  • \n
  • \n

    \n io2: 4 - 65,536 GiB

    \n
  • \n
  • \n

    \n st1 and sc1: 125 - 16,384 GiB

    \n
  • \n
  • \n

    \n standard: 1 - 1024 GiB

    \n
  • \n
" } }, "SnapshotId": { @@ -23891,7 +24028,7 @@ "Throughput": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" + "smithy.api#documentation": "

The throughput to provision for a volume, with a maximum of 2,000 MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 2,000.

" } }, "ClientToken": { @@ -24756,6 +24893,36 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#CreationDateCondition": { + "type": "structure", + "members": { + "MaximumDaysSinceCreated": { + "target": "com.amazonaws.ec2#MaximumDaysSinceCreatedValue", + "traits": { + "aws.protocols#ec2QueryName": "MaximumDaysSinceCreated", + "smithy.api#documentation": "

The maximum number of days that have elapsed since the image was created. For example, a\n value of 300 allows images that were created within the last 300 days.

", + "smithy.api#xmlName": "maximumDaysSinceCreated" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum age for allowed images.

" + } + }, + "com.amazonaws.ec2#CreationDateConditionRequest": { + "type": "structure", + "members": { + "MaximumDaysSinceCreated": { + "target": "com.amazonaws.ec2#MaximumDaysSinceCreatedValue", + "traits": { + "smithy.api#documentation": "

The maximum number of days that have elapsed since the image was created. For example, a\n value of 300 allows images that were created within the last 300 days.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum age for allowed images.

" + } + }, "com.amazonaws.ec2#CreditSpecification": { "type": "structure", "members": { @@ -25992,6 +26159,56 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DeleteImageUsageReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteImageUsageReportRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteImageUsageReportResult" + }, + "traits": { + "smithy.api#documentation": "

Deletes the specified image usage report.

\n

For more information, see View your AMI usage in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#DeleteImageUsageReportRequest": { + "type": "structure", + "members": { + "ReportId": { + "target": "com.amazonaws.ec2#ImageUsageReportId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the report to delete.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteImageUsageReportResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DeleteInstanceConnectEndpoint": { "type": "operation", "input": { @@ -29875,6 +30092,36 @@ "smithy.api#input": {} } }, + "com.amazonaws.ec2#DeprecationTimeCondition": { + "type": "structure", + "members": { + "MaximumDaysSinceDeprecated": { + "target": "com.amazonaws.ec2#MaximumDaysSinceDeprecatedValue", + "traits": { + "aws.protocols#ec2QueryName": "MaximumDaysSinceDeprecated", + "smithy.api#documentation": "

The maximum number of days that have elapsed since the image was deprecated. When set to\n 0, no deprecated images are allowed.

", + "smithy.api#xmlName": "maximumDaysSinceDeprecated" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum period since deprecation for allowed images.

" + } + }, + "com.amazonaws.ec2#DeprecationTimeConditionRequest": { + "type": "structure", + "members": { + "MaximumDaysSinceDeprecated": { + "target": "com.amazonaws.ec2#MaximumDaysSinceDeprecatedValue", + "traits": { + "smithy.api#documentation": "

The maximum number of days that have elapsed since the image was deprecated. Set to\n 0 to exclude all deprecated images.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum period since deprecation for allowed images.

" + } + }, "com.amazonaws.ec2#DeprovisionByoipCidr": { "type": "operation", "input": { @@ -34956,6 +35203,349 @@ "smithy.api#input": {} } }, + "com.amazonaws.ec2#DescribeImageReferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeImageReferencesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeImageReferencesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes your Amazon Web Services resources that are referencing the specified images.

\n

For more information, see Identify your resources referencing\n specified AMIs in the Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ImageReferences", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeImageReferencesImageIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.ec2#DescribeImageReferencesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5 + } + } + }, + "com.amazonaws.ec2#DescribeImageReferencesRequest": { + "type": "structure", + "members": { + "ImageIds": { + "target": "com.amazonaws.ec2#DescribeImageReferencesImageIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the images to check for resource references.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ImageId" + } + }, + "IncludeAllResourceTypes": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to check all supported Amazon Web Services resource types for image references. When\n specified, default values are applied for ResourceTypeOptions. For the default\n values, see How AMI\n reference checks work in the Amazon EC2 User Guide. If you also\n specify ResourceTypes with ResourceTypeOptions, your specified\n values override the default values.

\n

Supported resource types: ec2:Instance | ec2:LaunchTemplate |\n ssm:Parameter | imagebuilder:ImageRecipe |\n imagebuilder:ContainerRecipe\n

\n

Either IncludeAllResourceTypes or ResourceTypes must be\n specified.

" + } + }, + "ResourceTypes": { + "target": "com.amazonaws.ec2#ResourceTypeRequestList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services resource types to check for image references.

\n

Either IncludeAllResourceTypes or ResourceTypes must be\n specified.

", + "smithy.api#xmlName": "ResourceType" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeImageReferencesMaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeImageReferencesResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "ImageReferences": { + "target": "com.amazonaws.ec2#ImageReferenceList", + "traits": { + "aws.protocols#ec2QueryName": "ImageReferenceSet", + "smithy.api#documentation": "

The resources that are referencing the specified images.

", + "smithy.api#xmlName": "imageReferenceSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeImageUsageReportEntries": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeImageUsageReportEntriesRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeImageUsageReportEntriesResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the entries in image usage reports, showing how your images are used across\n other Amazon Web Services accounts.

\n

For more information, see View your AMI usage in the\n Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ImageUsageReportEntries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeImageUsageReportEntriesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.ec2#DescribeImageUsageReportEntriesRequest": { + "type": "structure", + "members": { + "ImageIds": { + "target": "com.amazonaws.ec2#DescribeImageUsageReportsImageIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the images for filtering the report entries. If specified, only report entries\n containing these images are returned.

", + "smithy.api#xmlName": "ImageId" + } + }, + "ReportIds": { + "target": "com.amazonaws.ec2#ImageUsageReportIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the usage reports.

", + "smithy.api#xmlName": "ReportId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n account-id - A 12-digit Amazon Web Services account ID.

    \n
  • \n
  • \n

    \n creation-time - The time when the report was created, in the ISO 8601\n format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2025-11-29T11:04:43.305Z. You can use a wildcard (*), for\n example, 2025-11-29T*, which matches an entire day.

    \n
  • \n
  • \n

    \n resource-type - The resource type (ec2:Instance |\n ec2:LaunchTemplate).

    \n
  • \n
", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeImageUsageReportEntriesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeImageUsageReportEntriesResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "ImageUsageReportEntries": { + "target": "com.amazonaws.ec2#ImageUsageReportEntryList", + "traits": { + "aws.protocols#ec2QueryName": "ImageUsageReportEntrySet", + "smithy.api#documentation": "

The content of the usage reports.

", + "smithy.api#xmlName": "imageUsageReportEntrySet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DescribeImageUsageReports": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeImageUsageReportsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeImageUsageReportsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration and status of image usage reports, filtered by report IDs or\n image IDs.

\n

For more information, see View your AMI usage in the\n Amazon EC2 User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ImageUsageReports", + "pageSize": "MaxResults" + }, + "smithy.waiters#waitable": { + "ImageUsageReportAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ImageUsageReports[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImageUsageReports[].State", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.ec2#DescribeImageUsageReportsImageIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.ec2#DescribeImageUsageReportsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.ec2#DescribeImageUsageReportsRequest": { + "type": "structure", + "members": { + "ImageIds": { + "target": "com.amazonaws.ec2#DescribeImageUsageReportsImageIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the images for filtering the reports. If specified, only reports containing\n these images are returned.

", + "smithy.api#xmlName": "ImageId" + } + }, + "ReportIds": { + "target": "com.amazonaws.ec2#ImageUsageReportIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the image usage reports.

", + "smithy.api#xmlName": "ReportId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n creation-time - The time when the report was created, in the ISO 8601\n format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2025-11-29T11:04:43.305Z. You can use a wildcard (*), for\n example, 2025-11-29T*, which matches an entire day.

    \n
  • \n
  • \n

    \n state - The state of the report (available |\n pending | error).

    \n
  • \n
", + "smithy.api#xmlName": "Filter" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeImageUsageReportsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeImageUsageReportsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", + "smithy.api#xmlName": "nextToken" + } + }, + "ImageUsageReports": { + "target": "com.amazonaws.ec2#ImageUsageReportList", + "traits": { + "aws.protocols#ec2QueryName": "ImageUsageReportSet", + "smithy.api#documentation": "

The image usage reports.

", + "smithy.api#xmlName": "imageUsageReportSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DescribeImages": { "type": "operation", "input": { @@ -35967,7 +36557,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n availability-zone - The Availability Zone of the instance.

    \n
  • \n
  • \n

    \n event.code - The code for the scheduled event\n (instance-reboot | system-reboot |\n system-maintenance | instance-retirement |\n instance-stop).

    \n
  • \n
  • \n

    \n event.description - A description of the event.

    \n
  • \n
  • \n

    \n event.instance-event-id - The ID of the event whose date and time\n you are modifying.

    \n
  • \n
  • \n

    \n event.not-after - The latest end time for the scheduled event\n (for example, 2014-09-15T17:15:20.000Z).

    \n
  • \n
  • \n

    \n event.not-before - The earliest start time for the scheduled\n event (for example, 2014-09-15T17:15:20.000Z).

    \n
  • \n
  • \n

    \n event.not-before-deadline - The deadline for starting the event\n (for example, 2014-09-15T17:15:20.000Z).

    \n
  • \n
  • \n

    \n instance-state-code - The code for the instance state, as a\n 16-bit unsigned integer. The high byte is used for internal purposes and should\n be ignored. The low byte is set based on the state represented. The valid values\n are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).

    \n
  • \n
  • \n

    \n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).

    \n
  • \n
  • \n

    \n instance-status.reachability - Filters on instance status where\n the name is reachability (passed | failed\n | initializing | insufficient-data).

    \n
  • \n
  • \n

    \n instance-status.status - The status of the instance\n (ok | impaired | initializing |\n insufficient-data | not-applicable).

    \n
  • \n
  • \n

    \n operator.managed - A Boolean that indicates whether this is a\n managed instance.

    \n
  • \n
  • \n

    \n operator.principal - The principal that manages the instance.\n Only valid for managed instances, where managed is\n true.

    \n
  • \n
  • \n

    \n system-status.reachability - Filters on system status where the\n name is reachability (passed | failed |\n initializing | insufficient-data).

    \n
  • \n
  • \n

    \n system-status.status - The system status of the instance\n (ok | impaired | initializing |\n insufficient-data | not-applicable).

    \n
  • \n
  • \n

    \n attached-ebs-status.status - The status of the attached EBS volume \n for the instance (ok | impaired | initializing | \n insufficient-data | not-applicable).

    \n
  • \n
", + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n availability-zone - The Availability Zone of the instance.

    \n
  • \n
  • \n

    \n availability-zone-id - The ID of the Availability Zone of the\n instance.

    \n
  • \n
  • \n

    \n event.code - The code for the scheduled event\n (instance-reboot | system-reboot |\n system-maintenance | instance-retirement |\n instance-stop).

    \n
  • \n
  • \n

    \n event.description - A description of the event.

    \n
  • \n
  • \n

    \n event.instance-event-id - The ID of the event whose date and time\n you are modifying.

    \n
  • \n
  • \n

    \n event.not-after - The latest end time for the scheduled event\n (for example, 2014-09-15T17:15:20.000Z).

    \n
  • \n
  • \n

    \n event.not-before - The earliest start time for the scheduled\n event (for example, 2014-09-15T17:15:20.000Z).

    \n
  • \n
  • \n

    \n event.not-before-deadline - The deadline for starting the event\n (for example, 2014-09-15T17:15:20.000Z).

    \n
  • \n
  • \n

    \n instance-state-code - The code for the instance state, as a\n 16-bit unsigned integer. The high byte is used for internal purposes and should\n be ignored. The low byte is set based on the state represented. The valid values\n are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).

    \n
  • \n
  • \n

    \n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).

    \n
  • \n
  • \n

    \n instance-status.reachability - Filters on instance status where\n the name is reachability (passed | failed\n | initializing | insufficient-data).

    \n
  • \n
  • \n

    \n instance-status.status - The status of the instance\n (ok | impaired | initializing |\n insufficient-data | not-applicable).

    \n
  • \n
  • \n

    \n operator.managed - A Boolean that indicates whether this is a\n managed instance.

    \n
  • \n
  • \n

    \n operator.principal - The principal that manages the instance.\n Only valid for managed instances, where managed is\n true.

    \n
  • \n
  • \n

    \n system-status.reachability - Filters on system status where the\n name is reachability (passed | failed |\n initializing | insufficient-data).

    \n
  • \n
  • \n

    \n system-status.status - The system status of the instance\n (ok | impaired | initializing |\n insufficient-data | not-applicable).

    \n
  • \n
  • \n

    \n attached-ebs-status.status - The status of the attached EBS volume \n for the instance (ok | impaired | initializing | \n insufficient-data | not-applicable).

    \n
  • \n
", "smithy.api#xmlName": "Filter" } }, @@ -36236,7 +36826,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 - 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#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.attachment-limit-type - The type of Amazon EBS volume attachment limit \n (shared | dedicated).

    \n
  • \n
  • \n

    \n ebs-info.maximum-ebs-attachments - The maximum number of Amazon EBS volumes that \n can be attached to the instance type.

    \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" } }, @@ -36526,7 +37116,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n affinity - The affinity setting for an instance running on a\n Dedicated Host (default | host).

    \n
  • \n
  • \n

    \n architecture - The instance architecture (i386 |\n x86_64 | arm64).

    \n
  • \n
  • \n

    \n availability-zone - The Availability Zone of the instance.

    \n
  • \n
  • \n

    \n block-device-mapping.attach-time - The attach time for an EBS\n volume mapped to the instance, for example,\n 2022-09-15T17:15:20.000Z.

    \n
  • \n
  • \n

    \n block-device-mapping.delete-on-termination - A Boolean that\n indicates whether the EBS volume is deleted on instance termination.

    \n
  • \n
  • \n

    \n block-device-mapping.device-name - The device name specified in\n the block device mapping (for example, /dev/sdh or\n xvdh).

    \n
  • \n
  • \n

    \n block-device-mapping.status - The status for the EBS volume\n (attaching | attached | detaching |\n detached).

    \n
  • \n
  • \n

    \n block-device-mapping.volume-id - The volume ID of the EBS\n volume.

    \n
  • \n
  • \n

    \n boot-mode - The boot mode that was specified by the AMI\n (legacy-bios | uefi |\n uefi-preferred).

    \n
  • \n
  • \n

    \n capacity-reservation-id - The ID of the Capacity Reservation into which the\n instance was launched.

    \n
  • \n
  • \n

    \n capacity-reservation-specification.capacity-reservation-preference\n - The instance's Capacity Reservation preference (open | none).

    \n
  • \n
  • \n

    \n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id\n - The ID of the targeted Capacity Reservation.

    \n
  • \n
  • \n

    \n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn\n - The ARN of the targeted Capacity Reservation group.

    \n
  • \n
  • \n

    \n client-token - The idempotency token you provided when you\n launched the instance.

    \n
  • \n
  • \n

    \n current-instance-boot-mode - The boot mode that is used to launch\n the instance at launch or start (legacy-bios |\n uefi).

    \n
  • \n
  • \n

    \n dns-name - The public DNS name of the instance.

    \n
  • \n
  • \n

    \n ebs-optimized - A Boolean that indicates whether the instance is\n optimized for Amazon EBS I/O.

    \n
  • \n
  • \n

    \n ena-support - A Boolean that indicates whether the instance is\n enabled for enhanced networking with ENA.

    \n
  • \n
  • \n

    \n enclave-options.enabled - A Boolean that indicates whether the\n instance is enabled for Amazon Web Services Nitro Enclaves.

    \n
  • \n
  • \n

    \n hibernation-options.configured - A Boolean that indicates whether\n the instance is enabled for hibernation. A value of true means that\n the instance is enabled for hibernation.

    \n
  • \n
  • \n

    \n host-id - The ID of the Dedicated Host on which the instance is\n running, if applicable.

    \n
  • \n
  • \n

    \n hypervisor - The hypervisor type of the instance\n (ovm | xen). The value xen is used\n for both Xen and Nitro hypervisors.

    \n
  • \n
  • \n

    \n iam-instance-profile.arn - The instance profile associated with\n the instance. Specified as an ARN.

    \n
  • \n
  • \n

    \n iam-instance-profile.id - The instance profile associated with\n the instance. Specified as an ID.

    \n
  • \n
  • \n

    \n image-id - The ID of the image used to launch the\n instance.

    \n
  • \n
  • \n

    \n instance-id - The ID of the instance.

    \n
  • \n
  • \n

    \n instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or\n a Capacity Block (spot | scheduled | capacity-block).

    \n
  • \n
  • \n

    \n instance-state-code - The state of the instance, as a 16-bit\n unsigned integer. The high byte is used for internal purposes and should be\n ignored. The low byte is set based on the state represented. The valid values\n are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).

    \n
  • \n
  • \n

    \n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).

    \n
  • \n
  • \n

    \n instance-type - The type of instance (for example,\n t2.micro).

    \n
  • \n
  • \n

    \n instance.group-id - The ID of the security group for the\n instance.

    \n
  • \n
  • \n

    \n instance.group-name - The name of the security group for the\n instance.

    \n
  • \n
  • \n

    \n ip-address - The public IPv4 address of the instance.

    \n
  • \n
  • \n

    \n ipv6-address - The IPv6 address of the instance.

    \n
  • \n
  • \n

    \n kernel-id - The kernel ID.

    \n
  • \n
  • \n

    \n key-name - The name of the key pair used when the instance was\n launched.

    \n
  • \n
  • \n

    \n launch-index - When launching multiple instances, this is the\n index for the instance in the launch group (for example, 0, 1, 2, and so on).\n

    \n
  • \n
  • \n

    \n launch-time - The time when the instance was launched, in the ISO\n 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard\n (*), for example, 2021-09-29T*, which matches an\n entire day.

    \n
  • \n
  • \n

    \n maintenance-options.auto-recovery - The current automatic\n recovery behavior of the instance (disabled | default).

    \n
  • \n
  • \n

    \n metadata-options.http-endpoint - The status of access to the HTTP\n metadata endpoint on your instance (enabled |\n disabled)

    \n
  • \n
  • \n

    \n metadata-options.http-protocol-ipv4 - Indicates whether the IPv4\n endpoint is enabled (disabled | enabled).

    \n
  • \n
  • \n

    \n metadata-options.http-protocol-ipv6 - Indicates whether the IPv6\n endpoint is enabled (disabled | enabled).

    \n
  • \n
  • \n

    \n metadata-options.http-put-response-hop-limit - The HTTP metadata\n request put response hop limit (integer, possible values 1 to\n 64)

    \n
  • \n
  • \n

    \n metadata-options.http-tokens - The metadata request authorization\n state (optional | required)

    \n
  • \n
  • \n

    \n metadata-options.instance-metadata-tags - The status of access to\n instance tags from the instance metadata (enabled |\n disabled)

    \n
  • \n
  • \n

    \n metadata-options.state - The state of the metadata option changes\n (pending | applied).

    \n
  • \n
  • \n

    \n monitoring-state - Indicates whether detailed monitoring is\n enabled (disabled | enabled).

    \n
  • \n
  • \n

    \n network-interface.addresses.association.allocation-id - The allocation ID.

    \n
  • \n
  • \n

    \n network-interface.addresses.association.association-id - The association ID.

    \n
  • \n
  • \n

    \n network-interface.addresses.association.carrier-ip - The carrier IP address.

    \n
  • \n
  • \n

    \n network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.

    \n
  • \n
  • \n

    \n network-interface.addresses.association.ip-owner-id - The owner\n ID of the private IPv4 address associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.addresses.association.public-dns-name - The public DNS name.

    \n
  • \n
  • \n

    \n network-interface.addresses.association.public-ip - The ID of the\n association of an Elastic IP address (IPv4) with a network interface.

    \n
  • \n
  • \n

    \n network-interface.addresses.primary - Specifies whether the IPv4\n address of the network interface is the primary private IPv4 address.

    \n
  • \n
  • \n

    \n network-interface.addresses.private-dns-name - The private DNS name.

    \n
  • \n
  • \n

    \n network-interface.addresses.private-ip-address - The private IPv4\n address associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.association.allocation-id - The allocation ID\n returned when you allocated the Elastic IP address (IPv4) for your network\n interface.

    \n
  • \n
  • \n

    \n network-interface.association.association-id - The association ID\n returned when the network interface was associated with an IPv4 address.

    \n
  • \n
  • \n

    \n network-interface.association.carrier-ip - The customer-owned IP address.

    \n
  • \n
  • \n

    \n network-interface.association.customer-owned-ip - The customer-owned IP address.

    \n
  • \n
  • \n

    \n network-interface.association.ip-owner-id - The owner of the\n Elastic IP address (IPv4) associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.association.public-dns-name - The public DNS name.

    \n
  • \n
  • \n

    \n network-interface.association.public-ip - The address of the\n Elastic IP address (IPv4) bound to the network interface.

    \n
  • \n
  • \n

    \n network-interface.attachment.attach-time - The time that the\n network interface was attached to an instance.

    \n
  • \n
  • \n

    \n network-interface.attachment.attachment-id - The ID of the\n interface attachment.

    \n
  • \n
  • \n

    \n network-interface.attachment.delete-on-termination - Specifies\n whether the attachment is deleted when an instance is terminated.

    \n
  • \n
  • \n

    \n network-interface.attachment.device-index - The device index to\n which the network interface is attached.

    \n
  • \n
  • \n

    \n network-interface.attachment.instance-id - The ID of the instance\n to which the network interface is attached.

    \n
  • \n
  • \n

    \n network-interface.attachment.instance-owner-id - The owner ID of\n the instance to which the network interface is attached.

    \n
  • \n
  • \n

    \n network-interface.attachment.network-card-index - The index of the network card.

    \n
  • \n
  • \n

    \n network-interface.attachment.status - The status of the\n attachment (attaching | attached |\n detaching | detached).

    \n
  • \n
  • \n

    \n network-interface.availability-zone - The Availability Zone for\n the network interface.

    \n
  • \n
  • \n

    \n network-interface.deny-all-igw-traffic - A Boolean that indicates whether \n a network interface with an IPv6 address is unreachable from the public internet.

    \n
  • \n
  • \n

    \n network-interface.description - The description of the network\n interface.

    \n
  • \n
  • \n

    \n network-interface.group-id - The ID of a security group\n associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.group-name - The name of a security group\n associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network interface.

    \n
  • \n
  • \n

    \n network-interface.ipv6-address - The IPv6 address associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.ipv6-addresses.ipv6-address - The IPv6 address\n associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this\n is the primary IPv6 address.

    \n
  • \n
  • \n

    \n network-interface.ipv6-native - A Boolean that indicates whether this is\n an IPv6 only network interface.

    \n
  • \n
  • \n

    \n network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.

    \n
  • \n
  • \n

    \n network-interface.mac-address - The MAC address of the network\n interface.

    \n
  • \n
  • \n

    \n network-interface.network-interface-id - The ID of the network\n interface.

    \n
  • \n
  • \n

    \n network-interface.operator.managed - A Boolean that indicates\n whether the instance has a managed network interface.

    \n
  • \n
  • \n

    \n network-interface.operator.principal - The principal that manages\n the network interface. Only valid for instances with managed network interfaces,\n where managed is true.

    \n
  • \n
  • \n

    \n network-interface.outpost-arn - The ARN of the Outpost.

    \n
  • \n
  • \n

    \n network-interface.owner-id - The ID of the owner of the network\n interface.

    \n
  • \n
  • \n

    \n network-interface.private-dns-name - The private DNS name of the\n network interface.

    \n
  • \n
  • \n

    \n network-interface.private-ip-address - The private IPv4 address.

    \n
  • \n
  • \n

    \n network-interface.public-dns-name - The public DNS name.

    \n
  • \n
  • \n

    \n network-interface.requester-id - The requester ID for the network\n interface.

    \n
  • \n
  • \n

    \n network-interface.requester-managed - Indicates whether the\n network interface is being managed by Amazon Web Services.

    \n
  • \n
  • \n

    \n network-interface.status - The status of the network interface\n (available) | in-use).

    \n
  • \n
  • \n

    \n network-interface.source-dest-check - Whether the network\n interface performs source/destination checking. A value of true\n means that checking is enabled, and false means that checking is\n disabled. The value must be false for the network interface to\n perform network address translation (NAT) in your VPC.

    \n
  • \n
  • \n

    \n network-interface.subnet-id - The ID of the subnet for the\n network interface.

    \n
  • \n
  • \n

    \n network-interface.tag-key - The key of a tag assigned to the network interface.

    \n
  • \n
  • \n

    \n network-interface.tag-value - The value of a tag assigned to the network interface.

    \n
  • \n
  • \n

    \n network-interface.vpc-id - The ID of the VPC for the network\n interface.

    \n
  • \n
  • \n

    \n network-performance-options.bandwidth-weighting - Where the performance boost \n \t\t\tis applied, if applicable. Valid values: default, vpc-1, \n \t\t\tebs-1.

    \n
  • \n
  • \n

    \n operator.managed - A Boolean that indicates whether this is a\n managed instance.

    \n
  • \n
  • \n

    \n operator.principal - The principal that manages the instance.\n Only valid for managed instances, where managed is\n true.

    \n
  • \n
  • \n

    \n outpost-arn - The Amazon Resource Name (ARN) of the\n Outpost.

    \n
  • \n
  • \n

    \n owner-id - The Amazon Web Services account ID of the instance\n owner.

    \n
  • \n
  • \n

    \n placement-group-name - The name of the placement group for the\n instance.

    \n
  • \n
  • \n

    \n placement-partition-number - The partition in which the instance is\n located.

    \n
  • \n
  • \n

    \n platform - The platform. To list only Windows instances, use\n windows.

    \n
  • \n
  • \n

    \n platform-details - The platform (Linux/UNIX |\n Red Hat BYOL Linux | Red Hat Enterprise Linux |\n Red Hat Enterprise Linux with HA | Red Hat Enterprise\n Linux with SQL Server Standard and HA | Red Hat Enterprise\n Linux with SQL Server Enterprise and HA | Red Hat Enterprise\n Linux with SQL Server Standard | Red Hat Enterprise Linux with\n SQL Server Web | Red Hat Enterprise Linux with SQL Server\n Enterprise | SQL Server Enterprise | SQL Server\n Standard | SQL Server Web | SUSE Linux |\n Ubuntu Pro | Windows | Windows BYOL |\n Windows with SQL Server Enterprise | Windows with SQL\n Server Standard | Windows with SQL Server Web).

    \n
  • \n
  • \n

    \n private-dns-name - The private IPv4 DNS name of the\n instance.

    \n
  • \n
  • \n

    \n private-dns-name-options.enable-resource-name-dns-a-record - A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS A records.

    \n
  • \n
  • \n

    \n private-dns-name-options.enable-resource-name-dns-aaaa-record - A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS AAAA records.

    \n
  • \n
  • \n

    \n private-dns-name-options.hostname-type - The type of hostname\n (ip-name | resource-name).

    \n
  • \n
  • \n

    \n private-ip-address - The private IPv4 address of the instance.\n This can only be used to filter by the primary IP address of the network\n interface attached to the instance. To filter by additional IP addresses\n assigned to the network interface, use the filter\n network-interface.addresses.private-ip-address.

    \n
  • \n
  • \n

    \n product-code - The product code associated with the AMI used to\n launch the instance.

    \n
  • \n
  • \n

    \n product-code.type - The type of product code (devpay\n | marketplace).

    \n
  • \n
  • \n

    \n ramdisk-id - The RAM disk ID.

    \n
  • \n
  • \n

    \n reason - The reason for the current state of the instance (for\n example, shows \"User Initiated [date]\" when you stop or terminate the instance).\n Similar to the state-reason-code filter.

    \n
  • \n
  • \n

    \n requester-id - The ID of the entity that launched the instance on\n your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so\n on).

    \n
  • \n
  • \n

    \n reservation-id - The ID of the instance's reservation. A\n reservation ID is created any time you launch an instance. A reservation ID has\n a one-to-one relationship with an instance launch request, but can be associated\n with more than one instance if you launch multiple instances using the same\n launch request. For example, if you launch one instance, you get one reservation\n ID. If you launch ten instances using the same launch request, you also get one\n reservation ID.

    \n
  • \n
  • \n

    \n root-device-name - The device name of the root device volume (for\n example, /dev/sda1).

    \n
  • \n
  • \n

    \n root-device-type - The type of the root device volume\n (ebs | instance-store).

    \n
  • \n
  • \n

    \n source-dest-check - Indicates whether the instance performs\n source/destination checking. A value of true means that checking is\n enabled, and false means that checking is disabled. The value must\n be false for the instance to perform network address translation\n (NAT) in your VPC.

    \n
  • \n
  • \n

    \n spot-instance-request-id - The ID of the Spot Instance\n request.

    \n
  • \n
  • \n

    \n state-reason-code - The reason code for the state change.

    \n
  • \n
  • \n

    \n state-reason-message - A message that describes the state\n change.

    \n
  • \n
  • \n

    \n subnet-id - The ID of the subnet for the instance.

    \n
  • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
  • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

    \n
  • \n
  • \n

    \n tenancy - The tenancy of an instance (dedicated |\n default | host).

    \n
  • \n
  • \n

    \n tpm-support - Indicates if the instance is configured for\n NitroTPM support (v2.0).

    \n
  • \n
  • \n

    \n usage-operation - The usage operation value for the instance\n (RunInstances | RunInstances:00g0 |\n RunInstances:0010 | RunInstances:1010 |\n RunInstances:1014 | RunInstances:1110 |\n RunInstances:0014 | RunInstances:0210 |\n RunInstances:0110 | RunInstances:0100 |\n RunInstances:0004 | RunInstances:0200 |\n RunInstances:000g | RunInstances:0g00 |\n RunInstances:0002 | RunInstances:0800 |\n RunInstances:0102 | RunInstances:0006 |\n RunInstances:0202).

    \n
  • \n
  • \n

    \n usage-operation-update-time - The time that the usage operation\n was last updated, for example, 2022-09-15T17:15:20.000Z.

    \n
  • \n
  • \n

    \n virtualization-type - The virtualization type of the instance\n (paravirtual | hvm).

    \n
  • \n
  • \n

    \n vpc-id - The ID of the VPC that the instance is running in.

    \n
  • \n
", + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n affinity - The affinity setting for an instance running on a\n Dedicated Host (default | host).

    \n
  • \n
  • \n

    \n architecture - The instance architecture (i386 |\n x86_64 | arm64).

    \n
  • \n
  • \n

    \n availability-zone - The Availability Zone of the instance.

    \n
  • \n
  • \n

    \n availability-zone-id - The ID of the Availability Zone of the\n instance.

    \n
  • \n
  • \n

    \n block-device-mapping.attach-time - The attach time for an EBS\n volume mapped to the instance, for example,\n 2022-09-15T17:15:20.000Z.

    \n
  • \n
  • \n

    \n block-device-mapping.delete-on-termination - A Boolean that\n indicates whether the EBS volume is deleted on instance termination.

    \n
  • \n
  • \n

    \n block-device-mapping.device-name - The device name specified in\n the block device mapping (for example, /dev/sdh or\n xvdh).

    \n
  • \n
  • \n

    \n block-device-mapping.status - The status for the EBS volume\n (attaching | attached | detaching |\n detached).

    \n
  • \n
  • \n

    \n block-device-mapping.volume-id - The volume ID of the EBS\n volume.

    \n
  • \n
  • \n

    \n boot-mode - The boot mode that was specified by the AMI\n (legacy-bios | uefi |\n uefi-preferred).

    \n
  • \n
  • \n

    \n capacity-reservation-id - The ID of the Capacity Reservation into which the\n instance was launched.

    \n
  • \n
  • \n

    \n capacity-reservation-specification.capacity-reservation-preference\n - The instance's Capacity Reservation preference (open | none).

    \n
  • \n
  • \n

    \n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id\n - The ID of the targeted Capacity Reservation.

    \n
  • \n
  • \n

    \n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn\n - The ARN of the targeted Capacity Reservation group.

    \n
  • \n
  • \n

    \n client-token - The idempotency token you provided when you\n launched the instance.

    \n
  • \n
  • \n

    \n current-instance-boot-mode - The boot mode that is used to launch\n the instance at launch or start (legacy-bios |\n uefi).

    \n
  • \n
  • \n

    \n dns-name - The public DNS name of the instance.

    \n
  • \n
  • \n

    \n ebs-optimized - A Boolean that indicates whether the instance is\n optimized for Amazon EBS I/O.

    \n
  • \n
  • \n

    \n ena-support - A Boolean that indicates whether the instance is\n enabled for enhanced networking with ENA.

    \n
  • \n
  • \n

    \n enclave-options.enabled - A Boolean that indicates whether the\n instance is enabled for Amazon Web Services Nitro Enclaves.

    \n
  • \n
  • \n

    \n hibernation-options.configured - A Boolean that indicates whether\n the instance is enabled for hibernation. A value of true means that\n the instance is enabled for hibernation.

    \n
  • \n
  • \n

    \n host-id - The ID of the Dedicated Host on which the instance is\n running, if applicable.

    \n
  • \n
  • \n

    \n hypervisor - The hypervisor type of the instance\n (ovm | xen). The value xen is used\n for both Xen and Nitro hypervisors.

    \n
  • \n
  • \n

    \n iam-instance-profile.arn - The instance profile associated with\n the instance. Specified as an ARN.

    \n
  • \n
  • \n

    \n iam-instance-profile.id - The instance profile associated with\n the instance. Specified as an ID.

    \n
  • \n
  • \n

    \n image-id - The ID of the image used to launch the\n instance.

    \n
  • \n
  • \n

    \n instance-id - The ID of the instance.

    \n
  • \n
  • \n

    \n instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or\n a Capacity Block (spot | scheduled | capacity-block).

    \n
  • \n
  • \n

    \n instance-state-code - The state of the instance, as a 16-bit\n unsigned integer. The high byte is used for internal purposes and should be\n ignored. The low byte is set based on the state represented. The valid values\n are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).

    \n
  • \n
  • \n

    \n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).

    \n
  • \n
  • \n

    \n instance-type - The type of instance (for example,\n t2.micro).

    \n
  • \n
  • \n

    \n instance.group-id - The ID of the security group for the\n instance.

    \n
  • \n
  • \n

    \n instance.group-name - The name of the security group for the\n instance.

    \n
  • \n
  • \n

    \n ip-address - The public IPv4 address of the instance.

    \n
  • \n
  • \n

    \n ipv6-address - The IPv6 address of the instance.

    \n
  • \n
  • \n

    \n kernel-id - The kernel ID.

    \n
  • \n
  • \n

    \n key-name - The name of the key pair used when the instance was\n launched.

    \n
  • \n
  • \n

    \n launch-index - When launching multiple instances, this is the\n index for the instance in the launch group (for example, 0, 1, 2, and so on).\n

    \n
  • \n
  • \n

    \n launch-time - The time when the instance was launched, in the ISO\n 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard\n (*), for example, 2021-09-29T*, which matches an\n entire day.

    \n
  • \n
  • \n

    \n maintenance-options.auto-recovery - The current automatic\n recovery behavior of the instance (disabled | default).

    \n
  • \n
  • \n

    \n metadata-options.http-endpoint - The status of access to the HTTP\n metadata endpoint on your instance (enabled |\n disabled)

    \n
  • \n
  • \n

    \n metadata-options.http-protocol-ipv4 - Indicates whether the IPv4\n endpoint is enabled (disabled | enabled).

    \n
  • \n
  • \n

    \n metadata-options.http-protocol-ipv6 - Indicates whether the IPv6\n endpoint is enabled (disabled | enabled).

    \n
  • \n
  • \n

    \n metadata-options.http-put-response-hop-limit - The HTTP metadata\n request put response hop limit (integer, possible values 1 to\n 64)

    \n
  • \n
  • \n

    \n metadata-options.http-tokens - The metadata request authorization\n state (optional | required)

    \n
  • \n
  • \n

    \n metadata-options.instance-metadata-tags - The status of access to\n instance tags from the instance metadata (enabled |\n disabled)

    \n
  • \n
  • \n

    \n metadata-options.state - The state of the metadata option changes\n (pending | applied).

    \n
  • \n
  • \n

    \n monitoring-state - Indicates whether detailed monitoring is\n enabled (disabled | enabled).

    \n
  • \n
  • \n

    \n network-interface.addresses.association.allocation-id - The allocation ID.

    \n
  • \n
  • \n

    \n network-interface.addresses.association.association-id - The association ID.

    \n
  • \n
  • \n

    \n network-interface.addresses.association.carrier-ip - The carrier IP address.

    \n
  • \n
  • \n

    \n network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.

    \n
  • \n
  • \n

    \n network-interface.addresses.association.ip-owner-id - The owner\n ID of the private IPv4 address associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.addresses.association.public-dns-name - The public DNS name.

    \n
  • \n
  • \n

    \n network-interface.addresses.association.public-ip - The ID of the\n association of an Elastic IP address (IPv4) with a network interface.

    \n
  • \n
  • \n

    \n network-interface.addresses.primary - Specifies whether the IPv4\n address of the network interface is the primary private IPv4 address.

    \n
  • \n
  • \n

    \n network-interface.addresses.private-dns-name - The private DNS name.

    \n
  • \n
  • \n

    \n network-interface.addresses.private-ip-address - The private IPv4\n address associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.association.allocation-id - The allocation ID\n returned when you allocated the Elastic IP address (IPv4) for your network\n interface.

    \n
  • \n
  • \n

    \n network-interface.association.association-id - The association ID\n returned when the network interface was associated with an IPv4 address.

    \n
  • \n
  • \n

    \n network-interface.association.carrier-ip - The customer-owned IP address.

    \n
  • \n
  • \n

    \n network-interface.association.customer-owned-ip - The customer-owned IP address.

    \n
  • \n
  • \n

    \n network-interface.association.ip-owner-id - The owner of the\n Elastic IP address (IPv4) associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.association.public-dns-name - The public DNS name.

    \n
  • \n
  • \n

    \n network-interface.association.public-ip - The address of the\n Elastic IP address (IPv4) bound to the network interface.

    \n
  • \n
  • \n

    \n network-interface.attachment.attach-time - The time that the\n network interface was attached to an instance.

    \n
  • \n
  • \n

    \n network-interface.attachment.attachment-id - The ID of the\n interface attachment.

    \n
  • \n
  • \n

    \n network-interface.attachment.delete-on-termination - Specifies\n whether the attachment is deleted when an instance is terminated.

    \n
  • \n
  • \n

    \n network-interface.attachment.device-index - The device index to\n which the network interface is attached.

    \n
  • \n
  • \n

    \n network-interface.attachment.instance-id - The ID of the instance\n to which the network interface is attached.

    \n
  • \n
  • \n

    \n network-interface.attachment.instance-owner-id - The owner ID of\n the instance to which the network interface is attached.

    \n
  • \n
  • \n

    \n network-interface.attachment.network-card-index - The index of the network card.

    \n
  • \n
  • \n

    \n network-interface.attachment.status - The status of the\n attachment (attaching | attached |\n detaching | detached).

    \n
  • \n
  • \n

    \n network-interface.availability-zone - The Availability Zone for\n the network interface.

    \n
  • \n
  • \n

    \n network-interface.deny-all-igw-traffic - A Boolean that indicates whether \n a network interface with an IPv6 address is unreachable from the public internet.

    \n
  • \n
  • \n

    \n network-interface.description - The description of the network\n interface.

    \n
  • \n
  • \n

    \n network-interface.group-id - The ID of a security group\n associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.group-name - The name of a security group\n associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network interface.

    \n
  • \n
  • \n

    \n network-interface.ipv6-address - The IPv6 address associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.ipv6-addresses.ipv6-address - The IPv6 address\n associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this\n is the primary IPv6 address.

    \n
  • \n
  • \n

    \n network-interface.ipv6-native - A Boolean that indicates whether this is\n an IPv6 only network interface.

    \n
  • \n
  • \n

    \n network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.

    \n
  • \n
  • \n

    \n network-interface.mac-address - The MAC address of the network\n interface.

    \n
  • \n
  • \n

    \n network-interface.network-interface-id - The ID of the network\n interface.

    \n
  • \n
  • \n

    \n network-interface.operator.managed - A Boolean that indicates\n whether the instance has a managed network interface.

    \n
  • \n
  • \n

    \n network-interface.operator.principal - The principal that manages\n the network interface. Only valid for instances with managed network interfaces,\n where managed is true.

    \n
  • \n
  • \n

    \n network-interface.outpost-arn - The ARN of the Outpost.

    \n
  • \n
  • \n

    \n network-interface.owner-id - The ID of the owner of the network\n interface.

    \n
  • \n
  • \n

    \n network-interface.private-dns-name - The private DNS name of the\n network interface.

    \n
  • \n
  • \n

    \n network-interface.private-ip-address - The private IPv4 address.

    \n
  • \n
  • \n

    \n network-interface.public-dns-name - The public DNS name.

    \n
  • \n
  • \n

    \n network-interface.requester-id - The requester ID for the network\n interface.

    \n
  • \n
  • \n

    \n network-interface.requester-managed - Indicates whether the\n network interface is being managed by Amazon Web Services.

    \n
  • \n
  • \n

    \n network-interface.status - The status of the network interface\n (available) | in-use).

    \n
  • \n
  • \n

    \n network-interface.source-dest-check - Whether the network\n interface performs source/destination checking. A value of true\n means that checking is enabled, and false means that checking is\n disabled. The value must be false for the network interface to\n perform network address translation (NAT) in your VPC.

    \n
  • \n
  • \n

    \n network-interface.subnet-id - The ID of the subnet for the\n network interface.

    \n
  • \n
  • \n

    \n network-interface.tag-key - The key of a tag assigned to the network interface.

    \n
  • \n
  • \n

    \n network-interface.tag-value - The value of a tag assigned to the network interface.

    \n
  • \n
  • \n

    \n network-interface.vpc-id - The ID of the VPC for the network\n interface.

    \n
  • \n
  • \n

    \n network-performance-options.bandwidth-weighting - Where the performance boost \n \t\t\tis applied, if applicable. Valid values: default, vpc-1, \n \t\t\tebs-1.

    \n
  • \n
  • \n

    \n operator.managed - A Boolean that indicates whether this is a\n managed instance.

    \n
  • \n
  • \n

    \n operator.principal - The principal that manages the instance.\n Only valid for managed instances, where managed is\n true.

    \n
  • \n
  • \n

    \n outpost-arn - The Amazon Resource Name (ARN) of the\n Outpost.

    \n
  • \n
  • \n

    \n owner-id - The Amazon Web Services account ID of the instance\n owner.

    \n
  • \n
  • \n

    \n placement-group-name - The name of the placement group for the\n instance.

    \n
  • \n
  • \n

    \n placement-partition-number - The partition in which the instance is\n located.

    \n
  • \n
  • \n

    \n platform - The platform. To list only Windows instances, use\n windows.

    \n
  • \n
  • \n

    \n platform-details - The platform (Linux/UNIX |\n Red Hat BYOL Linux | Red Hat Enterprise Linux |\n Red Hat Enterprise Linux with HA | Red Hat Enterprise Linux with High Availability | Red Hat Enterprise\n Linux with SQL Server Standard and HA | Red Hat Enterprise\n Linux with SQL Server Enterprise and HA | Red Hat Enterprise\n Linux with SQL Server Standard | Red Hat Enterprise Linux with\n SQL Server Web | Red Hat Enterprise Linux with SQL Server\n Enterprise | SQL Server Enterprise | SQL Server\n Standard | SQL Server Web | SUSE Linux |\n Ubuntu Pro | Windows | Windows BYOL |\n Windows with SQL Server Enterprise | Windows with SQL\n Server Standard | Windows with SQL Server Web).

    \n
  • \n
  • \n

    \n private-dns-name - The private IPv4 DNS name of the\n instance.

    \n
  • \n
  • \n

    \n private-dns-name-options.enable-resource-name-dns-a-record - A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS A records.

    \n
  • \n
  • \n

    \n private-dns-name-options.enable-resource-name-dns-aaaa-record - A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS AAAA records.

    \n
  • \n
  • \n

    \n private-dns-name-options.hostname-type - The type of hostname\n (ip-name | resource-name).

    \n
  • \n
  • \n

    \n private-ip-address - The private IPv4 address of the instance.\n This can only be used to filter by the primary IP address of the network\n interface attached to the instance. To filter by additional IP addresses\n assigned to the network interface, use the filter\n network-interface.addresses.private-ip-address.

    \n
  • \n
  • \n

    \n product-code - The product code associated with the AMI used to\n launch the instance.

    \n
  • \n
  • \n

    \n product-code.type - The type of product code (devpay\n | marketplace).

    \n
  • \n
  • \n

    \n ramdisk-id - The RAM disk ID.

    \n
  • \n
  • \n

    \n reason - The reason for the current state of the instance (for\n example, shows \"User Initiated [date]\" when you stop or terminate the instance).\n Similar to the state-reason-code filter.

    \n
  • \n
  • \n

    \n requester-id - The ID of the entity that launched the instance on\n your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so\n on).

    \n
  • \n
  • \n

    \n reservation-id - The ID of the instance's reservation. A\n reservation ID is created any time you launch an instance. A reservation ID has\n a one-to-one relationship with an instance launch request, but can be associated\n with more than one instance if you launch multiple instances using the same\n launch request. For example, if you launch one instance, you get one reservation\n ID. If you launch ten instances using the same launch request, you also get one\n reservation ID.

    \n
  • \n
  • \n

    \n root-device-name - The device name of the root device volume (for\n example, /dev/sda1).

    \n
  • \n
  • \n

    \n root-device-type - The type of the root device volume\n (ebs | instance-store).

    \n
  • \n
  • \n

    \n source-dest-check - Indicates whether the instance performs\n source/destination checking. A value of true means that checking is\n enabled, and false means that checking is disabled. The value must\n be false for the instance to perform network address translation\n (NAT) in your VPC.

    \n
  • \n
  • \n

    \n spot-instance-request-id - The ID of the Spot Instance\n request.

    \n
  • \n
  • \n

    \n state-reason-code - The reason code for the state change.

    \n
  • \n
  • \n

    \n state-reason-message - A message that describes the state\n change.

    \n
  • \n
  • \n

    \n subnet-id - The ID of the subnet for the instance.

    \n
  • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
  • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

    \n
  • \n
  • \n

    \n tenancy - The tenancy of an instance (dedicated |\n default | host).

    \n
  • \n
  • \n

    \n tpm-support - Indicates if the instance is configured for\n NitroTPM support (v2.0).

    \n
  • \n
  • \n

    \n usage-operation - The usage operation value for the instance\n (RunInstances | RunInstances:00g0 |\n RunInstances:0010 | RunInstances:1010 |\n RunInstances:1014 | RunInstances:1110 |\n RunInstances:0014 | RunInstances:0210 |\n RunInstances:0110 | RunInstances:0100 |\n RunInstances:0004 | RunInstances:0200 |\n RunInstances:000g | RunInstances:0g00 |\n RunInstances:0002 | RunInstances:0800 |\n RunInstances:0102 | RunInstances:0006 |\n RunInstances:0202).

    \n
  • \n
  • \n

    \n usage-operation-update-time - The time that the usage operation\n was last updated, for example, 2022-09-15T17:15:20.000Z.

    \n
  • \n
  • \n

    \n virtualization-type - The virtualization type of the instance\n (paravirtual | hvm).

    \n
  • \n
  • \n

    \n vpc-id - The ID of the VPC that the instance is running in.

    \n
  • \n
", "smithy.api#xmlName": "Filter" } }, @@ -42998,7 +43588,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n availability-zone-group - The Availability Zone group.

    \n
  • \n
  • \n

    \n create-time - The time stamp when the Spot Instance request was\n created.

    \n
  • \n
  • \n

    \n fault-code - The fault code related to the request.

    \n
  • \n
  • \n

    \n fault-message - The fault message related to the request.

    \n
  • \n
  • \n

    \n instance-id - The ID of the instance that fulfilled the\n request.

    \n
  • \n
  • \n

    \n launch-group - The Spot Instance launch group.

    \n
  • \n
  • \n

    \n launch.block-device-mapping.delete-on-termination - Indicates\n whether the EBS volume is deleted on instance termination.

    \n
  • \n
  • \n

    \n launch.block-device-mapping.device-name - The device name for the\n volume in the block device mapping (for example, /dev/sdh or\n xvdh).

    \n
  • \n
  • \n

    \n launch.block-device-mapping.snapshot-id - The ID of the snapshot\n for the EBS volume.

    \n
  • \n
  • \n

    \n launch.block-device-mapping.volume-size - The size of the EBS\n volume, in GiB.

    \n
  • \n
  • \n

    \n launch.block-device-mapping.volume-type - The type of EBS volume:\n gp2 or gp3 for General Purpose SSD, io1 \n or io2 for Provisioned IOPS SSD, st1 for Throughput\n Optimized HDD, sc1 for Cold HDD, or standard for\n Magnetic.

    \n
  • \n
  • \n

    \n launch.group-id - The ID of the security group for the\n instance.

    \n
  • \n
  • \n

    \n launch.group-name - The name of the security group for the\n instance.

    \n
  • \n
  • \n

    \n launch.image-id - The ID of the AMI.

    \n
  • \n
  • \n

    \n launch.instance-type - The type of instance (for example,\n m3.medium).

    \n
  • \n
  • \n

    \n launch.kernel-id - The kernel ID.

    \n
  • \n
  • \n

    \n launch.key-name - The name of the key pair the instance launched\n with.

    \n
  • \n
  • \n

    \n launch.monitoring-enabled - Whether detailed monitoring is\n enabled for the Spot Instance.

    \n
  • \n
  • \n

    \n launch.ramdisk-id - The RAM disk ID.

    \n
  • \n
  • \n

    \n launched-availability-zone - The Availability Zone in which the\n request is launched.

    \n
  • \n
  • \n

    \n network-interface.addresses.primary - Indicates whether the IP\n address is the primary private IP address.

    \n
  • \n
  • \n

    \n network-interface.delete-on-termination - Indicates whether the\n network interface is deleted when the instance is terminated.

    \n
  • \n
  • \n

    \n network-interface.description - A description of the network\n interface.

    \n
  • \n
  • \n

    \n network-interface.device-index - The index of the device for the\n network interface attachment on the instance.

    \n
  • \n
  • \n

    \n network-interface.group-id - The ID of the security group\n associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.network-interface-id - The ID of the network\n interface.

    \n
  • \n
  • \n

    \n network-interface.private-ip-address - The primary private IP\n address of the network interface.

    \n
  • \n
  • \n

    \n network-interface.subnet-id - The ID of the subnet for the\n instance.

    \n
  • \n
  • \n

    \n product-description - The product description associated with the\n instance (Linux/UNIX | Windows).

    \n
  • \n
  • \n

    \n spot-instance-request-id - The Spot Instance request ID.

    \n
  • \n
  • \n

    \n spot-price - The maximum hourly price for any Spot Instance\n launched to fulfill the request.

    \n
  • \n
  • \n

    \n state - The state of the Spot Instance request (open\n | active | closed | cancelled |\n failed). Spot request status information can help you track\n your Amazon EC2 Spot Instance requests. For more information, see Spot\n request status in the Amazon EC2 User Guide.

    \n
  • \n
  • \n

    \n status-code - The short code describing the most recent\n evaluation of your Spot Instance request.

    \n
  • \n
  • \n

    \n status-message - The message explaining the status of the Spot\n Instance request.

    \n
  • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
  • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
  • \n
  • \n

    \n type - The type of Spot Instance request (one-time |\n persistent).

    \n
  • \n
  • \n

    \n valid-from - The start date of the request.

    \n
  • \n
  • \n

    \n valid-until - The end date of the request.

    \n
  • \n
", + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n availability-zone-group - The Availability Zone group.

    \n
  • \n
  • \n

    \n create-time - The time stamp when the Spot Instance request was\n created.

    \n
  • \n
  • \n

    \n fault-code - The fault code related to the request.

    \n
  • \n
  • \n

    \n fault-message - The fault message related to the request.

    \n
  • \n
  • \n

    \n instance-id - The ID of the instance that fulfilled the\n request.

    \n
  • \n
  • \n

    \n launch-group - The Spot Instance launch group.

    \n
  • \n
  • \n

    \n launch.block-device-mapping.delete-on-termination - Indicates\n whether the EBS volume is deleted on instance termination.

    \n
  • \n
  • \n

    \n launch.block-device-mapping.device-name - The device name for the\n volume in the block device mapping (for example, /dev/sdh or\n xvdh).

    \n
  • \n
  • \n

    \n launch.block-device-mapping.snapshot-id - The ID of the snapshot\n for the EBS volume.

    \n
  • \n
  • \n

    \n launch.block-device-mapping.volume-size - The size of the EBS\n volume, in GiB.

    \n
  • \n
  • \n

    \n launch.block-device-mapping.volume-type - The type of EBS volume:\n gp2 or gp3 for General Purpose SSD, io1 \n or io2 for Provisioned IOPS SSD, st1 for Throughput\n Optimized HDD, sc1 for Cold HDD, or standard for\n Magnetic.

    \n
  • \n
  • \n

    \n launch.group-id - The ID of the security group for the\n instance.

    \n
  • \n
  • \n

    \n launch.group-name - The name of the security group for the\n instance.

    \n
  • \n
  • \n

    \n launch.image-id - The ID of the AMI.

    \n
  • \n
  • \n

    \n launch.instance-type - The type of instance (for example,\n m3.medium).

    \n
  • \n
  • \n

    \n launch.kernel-id - The kernel ID.

    \n
  • \n
  • \n

    \n launch.key-name - The name of the key pair the instance launched\n with.

    \n
  • \n
  • \n

    \n launch.monitoring-enabled - Whether detailed monitoring is\n enabled for the Spot Instance.

    \n
  • \n
  • \n

    \n launch.ramdisk-id - The RAM disk ID.

    \n
  • \n
  • \n

    \n launched-availability-zone - The Availability Zone in which the\n request is launched.

    \n
  • \n
  • \n

    \n launched-availability-zone-id - The ID of the Availability Zone\n in which the request is launched.

    \n
  • \n
  • \n

    \n network-interface.addresses.primary - Indicates whether the IP\n address is the primary private IP address.

    \n
  • \n
  • \n

    \n network-interface.delete-on-termination - Indicates whether the\n network interface is deleted when the instance is terminated.

    \n
  • \n
  • \n

    \n network-interface.description - A description of the network\n interface.

    \n
  • \n
  • \n

    \n network-interface.device-index - The index of the device for the\n network interface attachment on the instance.

    \n
  • \n
  • \n

    \n network-interface.group-id - The ID of the security group\n associated with the network interface.

    \n
  • \n
  • \n

    \n network-interface.network-interface-id - The ID of the network\n interface.

    \n
  • \n
  • \n

    \n network-interface.private-ip-address - The primary private IP\n address of the network interface.

    \n
  • \n
  • \n

    \n network-interface.subnet-id - The ID of the subnet for the\n instance.

    \n
  • \n
  • \n

    \n product-description - The product description associated with the\n instance (Linux/UNIX | Windows).

    \n
  • \n
  • \n

    \n spot-instance-request-id - The Spot Instance request ID.

    \n
  • \n
  • \n

    \n spot-price - The maximum hourly price for any Spot Instance\n launched to fulfill the request.

    \n
  • \n
  • \n

    \n state - The state of the Spot Instance request (open\n | active | closed | cancelled |\n failed). Spot request status information can help you track\n your Amazon EC2 Spot Instance requests. For more information, see Spot\n request status in the Amazon EC2 User Guide.

    \n
  • \n
  • \n

    \n status-code - The short code describing the most recent\n evaluation of your Spot Instance request.

    \n
  • \n
  • \n

    \n status-message - The message explaining the status of the Spot\n Instance request.

    \n
  • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
  • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
  • \n
  • \n

    \n type - The type of Spot Instance request (one-time |\n persistent).

    \n
  • \n
  • \n

    \n valid-from - The start date of the request.

    \n
  • \n
  • \n

    \n valid-until - The end date of the request.

    \n
  • \n
", "smithy.api#xmlName": "Filter" } } @@ -43088,6 +43678,12 @@ "com.amazonaws.ec2#DescribeSpotPriceHistoryRequest": { "type": "structure", "members": { + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#AvailabilityZoneId", + "traits": { + "smithy.api#documentation": "

Filters the results by the specified ID of the Availability Zone.

\n

Either AvailabilityZone or AvailabilityZoneId can be specified, but not both

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -43129,7 +43725,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n availability-zone - The Availability Zone for which prices should\n be returned.

    \n
  • \n
  • \n

    \n instance-type - The type of instance (for example,\n m3.medium).

    \n
  • \n
  • \n

    \n product-description - The product description for the Spot price\n (Linux/UNIX | Red Hat Enterprise Linux |\n SUSE Linux | Windows | Linux/UNIX (Amazon\n VPC) | Red Hat Enterprise Linux (Amazon VPC) |\n SUSE Linux (Amazon VPC) | Windows (Amazon\n VPC)).

    \n
  • \n
  • \n

    \n spot-price - The Spot price. The value must match exactly (or use\n wildcards; greater than or less than comparison is not supported).

    \n
  • \n
  • \n

    \n timestamp - The time stamp of the Spot price history, in UTC format\n (for example, ddd MMM dd\n HH:mm:ss UTC\n YYYY). You can use wildcards (* and\n ?). Greater than or less than comparison is not\n supported.

    \n
  • \n
", + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n availability-zone - The Availability Zone for which prices should\n be returned.

    \n
  • \n
  • \n

    \n availability-zone-id - The ID of the Availability Zone for which\n prices should be returned.

    \n
  • \n
  • \n

    \n instance-type - The type of instance (for example,\n m3.medium).

    \n
  • \n
  • \n

    \n product-description - The product description for the Spot price\n (Linux/UNIX | Red Hat Enterprise Linux |\n SUSE Linux | Windows | Linux/UNIX (Amazon\n VPC) | Red Hat Enterprise Linux (Amazon VPC) |\n SUSE Linux (Amazon VPC) | Windows (Amazon\n VPC)).

    \n
  • \n
  • \n

    \n spot-price - The Spot price. The value must match exactly (or use\n wildcards; greater than or less than comparison is not supported).

    \n
  • \n
  • \n

    \n timestamp - The time stamp of the Spot price history, in UTC format\n (for example, ddd MMM dd\n HH:mm:ss UTC\n YYYY). You can use wildcards (* and\n ?). Greater than or less than comparison is not\n supported.

    \n
  • \n
", "smithy.api#xmlName": "Filter" } }, @@ -43137,7 +43733,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

Filters the results by the specified Availability Zone.

", + "smithy.api#documentation": "

Filters the results by the specified Availability Zone.

\n

Either AvailabilityZone or AvailabilityZoneId can be specified, but not both

", "smithy.api#xmlName": "availabilityZone" } }, @@ -45862,7 +46458,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n attachment.attach-time - The time stamp when the attachment\n initiated.

    \n
  • \n
  • \n

    \n attachment.delete-on-termination - Whether the volume is deleted on\n instance termination.

    \n
  • \n
  • \n

    \n attachment.device - The device name specified in the block device mapping\n (for example, /dev/sda1).

    \n
  • \n
  • \n

    \n attachment.instance-id - The ID of the instance the volume is attached\n to.

    \n
  • \n
  • \n

    \n attachment.status - The attachment state (attaching |\n attached | detaching).

    \n
  • \n
  • \n

    \n availability-zone - The Availability Zone in which the volume was\n created.

    \n
  • \n
  • \n

    \n create-time - The time stamp when the volume was created.

    \n
  • \n
  • \n

    \n encrypted - Indicates whether the volume is encrypted (true\n | false)

    \n
  • \n
  • \n

    \n fast-restored - Indicates whether the volume was created from a \n snapshot that is enabled for fast snapshot restore (true | \n false).

    \n
  • \n
  • \n

    \n multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true\n \t\t\t| false)

    \n
  • \n
  • \n

    \n operator.managed - A Boolean that indicates whether this is a managed\n volume.

    \n
  • \n
  • \n

    \n operator.principal - The principal that manages the volume. Only valid\n for managed volumes, where managed is true.

    \n
  • \n
  • \n

    \n size - The size of the volume, in GiB.

    \n
  • \n
  • \n

    \n snapshot-id - The snapshot from which the volume was created.

    \n
  • \n
  • \n

    \n status - The state of the volume (creating |\n available | in-use | deleting |\n deleted | error).

    \n
  • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
  • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
  • \n
  • \n

    \n volume-id - The volume ID.

    \n
  • \n
  • \n

    \n volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | \n st1 | sc1| standard)

    \n
  • \n
", + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n attachment.attach-time - The time stamp when the attachment\n initiated.

    \n
  • \n
  • \n

    \n attachment.delete-on-termination - Whether the volume is deleted on\n instance termination.

    \n
  • \n
  • \n

    \n attachment.device - The device name specified in the block device mapping\n (for example, /dev/sda1).

    \n
  • \n
  • \n

    \n attachment.instance-id - The ID of the instance the volume is attached\n to.

    \n
  • \n
  • \n

    \n attachment.status - The attachment state (attaching |\n attached | detaching).

    \n
  • \n
  • \n

    \n availability-zone - The Availability Zone in which the volume was\n created.

    \n
  • \n
  • \n

    \n availability-zone-id - The ID of the Availability Zone in which the\n volume was created.

    \n
  • \n
  • \n

    \n create-time - The time stamp when the volume was created.

    \n
  • \n
  • \n

    \n encrypted - Indicates whether the volume is encrypted (true\n | false)

    \n
  • \n
  • \n

    \n fast-restored - Indicates whether the volume was created from a \n snapshot that is enabled for fast snapshot restore (true | \n false).

    \n
  • \n
  • \n

    \n multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true\n \t\t\t| false)

    \n
  • \n
  • \n

    \n operator.managed - A Boolean that indicates whether this is a managed\n volume.

    \n
  • \n
  • \n

    \n operator.principal - The principal that manages the volume. Only valid\n for managed volumes, where managed is true.

    \n
  • \n
  • \n

    \n size - The size of the volume, in GiB.

    \n
  • \n
  • \n

    \n snapshot-id - The snapshot from which the volume was created.

    \n
  • \n
  • \n

    \n status - The state of the volume (creating |\n available | in-use | deleting |\n deleted | error).

    \n
  • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
  • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
  • \n
  • \n

    \n volume-id - The volume ID.

    \n
  • \n
  • \n

    \n volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | \n st1 | sc1| standard)

    \n
  • \n
", "smithy.api#xmlName": "Filter" } }, @@ -46332,7 +46928,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n vpc-endpoint-id - The ID of the VPC endpoint.

    \n
  • \n
  • \n

    \n associated-resource-accessibility - The association state. When the\n state is accessible, it returns AVAILABLE. When the state\n is inaccessible, it returns PENDING or\n FAILED.

    \n
  • \n
  • \n

    \n association-id - The ID of the VPC endpoint association.

    \n
  • \n
  • \n

    \n associated-resource-id - The ID of the associated resource\n configuration.

    \n
  • \n
  • \n

    \n service-network-arn - The Amazon Resource Name (ARN) of the\n associated service network. Only VPC endpoints of type service network will be\n returned.

    \n
  • \n
  • \n

    \n resource-configuration-group-arn - The Amazon Resource Name (ARN) of\n the resource configuration of type GROUP.

    \n
  • \n
  • \n

    \n service-network-resource-association-id - The ID of the\n association.

    \n
  • \n
", + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n vpc-endpoint-id - The ID of the VPC endpoint.

    \n
  • \n
  • \n

    \n associated-resource-accessibility - The association state. When the\n state is accessible, it returns AVAILABLE. When the state\n is inaccessible, it returns PENDING or\n FAILED.

    \n
  • \n
  • \n

    \n association-id - The ID of the VPC endpoint association.

    \n
  • \n
  • \n

    \n associated-resource-id - The ID of the associated resource\n configuration.

    \n
  • \n
  • \n

    \n service-network-arn - The Amazon Resource Name (ARN) of the\n associated service network. Only VPC endpoints of type service network will be\n returned.

    \n
  • \n
  • \n

    \n resource-configuration-group-arn - The Amazon Resource Name (ARN) of\n the resource configuration of type GROUP.

    \n
  • \n
", "smithy.api#xmlName": "Filter" } }, @@ -48599,7 +49195,7 @@ "target": "com.amazonaws.ec2#DisableImageBlockPublicAccessResult" }, "traits": { - "smithy.api#documentation": "

Disables block public access for AMIs at the account level in the\n specified Amazon Web Services Region. This removes the block public access restriction\n from your account. With the restriction removed, you can publicly share your AMIs in the\n specified Amazon Web Services Region.

\n

The API can take up to 10 minutes to configure this setting. During this time, if you run\n GetImageBlockPublicAccessState, the response will be\n block-new-sharing. When the API has completed the configuration, the response\n will be unblocked.

\n

For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Disables block public access for AMIs at the account level in the\n specified Amazon Web Services Region. This removes the block public access restriction\n from your account. With the restriction removed, you can publicly share your AMIs in the\n specified Amazon Web Services Region.

\n

For more information, see Block\n public access to your AMIs in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#DisableImageBlockPublicAccessRequest": { @@ -50694,7 +51290,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "Iops", - "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes,\n this represents the number of IOPS that are provisioned for the volume. For gp2\n volumes, this represents the baseline performance of the volume and the rate at which\n the volume accumulates I/O credits for bursting.

\n

The following are the supported values for each volume type:

\n
    \n
  • \n

    \n gp3: 3,000 - 16,000 IOPS

    \n
  • \n
  • \n

    \n io1: 100 - 64,000 IOPS

    \n
  • \n
  • \n

    \n io2: 100 - 256,000 IOPS

    \n
  • \n
\n

For io2 volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

\n

This parameter is required for io1 and io2 volumes. The default for gp3 volumes\n is 3,000 IOPS.

", + "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes,\n this represents the number of IOPS that are provisioned for the volume. For gp2\n volumes, this represents the baseline performance of the volume and the rate at which\n the volume accumulates I/O credits for bursting.

\n

The following are the supported values for each volume type:

\n
    \n
  • \n

    \n gp3: 3,000 - 80,000 IOPS

    \n
  • \n
  • \n

    \n io1: 100 - 64,000 IOPS

    \n
  • \n
  • \n

    \n io2: 100 - 256,000 IOPS

    \n
  • \n
\n

For io2 volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

\n

This parameter is required for io1 and io2 volumes. The default for gp3 volumes\n is 3,000 IOPS.

", "smithy.api#xmlName": "iops" } }, @@ -50710,7 +51306,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "VolumeSize", - "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. If you specify a snapshot, the default is the snapshot size. You can specify a\n volume size that is equal to or larger than the snapshot size.

\n

The following are the supported sizes for each volume type:

\n
    \n
  • \n

    \n gp2 and gp3: 1 - 16,384 GiB

    \n
  • \n
  • \n

    \n io1: 4 - 16,384 GiB

    \n
  • \n
  • \n

    \n io2: 4 - 65,536 GiB

    \n
  • \n
  • \n

    \n st1 and sc1: 125 - 16,384 GiB

    \n
  • \n
  • \n

    \n standard: 1 - 1024 GiB

    \n
  • \n
", + "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. If you specify a snapshot, the default is the snapshot size. You can specify a\n volume size that is equal to or larger than the snapshot size.

\n

The following are the supported sizes for each volume type:

\n
    \n
  • \n

    \n gp2: 1 - 16,384 GiB

    \n
  • \n
  • \n

    \n gp3: 1 - 65,536 GiB

    \n
  • \n
  • \n

    \n io1: 4 - 16,384 GiB

    \n
  • \n
  • \n

    \n io2: 4 - 65,536 GiB

    \n
  • \n
  • \n

    \n st1 and sc1: 125 - 16,384 GiB

    \n
  • \n
  • \n

    \n standard: 1 - 1024 GiB

    \n
  • \n
", "smithy.api#xmlName": "volumeSize" } }, @@ -50734,7 +51330,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "Throughput", - "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

", + "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 2,000.

", "smithy.api#xmlName": "throughput" } }, @@ -50902,6 +51498,22 @@ "smithy.api#documentation": "

Indicates whether non-volatile memory express (NVMe) is supported.

", "smithy.api#xmlName": "nvmeSupport" } + }, + "MaximumEbsAttachments": { + "target": "com.amazonaws.ec2#MaximumEbsAttachments", + "traits": { + "aws.protocols#ec2QueryName": "MaximumEbsAttachments", + "smithy.api#documentation": "

Indicates the maximum number of Amazon EBS volumes that can be attached to \n the instance type. For more information, see Amazon EBS volume limits for \n Amazon EC2 instances in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "maximumEbsAttachments" + } + }, + "AttachmentLimitType": { + "target": "com.amazonaws.ec2#AttachmentLimitType", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentLimitType", + "smithy.api#documentation": "

Indicates whether the instance type features a shared or dedicated Amazon EBS \n volume attachment limit. For more information, see Amazon EBS volume limits for \n Amazon EC2 instances in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "attachmentLimitType" + } } }, "traits": { @@ -51293,6 +51905,14 @@ "smithy.api#documentation": "

The IP address type of the endpoint.

", "smithy.api#xmlName": "ipAddressType" } + }, + "PublicDnsNames": { + "target": "com.amazonaws.ec2#InstanceConnectEndpointPublicDnsNames", + "traits": { + "aws.protocols#ec2QueryName": "PublicDnsNames", + "smithy.api#documentation": "

The public DNS names of the endpoint.

", + "smithy.api#xmlName": "publicDnsNames" + } } }, "traits": { @@ -51337,6 +51957,24 @@ "traits": { "smithy.api#enumValue": "delete-failed" } + }, + "update_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "update-in-progress" + } + }, + "update_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "update-complete" + } + }, + "update_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "update-failed" + } } } }, @@ -53268,6 +53906,29 @@ } } }, + "com.amazonaws.ec2#EndpointIpAddressType": { + "type": "enum", + "members": { + "ipv4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "ipv6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + }, + "dual_stack": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dual-stack" + } + } + } + }, "com.amazonaws.ec2#EndpointSet": { "type": "list", "member": { @@ -55412,7 +56073,7 @@ "target": "com.amazonaws.ec2#FleetActivityStatus", "traits": { "aws.protocols#ec2QueryName": "ActivityStatus", - "smithy.api#documentation": "

The progress of the EC2 Fleet. If there is an error, the status is error. After\n all requests are placed, the status is pending_fulfillment. If the size of the\n EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled.\n If the size of the EC2 Fleet is decreased, the status is pending_termination while\n instances are terminating.

", + "smithy.api#documentation": "

The progress of the EC2 Fleet.

\n

For fleets of type instant, the status is fulfilled after all\n requests are placed, regardless of whether target capacity is met (this is the only\n possible status for instant fleets).

\n

For fleets of type request or maintain, the status is\n pending_fulfillment after all requests are placed, fulfilled\n when the fleet size meets or exceeds target capacity, pending_termination\n while instances are terminating when fleet size is decreased, and error if\n there's an error.

", "smithy.api#xmlName": "activityStatus" } }, @@ -55599,13 +56260,13 @@ "Iops": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes,\n this represents the number of IOPS that are provisioned for the volume. For gp2\n volumes, this represents the baseline performance of the volume and the rate at which\n the volume accumulates I/O credits for bursting.

\n

The following are the supported values for each volume type:

\n
    \n
  • \n

    \n gp3: 3,000 - 16,000 IOPS

    \n
  • \n
  • \n

    \n io1: 100 - 64,000 IOPS

    \n
  • \n
  • \n

    \n io2: 100 - 256,000 IOPS

    \n
  • \n
\n

For io2 volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

\n

This parameter is required for io1 and io2 volumes. The default for gp3 volumes\n is 3,000 IOPS.

" + "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes,\n this represents the number of IOPS that are provisioned for the volume. For gp2\n volumes, this represents the baseline performance of the volume and the rate at which\n the volume accumulates I/O credits for bursting.

\n

The following are the supported values for each volume type:

\n
    \n
  • \n

    \n gp3: 3,000 - 80,000 IOPS

    \n
  • \n
  • \n

    \n io1: 100 - 64,000 IOPS

    \n
  • \n
  • \n

    \n io2: 100 - 256,000 IOPS

    \n
  • \n
\n

For io2 volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

\n

This parameter is required for io1 and io2 volumes. The default for gp3 volumes\n is 3,000 IOPS.

" } }, "Throughput": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" + "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 2,000.

" } }, "KmsKeyId": { @@ -55623,7 +56284,7 @@ "VolumeSize": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. If you specify a snapshot, the default is the snapshot size. You can specify a\n volume size that is equal to or larger than the snapshot size.

\n

The following are the supported sizes for each volume type:

\n
    \n
  • \n

    \n gp2 and gp3: 1 - 16,384 GiB

    \n
  • \n
  • \n

    \n io1: 4 - 16,384 GiB

    \n
  • \n
  • \n

    \n io2: 4 - 65,536 GiB

    \n
  • \n
  • \n

    \n st1 and sc1: 125 - 16,384 GiB

    \n
  • \n
  • \n

    \n standard: 1 - 1024 GiB

    \n
  • \n
" + "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. If you specify a snapshot, the default is the snapshot size. You can specify a\n volume size that is equal to or larger than the snapshot size.

\n

The following are the supported sizes for each volume type:

\n
    \n
  • \n

    \n gp2: 1 - 16,384 GiB

    \n
  • \n
  • \n

    \n gp3: 1 - 65,536 GiB

    \n
  • \n
  • \n

    \n io1: 4 - 16,384 GiB

    \n
  • \n
  • \n

    \n io2: 4 - 65,536 GiB

    \n
  • \n
  • \n

    \n st1 and sc1: 125 - 16,384 GiB

    \n
  • \n
  • \n

    \n standard: 1 - 1024 GiB

    \n
  • \n
" } }, "VolumeType": { @@ -58082,7 +58743,7 @@ "target": "com.amazonaws.ec2#GetInstanceMetadataDefaultsResult" }, "traits": { - "smithy.api#documentation": "

Gets the default instance metadata service (IMDS) settings that are set at the account\n level in the specified Amazon Web Services\u2028 Region.

\n

For more information, see Order of precedence for instance metadata options in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Gets the default instance metadata service (IMDS) settings that are set at the account\n level in the specified Amazon Web Services\u2028 Region.

\n

For more information, see Order of precedence for instance metadata options in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#GetInstanceMetadataDefaultsRequest": { @@ -62941,13 +63602,45 @@ "target": "com.amazonaws.ec2#ImageProviderList", "traits": { "aws.protocols#ec2QueryName": "ImageProviderSet", - "smithy.api#documentation": "

A list of AMI providers whose AMIs are discoverable and useable in the account. Up to a\n total of 200 values can be specified.

\n

Possible values:

\n

\n amazon: Allow AMIs created by Amazon Web Services.

\n

\n aws-marketplace: Allow AMIs created by verified providers in the Amazon Web Services\n Marketplace.

\n

\n aws-backup-vault: Allow AMIs created by Amazon Web Services Backup.

\n

12-digit account ID: Allow AMIs created by this account. One or more account IDs can be\n specified.

\n

\n none: Allow AMIs created by your own account only.

", + "smithy.api#documentation": "

The image providers whose images are allowed.

\n

Possible values:

\n
    \n
  • \n

    \n amazon: Allow AMIs created by Amazon or verified providers.

    \n
  • \n
  • \n

    \n aws-marketplace: Allow AMIs created by verified providers in the Amazon Web Services\n Marketplace.

    \n
  • \n
  • \n

    \n aws-backup-vault: Allow AMIs created by Amazon Web Services Backup.

    \n
  • \n
  • \n

    12-digit account ID: Allow AMIs created by this account. One or more account IDs can be\n specified.

    \n
  • \n
  • \n

    \n none: Allow AMIs created by your own account only.

    \n
  • \n
\n

Maximum: 200 values

", "smithy.api#xmlName": "imageProviderSet" } + }, + "MarketplaceProductCodes": { + "target": "com.amazonaws.ec2#MarketplaceProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "MarketplaceProductCodeSet", + "smithy.api#documentation": "

The Amazon Web Services Marketplace product codes for allowed images.

\n

Length: 1-25 characters

\n

Valid characters: Letters (A–Z, a–z) and numbers (0–9)

\n

Maximum: 50 values

", + "smithy.api#xmlName": "marketplaceProductCodeSet" + } + }, + "ImageNames": { + "target": "com.amazonaws.ec2#ImageNameList", + "traits": { + "aws.protocols#ec2QueryName": "ImageNameSet", + "smithy.api#documentation": "

The names of allowed images. Names can include wildcards (? and\n *).

\n

Length: 1–128 characters. With ?, the minimum is 3 characters.

\n

Valid characters:

\n
    \n
  • \n

    Letters: A–Z, a–z\n

    \n
  • \n
  • \n

    Numbers: 0–9\n

    \n
  • \n
  • \n

    Special characters: ( ) [ ] . / - ' @ _ * ?\n

    \n
  • \n
  • \n

    Spaces

    \n
  • \n
\n

Maximum: 50 values

", + "smithy.api#xmlName": "imageNameSet" + } + }, + "DeprecationTimeCondition": { + "target": "com.amazonaws.ec2#DeprecationTimeCondition", + "traits": { + "aws.protocols#ec2QueryName": "DeprecationTimeCondition", + "smithy.api#documentation": "

The maximum period since deprecation for allowed images.

", + "smithy.api#xmlName": "deprecationTimeCondition" + } + }, + "CreationDateCondition": { + "target": "com.amazonaws.ec2#CreationDateCondition", + "traits": { + "aws.protocols#ec2QueryName": "CreationDateCondition", + "smithy.api#documentation": "

The maximum age for allowed images.

", + "smithy.api#xmlName": "creationDateCondition" + } } }, "traits": { - "smithy.api#documentation": "

The list of criteria that are evaluated to determine whch AMIs are discoverable and usable\n in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be\n specified are AMI providers.

\n

Up to 10 imageCriteria objects can be specified, and up to a total of 200\n values for all imageProviders. For more information, see JSON\n configuration for the Allowed AMIs criteria in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

The criteria that are evaluated to determine which AMIs are discoverable and usable in\n your account for the specified Amazon Web Services Region.

\n

For more information, see How Allowed AMIs\n works in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#ImageCriterionList": { @@ -62965,13 +63658,39 @@ "ImageProviders": { "target": "com.amazonaws.ec2#ImageProviderRequestList", "traits": { - "smithy.api#documentation": "

A list of image providers whose AMIs are discoverable and useable in the account. Up to a\n total of 200 values can be specified.

\n

Possible values:

\n

\n amazon: Allow AMIs created by Amazon Web Services.

\n

\n aws-marketplace: Allow AMIs created by verified providers in the Amazon Web Services\n Marketplace.

\n

\n aws-backup-vault: Allow AMIs created by Amazon Web Services Backup.

\n

12-digit account ID: Allow AMIs created by this account. One or more account IDs can be\n specified.

\n

\n none: Allow AMIs created by your own account only. When none is\n specified, no other values can be specified.

", + "smithy.api#documentation": "

The image providers whose images are allowed.

\n

Possible values:

\n
    \n
  • \n

    \n amazon: Allow AMIs created by Amazon or verified providers.

    \n
  • \n
  • \n

    \n aws-marketplace: Allow AMIs created by verified providers in the Amazon Web Services\n Marketplace.

    \n
  • \n
  • \n

    \n aws-backup-vault: Allow AMIs created by Amazon Web Services Backup.

    \n
  • \n
  • \n

    12-digit account ID: Allow AMIs created by the specified accounts. One or more account IDs can be\n specified.

    \n
  • \n
  • \n

    \n none: Allow AMIs created by your own account only. When none is\n specified, no other values can be specified.

    \n
  • \n
\n

Maximum: 200 values

", "smithy.api#xmlName": "ImageProvider" } + }, + "MarketplaceProductCodes": { + "target": "com.amazonaws.ec2#MarketplaceProductCodeRequestList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Marketplace product codes for allowed images.

\n

Length: 1-25 characters

\n

Valid characters: Letters (A–Z, a–z) and numbers (0–9)

\n

Maximum: 50 values

", + "smithy.api#xmlName": "MarketplaceProductCode" + } + }, + "ImageNames": { + "target": "com.amazonaws.ec2#ImageNameRequestList", + "traits": { + "smithy.api#documentation": "

The names of allowed images. Names can include wildcards (? and\n *).

\n

Length: 1–128 characters. With ?, the minimum is 3 characters.

\n

Valid characters:

\n
    \n
  • \n

    Letters: A–Z, a–z\n

    \n
  • \n
  • \n

    Numbers: 0–9\n

    \n
  • \n
  • \n

    Special characters: ( ) [ ] . / - ' @ _ * ?\n

    \n
  • \n
  • \n

    Spaces

    \n
  • \n
\n

Maximum: 50 values

", + "smithy.api#xmlName": "ImageName" + } + }, + "DeprecationTimeCondition": { + "target": "com.amazonaws.ec2#DeprecationTimeConditionRequest", + "traits": { + "smithy.api#documentation": "

The maximum period since deprecation for allowed images.

" + } + }, + "CreationDateCondition": { + "target": "com.amazonaws.ec2#CreationDateConditionRequest", + "traits": { + "smithy.api#documentation": "

The maximum age for allowed images.

" + } } }, "traits": { - "smithy.api#documentation": "

The list of criteria that are evaluated to determine whch AMIs are discoverable and usable\n in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be\n specified are AMI providers.

\n

Up to 10 imageCriteria objects can be specified, and up to a total of 200\n values for all imageProviders. For more information, see JSON\n configuration for the Allowed AMIs criteria in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

The criteria that are evaluated to determine which AMIs are discoverable and usable in\n your account for the specified Amazon Web Services Region.

\n

The ImageCriteria can include up to:

\n
    \n
  • \n

    10 ImageCriterion\n

    \n
  • \n
\n

Each ImageCriterion can include up to:

\n
    \n
  • \n

    200 values for ImageProviders\n

    \n
  • \n
  • \n

    50 values for ImageNames\n

    \n
  • \n
  • \n

    50 values for MarketplaceProductCodes\n

    \n
  • \n
\n

For more information, see How Allowed AMIs\n works in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#ImageCriterionRequestList": { @@ -63146,6 +63865,30 @@ "smithy.api#documentation": "

Information about the AMI.

" } }, + "com.amazonaws.ec2#ImageName": { + "type": "string" + }, + "com.amazonaws.ec2#ImageNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageName", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageNameRequest": { + "type": "string" + }, + "com.amazonaws.ec2#ImageNameRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageNameRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#ImageProvider": { "type": "string" }, @@ -63227,6 +63970,99 @@ } } }, + "com.amazonaws.ec2#ImageReference": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the referenced image.

", + "smithy.api#xmlName": "imageId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#ImageReferenceResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource referencing the image.

", + "smithy.api#xmlName": "resourceType" + } + }, + "Arn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Arn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource referencing the image.

", + "smithy.api#xmlName": "arn" + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource that is referencing an image.

" + } + }, + "com.amazonaws.ec2#ImageReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageReference", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageReferenceOptionName": { + "type": "enum", + "members": { + "STATE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "state-name" + } + }, + "VERSION_DEPTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "version-depth" + } + } + } + }, + "com.amazonaws.ec2#ImageReferenceResourceType": { + "type": "enum", + "members": { + "EC2_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ec2:Instance" + } + }, + "EC2_LAUNCH_TEMPLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ec2:LaunchTemplate" + } + }, + "SSM_PARAMETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ssm:Parameter" + } + }, + "IMAGE_BUILDER_IMAGE_RECIPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "imagebuilder:ImageRecipe" + } + }, + "IMAGE_BUILDER_CONTAINER_RECIPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "imagebuilder:ContainerRecipe" + } + } + } + }, "com.amazonaws.ec2#ImageState": { "type": "enum", "members": { @@ -63303,6 +64139,331 @@ } } }, + "com.amazonaws.ec2#ImageUsageReport": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the image that was specified when the report was created.

", + "smithy.api#xmlName": "imageId" + } + }, + "ReportId": { + "target": "com.amazonaws.ec2#ImageUsageReportId", + "traits": { + "aws.protocols#ec2QueryName": "ReportId", + "smithy.api#documentation": "

The ID of the report.

", + "smithy.api#xmlName": "reportId" + } + }, + "ResourceTypes": { + "target": "com.amazonaws.ec2#ImageUsageResourceTypeList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceTypeSet", + "smithy.api#documentation": "

The resource types that were specified when the report was created.

", + "smithy.api#xmlName": "resourceTypeSet" + } + }, + "AccountIds": { + "target": "com.amazonaws.ec2#UserIdList", + "traits": { + "aws.protocols#ec2QueryName": "AccountIdSet", + "smithy.api#documentation": "

The IDs of the Amazon Web Services accounts that were specified when the report was created.

", + "smithy.api#xmlName": "accountIdSet" + } + }, + "State": { + "target": "com.amazonaws.ec2#ImageUsageReportState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the report. Possible values:

\n
    \n
  • \n

    \n available - The report is available to view.

    \n
  • \n
  • \n

    \n pending - The report is being created and not available to view.

    \n
  • \n
  • \n

    \n error - The report could not be created.

    \n
  • \n
", + "smithy.api#xmlName": "state" + } + }, + "StateReason": { + "target": "com.amazonaws.ec2#ImageUsageReportStateReason", + "traits": { + "aws.protocols#ec2QueryName": "StateReason", + "smithy.api#documentation": "

Provides additional details when the report is in an error state.

", + "smithy.api#xmlName": "stateReason" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "

The date and time when the report was created.

", + "smithy.api#xmlName": "creationTime" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "ExpirationTime", + "smithy.api#documentation": "

The date and time when Amazon EC2 will delete the report (30 days after the report was\n created).

", + "smithy.api#xmlName": "expirationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the report.

", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration and status of an image usage report.

" + } + }, + "com.amazonaws.ec2#ImageUsageReportEntry": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.ec2#ImageUsageResourceTypeName", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The type of resource (ec2:Instance or\n ec2:LaunchTemplate).

", + "smithy.api#xmlName": "resourceType" + } + }, + "ReportId": { + "target": "com.amazonaws.ec2#ImageUsageReportId", + "traits": { + "aws.protocols#ec2QueryName": "ReportId", + "smithy.api#documentation": "

The ID of the report.

", + "smithy.api#xmlName": "reportId" + } + }, + "UsageCount": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "UsageCount", + "smithy.api#documentation": "

The number of times resources of this type reference this image in the account.

", + "smithy.api#xmlName": "usageCount" + } + }, + "AccountId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AccountId", + "smithy.api#documentation": "

The ID of the account that uses the image.

", + "smithy.api#xmlName": "accountId" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the image.

", + "smithy.api#xmlName": "imageId" + } + }, + "ReportCreationTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "ReportCreationTime", + "smithy.api#documentation": "

The date and time the report creation was initiated.

", + "smithy.api#xmlName": "reportCreationTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

A single entry in an image usage report, detailing how an image is being used by a\n specific Amazon Web Services account and resource type.

" + } + }, + "com.amazonaws.ec2#ImageUsageReportEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageUsageReportEntry", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageUsageReportId": { + "type": "string" + }, + "com.amazonaws.ec2#ImageUsageReportIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageUsageReportId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.ec2#ImageUsageReportList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageUsageReport", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageUsageReportState": { + "type": "string" + }, + "com.amazonaws.ec2#ImageUsageReportStateReason": { + "type": "string" + }, + "com.amazonaws.ec2#ImageUsageReportUserIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "UserId" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.ec2#ImageUsageResourceType": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.ec2#ImageUsageResourceTypeName", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "

The resource type.

\n

Valid values: ec2:Instance | ec2:LaunchTemplate\n

", + "smithy.api#xmlName": "resourceType" + } + }, + "ResourceTypeOptions": { + "target": "com.amazonaws.ec2#ImageUsageResourceTypeOptionList", + "traits": { + "aws.protocols#ec2QueryName": "ResourceTypeOptionSet", + "smithy.api#documentation": "

The options that affect the scope of the report. Valid only when ResourceType\n is ec2:LaunchTemplate.

", + "smithy.api#xmlName": "resourceTypeOptionSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource type to include in the report. Associated options can also be specified if the\n resource type is a launch template.

" + } + }, + "com.amazonaws.ec2#ImageUsageResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageUsageResourceType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageUsageResourceTypeName": { + "type": "string" + }, + "com.amazonaws.ec2#ImageUsageResourceTypeOption": { + "type": "structure", + "members": { + "OptionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OptionName", + "smithy.api#documentation": "

The name of the option.

", + "smithy.api#xmlName": "optionName" + } + }, + "OptionValues": { + "target": "com.amazonaws.ec2#ImageUsageResourceTypeOptionValuesList", + "traits": { + "aws.protocols#ec2QueryName": "OptionValueSet", + "smithy.api#documentation": "

The number of launch template versions to check.

", + "smithy.api#xmlName": "optionValueSet" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that affect the scope of the report.

" + } + }, + "com.amazonaws.ec2#ImageUsageResourceTypeOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageUsageResourceTypeOption", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageUsageResourceTypeOptionRequest": { + "type": "structure", + "members": { + "OptionName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the option.

\n

Valid value: version-depth - The number of launch template versions to\n check.

" + } + }, + "OptionValues": { + "target": "com.amazonaws.ec2#ImageUsageResourceTypeOptionValuesList", + "traits": { + "smithy.api#documentation": "

A value for the specified option.

\n

Valid values: Integers between 1 and 10000\n

\n

Default: 20\n

", + "smithy.api#xmlName": "OptionValue" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that affect the scope of the report.

" + } + }, + "com.amazonaws.ec2#ImageUsageResourceTypeOptionRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageUsageResourceTypeOptionRequest" + } + }, + "com.amazonaws.ec2#ImageUsageResourceTypeOptionValue": { + "type": "string" + }, + "com.amazonaws.ec2#ImageUsageResourceTypeOptionValuesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageUsageResourceTypeOptionValue", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ImageUsageResourceTypeRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.ec2#ImageUsageResourceTypeName", + "traits": { + "smithy.api#documentation": "

The resource type.

\n

Valid values: ec2:Instance | ec2:LaunchTemplate\n

" + } + }, + "ResourceTypeOptions": { + "target": "com.amazonaws.ec2#ImageUsageResourceTypeOptionRequestList", + "traits": { + "smithy.api#documentation": "

The options that affect the scope of the report. Valid only when ResourceType\n is ec2:LaunchTemplate.

", + "smithy.api#xmlName": "ResourceTypeOption" + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource type to include in the report. Associated options can also be specified if the\n resource type is a launch template.

" + } + }, + "com.amazonaws.ec2#ImageUsageResourceTypeRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageUsageResourceTypeRequest" + } + }, "com.amazonaws.ec2#ImdsSupportValues": { "type": "enum", "members": { @@ -64053,6 +65214,14 @@ "smithy.api#xmlName": "availabilityZone" } }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone where the resulting instance will reside.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, "BytesConverted": { "target": "com.amazonaws.ec2#Long", "traits": { @@ -64419,6 +65588,12 @@ "com.amazonaws.ec2#ImportVolumeRequest": { "type": "structure", "members": { + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#AvailabilityZoneId", + "traits": { + "smithy.api#documentation": "

The ID of the Availability Zone for the resulting EBS volume.

\n

Either AvailabilityZone or AvailabilityZoneId must be specified,\n but not both.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -64431,9 +65606,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Availability Zone for the resulting EBS volume.

", - "smithy.api#required": {}, + "smithy.api#documentation": "

The Availability Zone for the resulting EBS volume.

\n

Either AvailabilityZone or AvailabilityZoneId must be specified,\n but not both.

", "smithy.api#xmlName": "availabilityZone" } }, @@ -64497,6 +65670,14 @@ "smithy.api#xmlName": "availabilityZone" } }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone where the resulting volume will reside.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, "BytesConverted": { "target": "com.amazonaws.ec2#Long", "traits": { @@ -65510,7 +66691,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "smithy.api#documentation": "

The device name.

", "smithy.api#xmlName": "deviceName" } }, @@ -65543,7 +66724,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "smithy.api#documentation": "

The device name. For available device names, see Device names for volumes.

", "smithy.api#xmlName": "deviceName" } }, @@ -65634,6 +66815,30 @@ "smithy.api#documentation": "

Information about the number of instances that can be launched onto the Dedicated\n Host.

" } }, + "com.amazonaws.ec2#InstanceConnectEndpointDnsNames": { + "type": "structure", + "members": { + "DnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "

The DNS name of the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "dnsName" + } + }, + "FipsDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FipsDnsName", + "smithy.api#documentation": "

The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "fipsDnsName" + } + } + }, + "traits": { + "smithy.api#documentation": "

The DNS names of the endpoint.

" + } + }, "com.amazonaws.ec2#InstanceConnectEndpointId": { "type": "string" }, @@ -65646,6 +66851,30 @@ } } }, + "com.amazonaws.ec2#InstanceConnectEndpointPublicDnsNames": { + "type": "structure", + "members": { + "Ipv4": { + "target": "com.amazonaws.ec2#InstanceConnectEndpointDnsNames", + "traits": { + "aws.protocols#ec2QueryName": "Ipv4", + "smithy.api#documentation": "

The IPv4-only DNS name of the EC2 Instance Connect Endpoint.

", + "smithy.api#xmlName": "ipv4" + } + }, + "Dualstack": { + "target": "com.amazonaws.ec2#InstanceConnectEndpointDnsNames", + "traits": { + "aws.protocols#ec2QueryName": "Dualstack", + "smithy.api#documentation": "

The dualstack DNS name of the EC2 Instance Connect Endpoint. A dualstack DNS name supports connections from both IPv4 and IPv6 clients.

", + "smithy.api#xmlName": "dualstack" + } + } + }, + "traits": { + "smithy.api#documentation": "

The public DNS names of the endpoint, including IPv4-only and dualstack DNS\n names.

" + } + }, "com.amazonaws.ec2#InstanceConnectEndpointSet": { "type": "list", "member": { @@ -66590,7 +67819,7 @@ "target": "com.amazonaws.ec2#InstanceMetadataTagsState", "traits": { "aws.protocols#ec2QueryName": "InstanceMetadataTags", - "smithy.api#documentation": "

Indicates whether access to instance tags from the instance metadata is enabled or\n disabled. For more information, see Work with\n instance tags using the instance metadata in the\n Amazon EC2 User Guide.

", + "smithy.api#documentation": "

Indicates whether access to instance tags from the instance metadata is enabled or\n disabled. For more information, see Work with\n instance tags using the instance metadata in the\n Amazon EC2 User Guide.

", "smithy.api#xmlName": "instanceMetadataTags" } }, @@ -67944,6 +69173,14 @@ "smithy.api#xmlName": "availabilityZone" } }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#AvailabilityZoneId", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone of the instance.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, "OutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { @@ -73454,616 +74691,1042 @@ "smithy.api#enumValue": "x8g.4xlarge" } }, - "x8g_8xlarge": { + "x8g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.8xlarge" + } + }, + "x8g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.12xlarge" + } + }, + "x8g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.16xlarge" + } + }, + "x8g_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.24xlarge" + } + }, + "x8g_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.48xlarge" + } + }, + "x8g_metal_24xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.metal-24xl" + } + }, + "x8g_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "x8g.metal-48xl" + } + }, + "i7ie_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.large" + } + }, + "i7ie_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.xlarge" + } + }, + "i7ie_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.2xlarge" + } + }, + "i7ie_3xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.3xlarge" + } + }, + "i7ie_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.6xlarge" + } + }, + "i7ie_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.12xlarge" + } + }, + "i7ie_18xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.18xlarge" + } + }, + "i7ie_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.24xlarge" + } + }, + "i7ie_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.48xlarge" + } + }, + "i8g_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.large" + } + }, + "i8g_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.xlarge" + } + }, + "i8g_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.2xlarge" + } + }, + "i8g_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.4xlarge" + } + }, + "i8g_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.8xlarge" + } + }, + "i8g_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.12xlarge" + } + }, + "i8g_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.16xlarge" + } + }, + "i8g_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.24xlarge" + } + }, + "i8g_metal_24xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.metal-24xl" + } + }, + "u7i_6tb_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7i-6tb.112xlarge" + } + }, + "u7i_8tb_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7i-8tb.112xlarge" + } + }, + "u7inh_32tb_480xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7inh-32tb.480xlarge" + } + }, + "p5e_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p5e.48xlarge" + } + }, + "p5en_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p5en.48xlarge" + } + }, + "f2_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "f2.12xlarge" + } + }, + "f2_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "f2.48xlarge" + } + }, + "trn2_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trn2.48xlarge" + } + }, + "c7i_flex_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i-flex.12xlarge" + } + }, + "c7i_flex_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i-flex.16xlarge" + } + }, + "m7i_flex_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i-flex.12xlarge" + } + }, + "m7i_flex_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i-flex.16xlarge" + } + }, + "i7ie_metal_24xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.metal-24xl" + } + }, + "i7ie_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7ie.metal-48xl" + } + }, + "i8g_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i8g.48xlarge" + } + }, + "c8gd_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gd.medium" + } + }, + "c8gd_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gd.large" + } + }, + "c8gd_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gd.xlarge" + } + }, + "c8gd_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gd.2xlarge" + } + }, + "c8gd_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gd.4xlarge" + } + }, + "c8gd_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gd.8xlarge" + } + }, + "c8gd_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gd.12xlarge" + } + }, + "c8gd_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gd.16xlarge" + } + }, + "c8gd_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gd.24xlarge" + } + }, + "c8gd_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gd.48xlarge" + } + }, + "c8gd_metal_24xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gd.metal-24xl" + } + }, + "c8gd_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gd.metal-48xl" + } + }, + "i7i_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7i.large" + } + }, + "i7i_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7i.xlarge" + } + }, + "i7i_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7i.2xlarge" + } + }, + "i7i_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7i.4xlarge" + } + }, + "i7i_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7i.8xlarge" + } + }, + "i7i_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7i.12xlarge" + } + }, + "i7i_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7i.16xlarge" + } + }, + "i7i_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7i.24xlarge" + } + }, + "i7i_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7i.48xlarge" + } + }, + "i7i_metal_24xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7i.metal-24xl" + } + }, + "i7i_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "i7i.metal-48xl" + } + }, + "p6_b200_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p6-b200.48xlarge" + } + }, + "m8gd_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8gd.medium" + } + }, + "m8gd_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8gd.large" + } + }, + "m8gd_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8gd.xlarge" + } + }, + "m8gd_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8gd.2xlarge" + } + }, + "m8gd_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8gd.4xlarge" + } + }, + "m8gd_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8gd.8xlarge" + } + }, + "m8gd_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m8gd.12xlarge" + } + }, + "m8gd_16xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "x8g.8xlarge" + "smithy.api#enumValue": "m8gd.16xlarge" } }, - "x8g_12xlarge": { + "m8gd_24xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "x8g.12xlarge" + "smithy.api#enumValue": "m8gd.24xlarge" } }, - "x8g_16xlarge": { + "m8gd_48xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "x8g.16xlarge" + "smithy.api#enumValue": "m8gd.48xlarge" } }, - "x8g_24xlarge": { + "m8gd_metal_24xl": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "x8g.24xlarge" + "smithy.api#enumValue": "m8gd.metal-24xl" } }, - "x8g_48xlarge": { + "m8gd_metal_48xl": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "x8g.48xlarge" + "smithy.api#enumValue": "m8gd.metal-48xl" } }, - "x8g_metal_24xl": { + "r8gd_medium": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "x8g.metal-24xl" + "smithy.api#enumValue": "r8gd.medium" } }, - "x8g_metal_48xl": { + "r8gd_large": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "x8g.metal-48xl" + "smithy.api#enumValue": "r8gd.large" } }, - "i7ie_large": { + "r8gd_xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7ie.large" + "smithy.api#enumValue": "r8gd.xlarge" } }, - "i7ie_xlarge": { + "r8gd_2xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7ie.xlarge" + "smithy.api#enumValue": "r8gd.2xlarge" } }, - "i7ie_2xlarge": { + "r8gd_4xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7ie.2xlarge" + "smithy.api#enumValue": "r8gd.4xlarge" } }, - "i7ie_3xlarge": { + "r8gd_8xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7ie.3xlarge" + "smithy.api#enumValue": "r8gd.8xlarge" } }, - "i7ie_6xlarge": { + "r8gd_12xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7ie.6xlarge" + "smithy.api#enumValue": "r8gd.12xlarge" } }, - "i7ie_12xlarge": { + "r8gd_16xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7ie.12xlarge" + "smithy.api#enumValue": "r8gd.16xlarge" } }, - "i7ie_18xlarge": { + "r8gd_24xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7ie.18xlarge" + "smithy.api#enumValue": "r8gd.24xlarge" } }, - "i7ie_24xlarge": { + "r8gd_48xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7ie.24xlarge" + "smithy.api#enumValue": "r8gd.48xlarge" } }, - "i7ie_48xlarge": { + "r8gd_metal_24xl": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7ie.48xlarge" + "smithy.api#enumValue": "r8gd.metal-24xl" } }, - "i8g_large": { + "r8gd_metal_48xl": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i8g.large" + "smithy.api#enumValue": "r8gd.metal-48xl" } }, - "i8g_xlarge": { + "c8gn_medium": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i8g.xlarge" + "smithy.api#enumValue": "c8gn.medium" } }, - "i8g_2xlarge": { + "c8gn_large": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i8g.2xlarge" + "smithy.api#enumValue": "c8gn.large" } }, - "i8g_4xlarge": { + "c8gn_xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i8g.4xlarge" + "smithy.api#enumValue": "c8gn.xlarge" } }, - "i8g_8xlarge": { + "c8gn_2xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i8g.8xlarge" + "smithy.api#enumValue": "c8gn.2xlarge" } }, - "i8g_12xlarge": { + "c8gn_4xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i8g.12xlarge" + "smithy.api#enumValue": "c8gn.4xlarge" } }, - "i8g_16xlarge": { + "c8gn_8xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i8g.16xlarge" + "smithy.api#enumValue": "c8gn.8xlarge" } }, - "i8g_24xlarge": { + "c8gn_12xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i8g.24xlarge" + "smithy.api#enumValue": "c8gn.12xlarge" } }, - "i8g_metal_24xl": { + "c8gn_16xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i8g.metal-24xl" + "smithy.api#enumValue": "c8gn.16xlarge" } }, - "u7i_6tb_112xlarge": { + "c8gn_24xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "u7i-6tb.112xlarge" + "smithy.api#enumValue": "c8gn.24xlarge" } }, - "u7i_8tb_112xlarge": { + "c8gn_48xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "u7i-8tb.112xlarge" + "smithy.api#enumValue": "c8gn.48xlarge" } }, - "u7inh_32tb_480xlarge": { + "c8gn_metal_24xl": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "u7inh-32tb.480xlarge" + "smithy.api#enumValue": "c8gn.metal-24xl" } }, - "p5e_48xlarge": { + "c8gn_metal_48xl": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "p5e.48xlarge" + "smithy.api#enumValue": "c8gn.metal-48xl" } }, - "p5en_48xlarge": { + "f2_6xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "p5en.48xlarge" + "smithy.api#enumValue": "f2.6xlarge" } }, - "f2_12xlarge": { + "p6e_gb200_36xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "f2.12xlarge" + "smithy.api#enumValue": "p6e-gb200.36xlarge" } }, - "f2_48xlarge": { + "g6f_large": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "f2.48xlarge" + "smithy.api#enumValue": "g6f.large" } }, - "trn2_48xlarge": { + "g6f_xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "trn2.48xlarge" + "smithy.api#enumValue": "g6f.xlarge" } }, - "c7i_flex_12xlarge": { + "g6f_2xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c7i-flex.12xlarge" + "smithy.api#enumValue": "g6f.2xlarge" } }, - "c7i_flex_16xlarge": { + "g6f_4xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c7i-flex.16xlarge" + "smithy.api#enumValue": "g6f.4xlarge" } }, - "m7i_flex_12xlarge": { + "gr6f_4xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "m7i-flex.12xlarge" + "smithy.api#enumValue": "gr6f.4xlarge" } }, - "m7i_flex_16xlarge": { + "p5_4xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "m7i-flex.16xlarge" + "smithy.api#enumValue": "p5.4xlarge" } }, - "i7ie_metal_24xl": { + "r8i_large": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7ie.metal-24xl" + "smithy.api#enumValue": "r8i.large" } }, - "i7ie_metal_48xl": { + "r8i_xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7ie.metal-48xl" + "smithy.api#enumValue": "r8i.xlarge" } }, - "i8g_48xlarge": { + "r8i_2xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i8g.48xlarge" + "smithy.api#enumValue": "r8i.2xlarge" } }, - "c8gd_medium": { + "r8i_4xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gd.medium" + "smithy.api#enumValue": "r8i.4xlarge" } }, - "c8gd_large": { + "r8i_8xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gd.large" + "smithy.api#enumValue": "r8i.8xlarge" } }, - "c8gd_xlarge": { + "r8i_12xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gd.xlarge" + "smithy.api#enumValue": "r8i.12xlarge" } }, - "c8gd_2xlarge": { + "r8i_16xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gd.2xlarge" + "smithy.api#enumValue": "r8i.16xlarge" } }, - "c8gd_4xlarge": { + "r8i_24xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gd.4xlarge" + "smithy.api#enumValue": "r8i.24xlarge" } }, - "c8gd_8xlarge": { + "r8i_32xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gd.8xlarge" + "smithy.api#enumValue": "r8i.32xlarge" } }, - "c8gd_12xlarge": { + "r8i_48xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gd.12xlarge" + "smithy.api#enumValue": "r8i.48xlarge" } }, - "c8gd_16xlarge": { + "r8i_96xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gd.16xlarge" + "smithy.api#enumValue": "r8i.96xlarge" } }, - "c8gd_24xlarge": { + "r8i_metal_48xl": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gd.24xlarge" + "smithy.api#enumValue": "r8i.metal-48xl" } }, - "c8gd_48xlarge": { + "r8i_metal_96xl": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gd.48xlarge" + "smithy.api#enumValue": "r8i.metal-96xl" } }, - "c8gd_metal_24xl": { + "r8i_flex_large": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gd.metal-24xl" + "smithy.api#enumValue": "r8i-flex.large" } }, - "c8gd_metal_48xl": { + "r8i_flex_xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gd.metal-48xl" + "smithy.api#enumValue": "r8i-flex.xlarge" } }, - "i7i_large": { + "r8i_flex_2xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7i.large" + "smithy.api#enumValue": "r8i-flex.2xlarge" } }, - "i7i_xlarge": { + "r8i_flex_4xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7i.xlarge" + "smithy.api#enumValue": "r8i-flex.4xlarge" } }, - "i7i_2xlarge": { + "r8i_flex_8xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7i.2xlarge" + "smithy.api#enumValue": "r8i-flex.8xlarge" } }, - "i7i_4xlarge": { + "r8i_flex_12xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7i.4xlarge" + "smithy.api#enumValue": "r8i-flex.12xlarge" } }, - "i7i_8xlarge": { + "r8i_flex_16xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7i.8xlarge" + "smithy.api#enumValue": "r8i-flex.16xlarge" } }, - "i7i_12xlarge": { + "m8i_large": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7i.12xlarge" + "smithy.api#enumValue": "m8i.large" } }, - "i7i_16xlarge": { + "m8i_xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7i.16xlarge" + "smithy.api#enumValue": "m8i.xlarge" } }, - "i7i_24xlarge": { + "m8i_2xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7i.24xlarge" + "smithy.api#enumValue": "m8i.2xlarge" } }, - "i7i_48xlarge": { + "m8i_4xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7i.48xlarge" + "smithy.api#enumValue": "m8i.4xlarge" } }, - "i7i_metal_24xl": { + "m8i_8xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7i.metal-24xl" + "smithy.api#enumValue": "m8i.8xlarge" } }, - "i7i_metal_48xl": { + "m8i_12xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "i7i.metal-48xl" + "smithy.api#enumValue": "m8i.12xlarge" } }, - "p6_b200_48xlarge": { + "m8i_16xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "p6-b200.48xlarge" + "smithy.api#enumValue": "m8i.16xlarge" } }, - "m8gd_medium": { + "m8i_24xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "m8gd.medium" + "smithy.api#enumValue": "m8i.24xlarge" } }, - "m8gd_large": { + "m8i_32xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "m8gd.large" + "smithy.api#enumValue": "m8i.32xlarge" } }, - "m8gd_xlarge": { + "m8i_48xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "m8gd.xlarge" + "smithy.api#enumValue": "m8i.48xlarge" } }, - "m8gd_2xlarge": { + "m8i_96xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "m8gd.2xlarge" + "smithy.api#enumValue": "m8i.96xlarge" } }, - "m8gd_4xlarge": { + "m8i_metal_48xl": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "m8gd.4xlarge" + "smithy.api#enumValue": "m8i.metal-48xl" } }, - "m8gd_8xlarge": { + "m8i_metal_96xl": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "m8gd.8xlarge" + "smithy.api#enumValue": "m8i.metal-96xl" } }, - "m8gd_12xlarge": { + "m8i_flex_large": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "m8gd.12xlarge" + "smithy.api#enumValue": "m8i-flex.large" } }, - "m8gd_16xlarge": { + "m8i_flex_xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "m8gd.16xlarge" + "smithy.api#enumValue": "m8i-flex.xlarge" } }, - "m8gd_24xlarge": { + "m8i_flex_2xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "m8gd.24xlarge" + "smithy.api#enumValue": "m8i-flex.2xlarge" } }, - "m8gd_48xlarge": { + "m8i_flex_4xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "m8gd.48xlarge" + "smithy.api#enumValue": "m8i-flex.4xlarge" } }, - "m8gd_metal_24xl": { + "m8i_flex_8xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "m8gd.metal-24xl" + "smithy.api#enumValue": "m8i-flex.8xlarge" } }, - "m8gd_metal_48xl": { + "m8i_flex_12xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "m8gd.metal-48xl" + "smithy.api#enumValue": "m8i-flex.12xlarge" } }, - "r8gd_medium": { + "m8i_flex_16xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "r8gd.medium" + "smithy.api#enumValue": "m8i-flex.16xlarge" } }, - "r8gd_large": { + "i8ge_large": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "r8gd.large" + "smithy.api#enumValue": "i8ge.large" } }, - "r8gd_xlarge": { + "i8ge_xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "r8gd.xlarge" + "smithy.api#enumValue": "i8ge.xlarge" } }, - "r8gd_2xlarge": { + "i8ge_2xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "r8gd.2xlarge" + "smithy.api#enumValue": "i8ge.2xlarge" } }, - "r8gd_4xlarge": { + "i8ge_3xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "r8gd.4xlarge" + "smithy.api#enumValue": "i8ge.3xlarge" } }, - "r8gd_8xlarge": { + "i8ge_6xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "r8gd.8xlarge" + "smithy.api#enumValue": "i8ge.6xlarge" } }, - "r8gd_12xlarge": { + "i8ge_12xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "r8gd.12xlarge" + "smithy.api#enumValue": "i8ge.12xlarge" } }, - "r8gd_16xlarge": { + "i8ge_18xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "r8gd.16xlarge" + "smithy.api#enumValue": "i8ge.18xlarge" } }, - "r8gd_24xlarge": { + "i8ge_24xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "r8gd.24xlarge" + "smithy.api#enumValue": "i8ge.24xlarge" } }, - "r8gd_48xlarge": { + "i8ge_48xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "r8gd.48xlarge" + "smithy.api#enumValue": "i8ge.48xlarge" } }, - "r8gd_metal_24xl": { + "i8ge_metal_24xl": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "r8gd.metal-24xl" + "smithy.api#enumValue": "i8ge.metal-24xl" } }, - "r8gd_metal_48xl": { + "i8ge_metal_48xl": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "r8gd.metal-48xl" + "smithy.api#enumValue": "i8ge.metal-48xl" } }, - "c8gn_medium": { + "mac_m4_metal": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gn.medium" + "smithy.api#enumValue": "mac-m4.metal" } }, - "c8gn_large": { + "mac_m4pro_metal": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gn.large" + "smithy.api#enumValue": "mac-m4pro.metal" } }, - "c8gn_xlarge": { + "r8gn_medium": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gn.xlarge" + "smithy.api#enumValue": "r8gn.medium" } }, - "c8gn_2xlarge": { + "r8gn_large": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gn.2xlarge" + "smithy.api#enumValue": "r8gn.large" } }, - "c8gn_4xlarge": { + "r8gn_xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gn.4xlarge" + "smithy.api#enumValue": "r8gn.xlarge" } }, - "c8gn_8xlarge": { + "r8gn_2xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gn.8xlarge" + "smithy.api#enumValue": "r8gn.2xlarge" } }, - "c8gn_12xlarge": { + "r8gn_4xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gn.12xlarge" + "smithy.api#enumValue": "r8gn.4xlarge" } }, - "c8gn_16xlarge": { + "r8gn_8xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gn.16xlarge" + "smithy.api#enumValue": "r8gn.8xlarge" } }, - "c8gn_24xlarge": { + "r8gn_12xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gn.24xlarge" + "smithy.api#enumValue": "r8gn.12xlarge" } }, - "c8gn_48xlarge": { + "r8gn_16xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gn.48xlarge" + "smithy.api#enumValue": "r8gn.16xlarge" } }, - "c8gn_metal_24xl": { + "r8gn_24xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gn.metal-24xl" + "smithy.api#enumValue": "r8gn.24xlarge" } }, - "c8gn_metal_48xl": { + "r8gn_48xlarge": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "c8gn.metal-48xl" + "smithy.api#enumValue": "r8gn.48xlarge" } }, - "f2_6xlarge": { + "r8gn_metal_24xl": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "f2.6xlarge" + "smithy.api#enumValue": "r8gn.metal-24xl" } }, - "p6e_gb200_36xlarge": { + "r8gn_metal_48xl": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "p6e-gb200.36xlarge" + "smithy.api#enumValue": "r8gn.metal-48xl" } } } @@ -78942,7 +80605,7 @@ "Iops": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3,\n io1, and io2 volumes, this represents the number of IOPS that\n are provisioned for the volume. For gp2 volumes, this represents the\n baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.

\n

The following are the supported values for each volume type:

\n
    \n
  • \n

    \n gp3: 3,000 - 16,000 IOPS

    \n
  • \n
  • \n

    \n io1: 100 - 64,000 IOPS

    \n
  • \n
  • \n

    \n io2: 100 - 256,000 IOPS

    \n
  • \n
\n

For io2 volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

\n

This parameter is supported for io1, io2, and gp3 volumes only.

" + "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3,\n io1, and io2 volumes, this represents the number of IOPS that\n are provisioned for the volume. For gp2 volumes, this represents the\n baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.

\n

The following are the supported values for each volume type:

\n
    \n
  • \n

    \n gp3: 3,000 - 80,000 IOPS

    \n
  • \n
  • \n

    \n io1: 100 - 64,000 IOPS

    \n
  • \n
  • \n

    \n io2: 100 - 256,000 IOPS

    \n
  • \n
\n

For io2 volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

\n

This parameter is supported for io1, io2, and gp3 volumes only.

" } }, "KmsKeyId": { @@ -78960,7 +80623,7 @@ "VolumeSize": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. The following are the supported volumes sizes for each volume type:

\n
    \n
  • \n

    \n gp2 and gp3: 1 - 16,384 GiB

    \n
  • \n
  • \n

    \n io1: 4 - 16,384 GiB

    \n
  • \n
  • \n

    \n io2: 4 - 65,536 GiB

    \n
  • \n
  • \n

    \n st1 and sc1: 125 - 16,384 GiB

    \n
  • \n
  • \n

    \n standard: 1 - 1024 GiB

    \n
  • \n
" + "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. The following are the supported volumes sizes for each volume type:

\n
    \n
  • \n

    \n gp2: 1 - 16,384 GiB

    \n
  • \n
  • \n

    \n gp3: 1 - 65,536 GiB

    \n
  • \n
  • \n

    \n io1: 4 - 16,384 GiB

    \n
  • \n
  • \n

    \n io2: 4 - 65,536 GiB

    \n
  • \n
  • \n

    \n st1 and sc1: 125 - 16,384 GiB

    \n
  • \n
  • \n

    \n standard: 1 - 1024 GiB

    \n
  • \n
" } }, "VolumeType": { @@ -78972,7 +80635,7 @@ "Throughput": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The throughput to provision for a gp3 volume, with a maximum of 1,000\n MiB/s.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" + "smithy.api#documentation": "

The throughput to provision for a gp3 volume, with a maximum of 2,000\n MiB/s.

\n

Valid Range: Minimum value of 125. Maximum value of 2,000.

" } }, "VolumeInitializationRate": { @@ -79000,7 +80663,7 @@ "Count": { "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorCount", "traits": { - "smithy.api#documentation": "

The number of elastic inference accelerators to attach to the instance.

\n

Default: 1

" + "smithy.api#documentation": "

The number of elastic inference accelerators to attach to the instance.

" } } }, @@ -79032,7 +80695,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of elastic inference accelerator. The possible values are eia1.medium,\n eia1.large, and eia1.xlarge.

", + "smithy.api#documentation": "

The type of elastic inference accelerator. The possible values are eia1.medium,\n eia1.large, and eia1.xlarge.

", "smithy.api#xmlName": "type" } }, @@ -79040,7 +80703,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "Count", - "smithy.api#documentation": "

The number of elastic inference accelerators to attach to the instance.

\n

Default: 1

", + "smithy.api#documentation": "

The number of elastic inference accelerators to attach to the instance.

", "smithy.api#xmlName": "count" } } @@ -79386,7 +81049,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "HttpPutResponseHopLimit", - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

", + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Possible values: Integers from 1 to 64

", "smithy.api#xmlName": "httpPutResponseHopLimit" } }, @@ -80048,6 +81711,14 @@ "smithy.api#xmlName": "availabilityZone" } }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#AvailabilityZoneId", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone of the instance.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, "Affinity": { "target": "com.amazonaws.ec2#String", "traits": { @@ -80123,7 +81794,13 @@ "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Availability Zone for the instance.

" + "smithy.api#documentation": "

The Availability Zone for the instance.

\n

Either AvailabilityZone or AvailabilityZoneId can be specified, but not both

" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#AvailabilityZoneId", + "traits": { + "smithy.api#documentation": "

The ID of the Availability Zone for the instance.

\n

Either AvailabilityZone or AvailabilityZoneId can be specified, but not both

" } }, "Affinity": { @@ -82617,6 +84294,30 @@ } } }, + "com.amazonaws.ec2#MarketplaceProductCode": { + "type": "string" + }, + "com.amazonaws.ec2#MarketplaceProductCodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#MarketplaceProductCode", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#MarketplaceProductCodeRequest": { + "type": "string" + }, + "com.amazonaws.ec2#MarketplaceProductCodeRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#MarketplaceProductCodeRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#MaxIpv4AddrPerInterface": { "type": "integer" }, @@ -82650,6 +84351,27 @@ "com.amazonaws.ec2#MaximumBandwidthInMbps": { "type": "integer" }, + "com.amazonaws.ec2#MaximumDaysSinceCreatedValue": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 2147483647 + } + } + }, + "com.amazonaws.ec2#MaximumDaysSinceDeprecatedValue": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 2147483647 + } + } + }, + "com.amazonaws.ec2#MaximumEbsAttachments": { + "type": "integer" + }, "com.amazonaws.ec2#MaximumEfaInterfaces": { "type": "integer" }, @@ -84231,6 +85953,75 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#ModifyInstanceConnectEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceConnectEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceConnectEndpointResult" + }, + "traits": { + "smithy.api#documentation": "

Modifies the specified EC2 Instance Connect Endpoint.

\n

For more information, see Modify an\n EC2 Instance Connect Endpoint in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyInstanceConnectEndpointRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "InstanceConnectEndpointId": { + "target": "com.amazonaws.ec2#InstanceConnectEndpointId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the EC2 Instance Connect Endpoint to modify.

", + "smithy.api#required": {} + } + }, + "IpAddressType": { + "target": "com.amazonaws.ec2#IpAddressType", + "traits": { + "smithy.api#documentation": "

The new IP address type for the EC2 Instance Connect Endpoint.

\n \n

\n PreserveClientIp is only supported on IPv4 EC2 Instance Connect\n Endpoints. To use PreserveClientIp, the value for\n IpAddressType must be ipv4.

\n
" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringListRequest", + "traits": { + "smithy.api#documentation": "

Changes the security groups for the EC2 Instance Connect Endpoint. The new set of\n groups you specify replaces the current set. You must specify at least one group, even\n if it's just the default security group in the VPC. You must specify the ID of the\n security group, not the name.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "PreserveClientIp": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the client IP address is preserved as the source. The following are the possible values.

\n
    \n
  • \n

    \n true - Use the client IP address as the source.

    \n
  • \n
  • \n

    \n false - Use the network interface IP address as the source.

    \n
  • \n
\n \n

\n PreserveClientIp=true is only supported on IPv4 EC2 Instance Connect\n Endpoints. If modifying PreserveClientIp to true, either\n the endpoint's existing IpAddressType must be ipv4, or if\n modifying IpAddressType in the same request, the new value must be\n ipv4.

\n
\n

Default: false\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceConnectEndpointResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

The return value of the request. Returns true if the specified product\n code is owned by the requester and associated with the specified instance.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#ModifyInstanceCpuOptions": { "type": "operation", "input": { @@ -84600,7 +86391,7 @@ "target": "com.amazonaws.ec2#ModifyInstanceMetadataDefaultsResult" }, "traits": { - "smithy.api#documentation": "

Modifies the default instance metadata service (IMDS) settings at the account level in\n the specified Amazon Web Services\u2028 Region.

\n \n

To remove a parameter's account-level default setting, specify\n no-preference. If an account-level setting is cleared with\n no-preference, then the instance launch considers the other\n instance metadata settings. For more information, see Order of precedence for instance metadata options in the\n Amazon EC2 User Guide.

\n
" + "smithy.api#documentation": "

Modifies the default instance metadata service (IMDS) settings at the account level in\n the specified Amazon Web Services\u2028 Region.

\n \n

To remove a parameter's account-level default setting, specify\n no-preference. If an account-level setting is cleared with\n no-preference, then the instance launch considers the other\n instance metadata settings. For more information, see Order of precedence for instance metadata options in the\n Amazon EC2 User Guide.

\n
" } }, "com.amazonaws.ec2#ModifyInstanceMetadataDefaultsRequest": { @@ -84627,7 +86418,7 @@ "InstanceMetadataTags": { "target": "com.amazonaws.ec2#DefaultInstanceMetadataTagsState", "traits": { - "smithy.api#documentation": "

Enables or disables access to an instance's tags from the instance metadata. For more\n information, see Work with\n instance tags using the instance metadata in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Enables or disables access to an instance's tags from the instance metadata. For more\n information, see Work with\n instance tags using the instance metadata in the\n Amazon EC2 User Guide.

" } }, "DryRun": { @@ -86719,7 +88510,7 @@ "DefaultRouteTablePropagation": { "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", "traits": { - "smithy.api#documentation": "

Enable or disable automatic propagation of routes to the default propagation route table.

" + "smithy.api#documentation": "

Indicates whether resource attachments automatically propagate routes to the default\n propagation route table. Enabled by default. If defaultRouteTablePropagation\n is set to enable,\n Amazon Web Services Transit Gateway will create the default transit gateway route\n table.

" } }, "PropagationDefaultRouteTableId": { @@ -87873,7 +89664,7 @@ "Size": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The target size of the volume, in GiB. The target volume size must be greater than or\n equal to the existing size of the volume.

\n

The following are the supported volumes sizes for each volume type:

\n
    \n
  • \n

    \n gp2 and gp3: 1 - 16,384 GiB

    \n
  • \n
  • \n

    \n io1: 4 - 16,384 GiB

    \n
  • \n
  • \n

    \n io2: 4 - 65,536 GiB

    \n
  • \n
  • \n

    \n st1 and sc1: 125 - 16,384 GiB

    \n
  • \n
  • \n

    \n standard: 1 - 1024 GiB

    \n
  • \n
\n

Default: The existing size is retained.

" + "smithy.api#documentation": "

The target size of the volume, in GiB. The target volume size must be greater than or\n equal to the existing size of the volume.

\n

The following are the supported volumes sizes for each volume type:

\n
    \n
  • \n

    \n gp2: 1 - 16,384 GiB

    \n
  • \n
  • \n

    \n gp3: 1 - 65,536 GiB

    \n
  • \n
  • \n

    \n io1: 4 - 16,384 GiB

    \n
  • \n
  • \n

    \n io2: 4 - 65,536 GiB

    \n
  • \n
  • \n

    \n st1 and sc1: 125 - 16,384 GiB

    \n
  • \n
  • \n

    \n standard: 1 - 1024 GiB

    \n
  • \n
\n

Default: The existing size is retained.

" } }, "VolumeType": { @@ -87885,13 +89676,13 @@ "Iops": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

\n

The following are the supported values for each volume type:

\n
    \n
  • \n

    \n gp3: 3,000 - 16,000 IOPS

    \n
  • \n
  • \n

    \n io1: 100 - 64,000 IOPS

    \n
  • \n
  • \n

    \n io2: 100 - 256,000 IOPS

    \n
  • \n
\n

For io2 volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

\n

Default: The existing value is retained if you keep the same volume type. If you change\n the volume type to io1, io2, or gp3, the default is 3,000.

" + "smithy.api#documentation": "

The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

\n

The following are the supported values for each volume type:

\n
    \n
  • \n

    \n gp3: 3,000 - 80,000 IOPS

    \n
  • \n
  • \n

    \n io1: 100 - 64,000 IOPS

    \n
  • \n
  • \n

    \n io2: 100 - 256,000 IOPS

    \n
  • \n
\n

For io2 volumes, you can achieve up to 256,000 IOPS on \ninstances \nbuilt on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

\n

Default: The existing value is retained if you keep the same volume type. If you change\n the volume type to io1, io2, or gp3, the default is 3,000.

" } }, "Throughput": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. \n The maximum value is 1,000.

\n

Default: The existing value is retained if the source and target volume type is gp3.\n Otherwise, the default value is 125.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" + "smithy.api#documentation": "

The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. \n The maximum value is 2,000.

\n

Default: The existing value is retained if the source and target volume type is gp3.\n Otherwise, the default value is 125.

\n

Valid Range: Minimum value of 125. Maximum value of 2,000.

" } }, "MultiAttachEnabled": { @@ -93509,6 +95300,14 @@ "com.amazonaws.ec2#Placement": { "type": "structure", "members": { + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#AvailabilityZoneId", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone of the instance.

\n

On input, you can specify AvailabilityZone or AvailabilityZoneId, \n but not both. If you specify neither one, Amazon EC2 automatically selects an Availability Zone\n for you.

\n

This parameter is not supported for CreateFleet.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, "Affinity": { "target": "com.amazonaws.ec2#String", "traits": { @@ -93521,7 +95320,7 @@ "target": "com.amazonaws.ec2#PlacementGroupName", "traits": { "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the placement group that the instance is in. If you specify\n GroupName, you can't specify GroupId.

", + "smithy.api#documentation": "

The name of the placement group that the instance is in.

\n

On input, you can specify GroupId or GroupName,\n but not both.

", "smithy.api#xmlName": "groupName" } }, @@ -93561,7 +95360,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "HostResourceGroupArn", - "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances.

\n

If you specify this parameter, either omit the Tenancy parameter or set it to host.

\n

This parameter is not supported for CreateFleet.

", + "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances.

\n

On input, if you specify this parameter, either omit the Tenancy parameter or set it to host.

\n

This parameter is not supported for CreateFleet.

", "smithy.api#xmlName": "hostResourceGroupArn" } }, @@ -93569,7 +95368,7 @@ "target": "com.amazonaws.ec2#PlacementGroupId", "traits": { "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the placement group that the instance is in. If you specify\n GroupId, you can't specify GroupName.

", + "smithy.api#documentation": "

The ID of the placement group that the instance is in.

\n

On input, you can specify GroupId or GroupName,\n but not both.

", "smithy.api#xmlName": "groupId" } }, @@ -93577,7 +95376,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone of the instance.

\n

If not specified, an Availability Zone will be automatically chosen for you based on\n the load balancing criteria for the Region.

\n

This parameter is not supported for CreateFleet.

", + "smithy.api#documentation": "

The Availability Zone of the instance.

\n

On input, you can specify AvailabilityZone or AvailabilityZoneId, \n but not both. If you specify neither one, Amazon EC2 automatically selects an Availability Zone\n for you.

\n

This parameter is not supported for CreateFleet.

", "smithy.api#xmlName": "availabilityZone" } } @@ -98340,6 +100139,10 @@ "ElasticGpuSpecifications": { "target": "com.amazonaws.ec2#ElasticGpuSpecificationList", "traits": { + "smithy.api#deprecated": { + "since": "2024-01-08", + "message": "Specifying Elastic Graphics accelerators is no longer supported on the RunInstances API." + }, "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n
", "smithy.api#xmlName": "ElasticGpuSpecification" } @@ -98347,6 +100150,10 @@ "ElasticInferenceAccelerators": { "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorList", "traits": { + "smithy.api#deprecated": { + "since": "2024-01-08", + "message": "Specifying Elastic Inference accelerators is no longer supported on the RunInstances API." + }, "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n
\n

An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.

\n

You cannot specify accelerators from different generations in the same request.

", "smithy.api#xmlName": "ElasticInferenceAccelerator" } @@ -100487,6 +102294,12 @@ "smithy.api#enumValue": "image" } }, + "image_usage_report": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "image-usage-report" + } + }, "import_image_task": { "target": "smithy.api#Unit", "traits": { @@ -100963,6 +102776,69 @@ } } }, + "com.amazonaws.ec2#ResourceTypeOption": { + "type": "structure", + "members": { + "OptionName": { + "target": "com.amazonaws.ec2#ImageReferenceOptionName", + "traits": { + "smithy.api#documentation": "

The name of the option.

\n
    \n
  • \n

    For ec2:Instance:

    \n

    Specify state-name - The current state of the EC2 instance.

    \n
  • \n
  • \n

    For ec2:LaunchTemplate:

    \n

    Specify version-depth - The number of launch template versions to check,\n starting from the most recent version.

    \n
  • \n
" + } + }, + "OptionValues": { + "target": "com.amazonaws.ec2#ResourceTypeOptionValuesList", + "traits": { + "smithy.api#documentation": "

A value for the specified option.

\n
    \n
  • \n

    For state-name:

    \n
      \n
    • \n

      Valid values: pending | running | shutting-down |\n terminated | stopping | stopped\n

      \n
    • \n
    • \n

      Default: All states

      \n
    • \n
    \n
  • \n
  • \n

    For version-depth:

    \n
      \n
    • \n

      Valid values: Integers between 1 and 10000\n

      \n
    • \n
    • \n

      Default: 10\n

      \n
    • \n
    \n
  • \n
", + "smithy.api#xmlName": "OptionValue" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that affect the scope of the response.

" + } + }, + "com.amazonaws.ec2#ResourceTypeOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ResourceTypeOption" + } + }, + "com.amazonaws.ec2#ResourceTypeOptionValue": { + "type": "string" + }, + "com.amazonaws.ec2#ResourceTypeOptionValuesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ResourceTypeOptionValue" + } + }, + "com.amazonaws.ec2#ResourceTypeRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.ec2#ImageReferenceResourceType", + "traits": { + "smithy.api#documentation": "

The resource type.

" + } + }, + "ResourceTypeOptions": { + "target": "com.amazonaws.ec2#ResourceTypeOptionList", + "traits": { + "smithy.api#documentation": "

The options that affect the scope of the response. Valid only when\n ResourceType is ec2:Instance or\n ec2:LaunchTemplate.

", + "smithy.api#xmlName": "ResourceTypeOption" + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource type to check for image references. Associated options can also be specified if the\n resource type is an EC2 instance or launch template.

" + } + }, + "com.amazonaws.ec2#ResourceTypeRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ResourceTypeRequest" + } + }, "com.amazonaws.ec2#ResponseError": { "type": "structure", "members": { @@ -102262,7 +104138,7 @@ "target": "com.amazonaws.ec2#RouteOrigin", "traits": { "aws.protocols#ec2QueryName": "Origin", - "smithy.api#documentation": "

Describes how the route was created.

\n
    \n
  • \n

    \n CreateRouteTable - The route was automatically created when the route table was created.

    \n
  • \n
  • \n

    \n CreateRoute - The route was manually added to the route table.

    \n
  • \n
  • \n

    \n EnableVgwRoutePropagation - The route was propagated by route propagation.

    \n
  • \n
", + "smithy.api#documentation": "

Describes how the route was created.

\n
    \n
  • \n

    \n CreateRouteTable - The route was automatically created when the route table was created.

    \n
  • \n
  • \n

    \n CreateRoute - The route was manually added to the route table.

    \n
  • \n
  • \n

    \n EnableVgwRoutePropagation - The route was propagated by route propagation.

    \n
  • \n
  • \n

    \n Advertisement - The route was created dynamically by Amazon VPC Route Server.

    \n
  • \n
", "smithy.api#xmlName": "origin" } }, @@ -102343,6 +104219,12 @@ "traits": { "smithy.api#enumValue": "EnableVgwRoutePropagation" } + }, + "Advertisement": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Advertisement" + } } } }, @@ -103295,6 +105177,12 @@ "traits": { "smithy.api#enumValue": "blackhole" } + }, + "filtered": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "filtered" + } } } }, @@ -103405,6 +105293,14 @@ "smithy.api#xmlName": "gatewayId" } }, + "PublicIpv4Pool": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpv4Pool", + "smithy.api#documentation": "

The ID of a public IPv4 pool. A public IPv4 pool is a pool of IPv4 addresses that you've brought to Amazon Web Services with BYOIP.

", + "smithy.api#xmlName": "publicIpv4Pool" + } + }, "AssociationState": { "target": "com.amazonaws.ec2#RouteTableAssociationState", "traits": { @@ -103803,12 +105699,20 @@ "ElasticGpuSpecification": { "target": "com.amazonaws.ec2#ElasticGpuSpecifications", "traits": { + "smithy.api#deprecated": { + "since": "2024-01-08", + "message": "Specifying Elastic Graphics accelerators is no longer supported on the RunInstances API." + }, "smithy.api#documentation": "

An elastic GPU to associate with the instance.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n
" } }, "ElasticInferenceAccelerators": { "target": "com.amazonaws.ec2#ElasticInferenceAccelerators", "traits": { + "smithy.api#deprecated": { + "since": "2024-01-08", + "message": "Specifying Elastic Inference accelerators is no longer supported on the RunInstances API." + }, "smithy.api#documentation": "

An elastic inference accelerator to associate with the instance.

\n \n

Amazon Elastic Inference is no longer available.

\n
", "smithy.api#xmlName": "ElasticInferenceAccelerator" } @@ -105917,11 +107821,19 @@ "smithy.api#xmlName": "serviceState" } }, + "AvailabilityZoneIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneIdSet", + "smithy.api#documentation": "

The IDs of the Availability Zones in which the service is available.

\n

Either AvailabilityZone or AvailabilityZoneId can be specified, but not both

", + "smithy.api#xmlName": "availabilityZoneIdSet" + } + }, "AvailabilityZones": { "target": "com.amazonaws.ec2#ValueStringList", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZoneSet", - "smithy.api#documentation": "

The Availability Zones in which the service is available.

", + "smithy.api#documentation": "

The Availability Zones in which the service is available.

\n

Either AvailabilityZone or AvailabilityZoneId can be specified, but not both

", "smithy.api#xmlName": "availabilityZoneSet" } }, @@ -106087,11 +107999,19 @@ "smithy.api#xmlName": "serviceRegion" } }, + "AvailabilityZoneIds": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneIdSet", + "smithy.api#documentation": "

The IDs of the Availability Zones in which the service is available.

\n

Either AvailabilityZone or AvailabilityZoneId can be specified, but not both

", + "smithy.api#xmlName": "availabilityZoneIdSet" + } + }, "AvailabilityZones": { "target": "com.amazonaws.ec2#ValueStringList", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZoneSet", - "smithy.api#documentation": "

The Availability Zones in which the service is available.

", + "smithy.api#documentation": "

The Availability Zones in which the service is available.

\n

Either AvailabilityZone or AvailabilityZoneId can be specified, but not both

", "smithy.api#xmlName": "availabilityZoneSet" } }, @@ -108095,10 +110015,18 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "LaunchedAvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in which the request is launched.

", + "smithy.api#documentation": "

The Availability Zone in which the request is launched.

\n

Either launchedAvailabilityZone or launchedAvailabilityZoneId can be specified, but not both

", "smithy.api#xmlName": "launchedAvailabilityZone" } }, + "LaunchedAvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LaunchedAvailabilityZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone in which the request is launched.

\n

Either launchedAvailabilityZone or launchedAvailabilityZoneId can be specified, but not both

", + "smithy.api#xmlName": "launchedAvailabilityZoneId" + } + }, "ProductDescription": { "target": "com.amazonaws.ec2#RIProductDescription", "traits": { @@ -108603,6 +110531,14 @@ "smithy.api#xmlName": "availabilityZone" } }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, "InstanceType": { "target": "com.amazonaws.ec2#InstanceType", "traits": { @@ -111265,6 +113201,29 @@ } } }, + "com.amazonaws.ec2#TrafficIpAddressType": { + "type": "enum", + "members": { + "ipv4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "ipv6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv6" + } + }, + "dual_stack": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dual-stack" + } + } + } + }, "com.amazonaws.ec2#TrafficMirrorFilter": { "type": "structure", "members": { @@ -113280,7 +115239,7 @@ "target": "com.amazonaws.ec2#DefaultRouteTableAssociationValue", "traits": { "aws.protocols#ec2QueryName": "DefaultRouteTableAssociation", - "smithy.api#documentation": "

Indicates whether resource attachments are automatically associated with the default\n association route table. Enabled by default. If defaultRouteTableAssociation\n is set to enable,\n Amazon Web Services Transit Gateway will create the default transit gateway route\n table.

", + "smithy.api#documentation": "

Indicates whether resource attachments are automatically associated with the default\n association route table. Enabled by default. Either defaultRouteTableAssociation or defaultRouteTablePropagation must be set to enable for Amazon Web Services Transit Gateway to create the default transit gateway route table.

", "smithy.api#xmlName": "defaultRouteTableAssociation" } }, @@ -113296,7 +115255,7 @@ "target": "com.amazonaws.ec2#DefaultRouteTablePropagationValue", "traits": { "aws.protocols#ec2QueryName": "DefaultRouteTablePropagation", - "smithy.api#documentation": "

Indicates whether resource attachments automatically propagate routes to the default\n propagation route table. Enabled by default. If defaultRouteTablePropagation\n is set to enable,\n Amazon Web Services Transit Gateway will create the default transit gateway route\n table.

", + "smithy.api#documentation": "

Indicates whether resource attachments automatically propagate routes to the default\n propagation route table. Enabled by default. If defaultRouteTablePropagation\n is set to enable,\n Amazon Web Services Transit Gateway creates the default transit gateway route\n table.

", "smithy.api#xmlName": "defaultRouteTablePropagation" } }, @@ -115966,6 +117925,15 @@ } } }, + "com.amazonaws.ec2#UserIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#UserIdStringList": { "type": "list", "member": { @@ -117841,6 +119809,14 @@ "com.amazonaws.ec2#Volume": { "type": "structure", "members": { + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The ID of the Availability Zone for the volume.

", + "smithy.api#xmlName": "availabilityZoneId" + } + }, "OutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { @@ -118612,6 +120588,12 @@ "traits": { "smithy.api#enumValue": "insufficient-data" } + }, + "warning": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "warning" + } } } }, diff --git a/codegen/sdk/aws-models/ecr-public.json b/codegen/sdk/aws-models/ecr-public.json index f0277f17028..f70cb0da5bc 100644 --- a/codegen/sdk/aws-models/ecr-public.json +++ b/codegen/sdk/aws-models/ecr-public.json @@ -3369,17 +3369,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3393,17 +3382,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3417,17 +3395,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3441,17 +3408,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/ecr.json b/codegen/sdk/aws-models/ecr.json index b52f81862fd..175647a1816 100644 --- a/codegen/sdk/aws-models/ecr.json +++ b/codegen/sdk/aws-models/ecr.json @@ -1819,17 +1819,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1843,17 +1832,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1867,17 +1845,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1891,17 +1858,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/ecs.json b/codegen/sdk/aws-models/ecs.json index ee8e1d6f513..19641da23ef 100644 --- a/codegen/sdk/aws-models/ecs.json +++ b/codegen/sdk/aws-models/ecs.json @@ -29,6 +29,208 @@ ] }, "shapes": { + "com.amazonaws.ecs#AcceleratorCountRequest": { + "type": "structure", + "members": { + "min": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The minimum number of accelerators. Instance types with fewer accelerators are excluded from selection.

" + } + }, + "max": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of accelerators. Instance types with more accelerators are excluded from selection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of accelerators (such as GPUs) for instance type selection. This is used for workloads that require specific numbers of accelerators.

" + } + }, + "com.amazonaws.ecs#AcceleratorManufacturer": { + "type": "enum", + "members": { + "AMAZON_WEB_SERVICES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon-web-services" + } + }, + "AMD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amd" + } + }, + "NVIDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nvidia" + } + }, + "XILINX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xilinx" + } + }, + "HABANA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "habana" + } + } + } + }, + "com.amazonaws.ecs#AcceleratorManufacturerSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#AcceleratorManufacturer", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ecs#AcceleratorName": { + "type": "enum", + "members": { + "A100": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a100" + } + }, + "INFERENTIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inferentia" + } + }, + "K520": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "k520" + } + }, + "K80": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "k80" + } + }, + "M60": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m60" + } + }, + "RADEON_PRO_V520": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "radeon-pro-v520" + } + }, + "T4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4" + } + }, + "VU9P": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vu9p" + } + }, + "V100": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "v100" + } + }, + "A10G": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a10g" + } + }, + "H100": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "h100" + } + }, + "T4G": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4g" + } + } + } + }, + "com.amazonaws.ecs#AcceleratorNameSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#AcceleratorName", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ecs#AcceleratorTotalMemoryMiBRequest": { + "type": "structure", + "members": { + "min": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The minimum total accelerator memory in MiB. Instance types with less accelerator memory are excluded from selection.

" + } + }, + "max": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The maximum total accelerator memory in MiB. Instance types with more accelerator memory are excluded from selection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum total accelerator memory in mebibytes (MiB) for instance type selection. This is important for GPU workloads that require specific amounts of video memory.

" + } + }, + "com.amazonaws.ecs#AcceleratorType": { + "type": "enum", + "members": { + "GPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gpu" + } + }, + "FPGA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fpga" + } + }, + "INFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inference" + } + } + } + }, + "com.amazonaws.ecs#AcceleratorTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#AcceleratorType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ecs#AccessDeniedException": { "type": "structure", "members": { @@ -117,6 +319,31 @@ } } }, + "com.amazonaws.ecs#AllowedInstanceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*\\-]+$" + } + }, + "com.amazonaws.ecs#AllowedInstanceTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#AllowedInstanceType", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + } + } + }, "com.amazonaws.ecs#AmazonEC2ContainerServiceV20141113": { "type": "service", "version": "2014-11-13", @@ -1168,17 +1395,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1192,17 +1408,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1216,17 +1421,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1240,17 +1434,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -1582,6 +1765,49 @@ "smithy.api#documentation": "

An object representing the networking details for a task or service. For example\n\t\t\t\tawsVpcConfiguration={subnets=[\"subnet-12344321\"],securityGroups=[\"sg-12344321\"]}.

" } }, + "com.amazonaws.ecs#BareMetal": { + "type": "enum", + "members": { + "INCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "included" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + }, + "EXCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "excluded" + } + } + } + }, + "com.amazonaws.ecs#BaselineEbsBandwidthMbpsRequest": { + "type": "structure", + "members": { + "min": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The minimum baseline Amazon EBS bandwidth in Mbps. Instance types with lower Amazon EBS bandwidth are excluded from selection.

" + } + }, + "max": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The maximum baseline Amazon EBS bandwidth in Mbps. Instance types with higher Amazon EBS bandwidth are excluded from selection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum baseline Amazon EBS bandwidth in megabits per second (Mbps) for instance type selection. This is important for workloads with high storage I/O requirements.

" + } + }, "com.amazonaws.ecs#BlockedException": { "type": "structure", "members": { @@ -1593,7 +1819,7 @@ } }, "traits": { - "smithy.api#documentation": "

Your Amazon Web Services account was blocked. For more information, contact \n\t\t\t\tAmazon Web ServicesSupport.

", + "smithy.api#documentation": "

Your Amazon Web Services account was blocked. For more information, contact \n\t\t\t\tAmazon Web Services Support.

", "smithy.api#error": "client" } }, @@ -1606,9 +1832,35 @@ "com.amazonaws.ecs#BoxedBoolean": { "type": "boolean" }, + "com.amazonaws.ecs#BoxedDouble": { + "type": "double" + }, "com.amazonaws.ecs#BoxedInteger": { "type": "integer" }, + "com.amazonaws.ecs#BurstablePerformance": { + "type": "enum", + "members": { + "INCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "included" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + }, + "EXCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "excluded" + } + } + } + }, "com.amazonaws.ecs#CPUArchitecture": { "type": "enum", "members": { @@ -1641,6 +1893,12 @@ "smithy.api#documentation": "

The name of the capacity provider.

" } }, + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The cluster that this capacity provider is associated with. Managed instances capacity providers are cluster-scoped, meaning they can only be used within their associated cluster.

" + } + }, "status": { "target": "com.amazonaws.ecs#CapacityProviderStatus", "traits": { @@ -1653,6 +1911,12 @@ "smithy.api#documentation": "

The Auto Scaling group settings for the capacity provider.

" } }, + "managedInstancesProvider": { + "target": "com.amazonaws.ecs#ManagedInstancesProvider", + "traits": { + "smithy.api#documentation": "

The configuration for the Amazon ECS Managed Instances provider. This includes the infrastructure role, the launch template configuration, and tag propagation settings.

" + } + }, "updateStatus": { "target": "com.amazonaws.ecs#CapacityProviderUpdateStatus", "traits": { @@ -1670,6 +1934,12 @@ "traits": { "smithy.api#documentation": "

The metadata that you apply to the capacity provider to help you categorize and\n\t\t\torganize it. Each tag consists of a key and an optional value. You define both.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only\n one value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case-sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.

    \n
  • \n
" } + }, + "type": { + "target": "com.amazonaws.ecs#CapacityProviderType", + "traits": { + "smithy.api#documentation": "

The type of capacity provider. For Amazon ECS Managed Instances, this value is MANAGED_INSTANCES, indicating that Amazon ECS manages the underlying Amazon EC2 instances on your behalf.

" + } } }, "traits": { @@ -1696,12 +1966,24 @@ "com.amazonaws.ecs#CapacityProviderStatus": { "type": "enum", "members": { + "PROVISIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONING" + } + }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, + "DEPROVISIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPROVISIONING" + } + }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { @@ -1730,14 +2012,14 @@ "target": "com.amazonaws.ecs#CapacityProviderStrategyItemWeight", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The weight value designates the relative percentage of the total\n\t\t\tnumber of tasks launched that should use the specified capacity provider. The\n\t\t\t\tweight value is taken into consideration after the base\n\t\t\tvalue, if defined, is satisfied.

\n

If no weight value is specified, the default value of 0 is\n\t\t\tused. When multiple capacity providers are specified within a capacity provider\n\t\t\tstrategy, at least one of the capacity providers must have a weight value greater than\n\t\t\tzero and any capacity providers with a weight of 0 can't be used to place\n\t\t\ttasks. If you specify multiple capacity providers in a strategy that all have a weight\n\t\t\tof 0, any RunTask or CreateService actions using\n\t\t\tthe capacity provider strategy will fail.

\n

An example scenario for using weights is defining a strategy that contains two\n\t\t\tcapacity providers and both have a weight of 1, then when the\n\t\t\t\tbase is satisfied, the tasks will be split evenly across the two\n\t\t\tcapacity providers. Using that same logic, if you specify a weight of 1 for\n\t\t\t\tcapacityProviderA and a weight of 4 for\n\t\t\t\tcapacityProviderB, then for every one task that's run using\n\t\t\t\tcapacityProviderA, four tasks would use\n\t\t\t\tcapacityProviderB.

" + "smithy.api#documentation": "

The weight value designates the relative percentage of the total\n\t\t\tnumber of tasks launched that should use the specified capacity provider. The\n\t\t\tweight value is taken into consideration after the base\n\t\t\tvalue, if defined, is satisfied.

\n

If no weight value is specified, the default value of 0 is\n\t\t\tused. When multiple capacity providers are specified within a capacity provider\n\t\t\tstrategy, at least one of the capacity providers must have a weight value greater than\n\t\t\tzero and any capacity providers with a weight of 0 can't be used to place\n\t\t\ttasks. If you specify multiple capacity providers in a strategy that all have a weight\n\t\t\tof 0, any RunTask or CreateService actions using\n\t\t\tthe capacity provider strategy will fail.

\n

Weight value characteristics:

\n
    \n
  • \n

    Weight is considered after the base value is satisfied

    \n
  • \n
  • \n

    Default value is 0 if not specified

    \n
  • \n
  • \n

    Valid range: 0 to 1,000

    \n
  • \n
  • \n

    At least one capacity provider must have a weight greater than zero

    \n
  • \n
  • \n

    Capacity providers with weight of 0 cannot place tasks

    \n
  • \n
\n

Task distribution logic:

\n
    \n
  1. \n

    Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider

    \n
  2. \n
  3. \n

    Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios

    \n
  4. \n
\n

Examples:

\n

Equal Distribution: Two capacity providers both with weight 1 will split tasks evenly after base requirements are met.

\n

Weighted Distribution: If capacityProviderA has weight 1 and capacityProviderB has weight 4, then for every 1 task on A, 4 tasks will run on B.

" } }, "base": { "target": "com.amazonaws.ecs#CapacityProviderStrategyItemBase", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The base value designates how many tasks, at a minimum, to run on\n\t\t\tthe specified capacity provider. Only one capacity provider in a capacity provider\n\t\t\tstrategy can have a base defined. If no value is specified, the\n\t\t\tdefault value of 0 is used.

" + "smithy.api#documentation": "

The base value designates how many tasks, at a minimum, to run on\n\t\t\tthe specified capacity provider for each service. Only one capacity provider in a capacity provider\n\t\t\tstrategy can have a base defined. If no value is specified, the\n\t\t\tdefault value of 0 is used.

\n

Base value characteristics:

\n
    \n
  • \n

    Only one capacity provider in a strategy can have a base defined

    \n
  • \n
  • \n

    Default value is 0 if not specified

    \n
  • \n
  • \n

    Valid range: 0 to 100,000

    \n
  • \n
  • \n

    Base requirements are satisfied first before weight distribution

    \n
  • \n
" } } }, @@ -1765,9 +2047,56 @@ } } }, + "com.amazonaws.ecs#CapacityProviderType": { + "type": "enum", + "members": { + "EC2_AUTOSCALING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_AUTOSCALING" + } + }, + "MANAGED_INSTANCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED_INSTANCES" + } + }, + "FARGATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FARGATE" + } + }, + "FARGATE_SPOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FARGATE_SPOT" + } + } + } + }, "com.amazonaws.ecs#CapacityProviderUpdateStatus": { "type": "enum", "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "CREATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_COMPLETE" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, "DELETE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { @@ -1879,7 +2208,7 @@ "target": "com.amazonaws.ecs#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The number of services that are running on the cluster in an ACTIVE\n\t\t\tstate. You can view these services with PListServices.

" + "smithy.api#documentation": "

The number of services that are running on the cluster in an ACTIVE\n\t\t\tstate. You can view these services with ListServices.

" } }, "statistics": { @@ -1955,6 +2284,21 @@ "smithy.api#documentation": "

The execute command and managed storage configuration for the cluster.

" } }, + "com.amazonaws.ecs#ClusterContainsCapacityProviderException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

Message that describes the cause of the exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The cluster contains one or more capacity providers that prevent the requested operation. This exception occurs when you try to delete a cluster that still has active capacity providers, including Amazon ECS Managed Instances capacity providers. You must first delete all capacity providers from the cluster before you can delete the cluster itself.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.ecs#ClusterContainsContainerInstancesException": { "type": "structure", "members": { @@ -2091,7 +2435,7 @@ "name": { "target": "com.amazonaws.ecs#ClusterSettingName", "traits": { - "smithy.api#documentation": "

The name of the cluster setting. The value is containerInsights .

" + "smithy.api#documentation": "

The name of the cluster setting. The value is containerInsights.

" } }, "value": { @@ -2148,6 +2492,12 @@ "traits": { "smithy.api#enumValue": "EXTERNAL" } + }, + "MANAGED_INSTANCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED_INSTANCES" + } } } }, @@ -2383,7 +2733,7 @@ "portMappings": { "target": "com.amazonaws.ecs#PortMappingList", "traits": { - "smithy.api#documentation": "

The list of port mappings for the container. Port mappings allow containers to access\n\t\t\tports on the host container instance to send or receive traffic.

\n

For task definitions that use the awsvpc network mode, only specify the\n\t\t\t\tcontainerPort. The hostPort can be left blank or it must\n\t\t\tbe the same value as the containerPort.

\n

Port mappings on Windows use the NetNAT gateway address rather than\n\t\t\t\tlocalhost. There's no loopback for port mappings on Windows, so you\n\t\t\tcan't access a container's mapped port from the host itself.

\n

This parameter maps to PortBindings in the the docker container create\n\t\t\tcommand and the --publish option to docker run. If the network mode of a\n\t\t\ttask definition is set to none, then you can't specify port mappings. If\n\t\t\tthe network mode of a task definition is set to host, then host ports must\n\t\t\teither be undefined or they must match the container port in the port mapping.

\n \n

After a task reaches the RUNNING status, manual and automatic host\n\t\t\t\tand container port assignments are visible in the Network\n\t\t\t\t\tBindings section of a container description for a selected task in\n\t\t\t\tthe Amazon ECS console. The assignments are also visible in the\n\t\t\t\t\tnetworkBindings section DescribeTasks\n\t\t\t\tresponses.

\n
" + "smithy.api#documentation": "

The list of port mappings for the container. Port mappings allow containers to access\n\t\t\tports on the host container instance to send or receive traffic.

\n

For task definitions that use the awsvpc network mode, only specify the\n\t\t\t\tcontainerPort. The hostPort can be left blank or it must\n\t\t\tbe the same value as the containerPort.

\n

Port mappings on Windows use the NetNAT gateway address rather than\n\t\t\t\tlocalhost. There's no loopback for port mappings on Windows, so you\n\t\t\tcan't access a container's mapped port from the host itself.

\n

This parameter maps to PortBindings in the docker container create\n\t\t\tcommand and the --publish option to docker run. If the network mode of a\n\t\t\ttask definition is set to none, then you can't specify port mappings. If\n\t\t\tthe network mode of a task definition is set to host, then host ports must\n\t\t\teither be undefined or they must match the container port in the port mapping.

\n \n

After a task reaches the RUNNING status, manual and automatic host\n\t\t\t\tand container port assignments are visible in the Network\n\t\t\t\t\tBindings section of a container description for a selected task in\n\t\t\t\tthe Amazon ECS console. The assignments are also visible in the\n\t\t\t\t\tnetworkBindings section DescribeTasks\n\t\t\t\tresponses.

\n
" } }, "essential": { @@ -2990,30 +3340,62 @@ "reason": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The reason for the state change.

" + "smithy.api#documentation": "

The reason for the state change.

" + } + }, + "status": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The status of the container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that represents a change in state for a container.

" + } + }, + "com.amazonaws.ecs#ContainerStateChanges": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ContainerStateChange" + } + }, + "com.amazonaws.ecs#Containers": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Container" + } + }, + "com.amazonaws.ecs#CpuManufacturer": { + "type": "enum", + "members": { + "INTEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "intel" + } + }, + "AMD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amd" } }, - "status": { - "target": "com.amazonaws.ecs#String", + "AMAZON_WEB_SERVICES": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The status of the container.

" + "smithy.api#enumValue": "amazon-web-services" } } - }, - "traits": { - "smithy.api#documentation": "

An object that represents a change in state for a container.

" - } - }, - "com.amazonaws.ecs#ContainerStateChanges": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#ContainerStateChange" } }, - "com.amazonaws.ecs#Containers": { + "com.amazonaws.ecs#CpuManufacturerSet": { "type": "list", "member": { - "target": "com.amazonaws.ecs#Container" + "target": "com.amazonaws.ecs#CpuManufacturer", + "traits": { + "smithy.api#xmlName": "item" + } } }, "com.amazonaws.ecs#CreateCapacityProvider": { @@ -3028,6 +3410,9 @@ { "target": "com.amazonaws.ecs#ClientException" }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, @@ -3037,12 +3422,15 @@ { "target": "com.amazonaws.ecs#ServerException" }, + { + "target": "com.amazonaws.ecs#UnsupportedFeatureException" + }, { "target": "com.amazonaws.ecs#UpdateInProgressException" } ], "traits": { - "smithy.api#documentation": "

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS\n\t\t\tcluster and are used in capacity provider strategies to facilitate cluster auto\n\t\t\tscaling.

\n

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on\n\t\t\tFargate use the FARGATE and FARGATE_SPOT capacity providers.\n\t\t\tThese providers are available to all accounts in the Amazon Web Services Regions that Fargate\n\t\t\tsupports.

", + "smithy.api#documentation": "

Creates a capacity provider. Capacity providers are associated with a cluster and are used in capacity provider strategies to facilitate cluster auto scaling. You can create capacity providers for Amazon ECS Managed Instances and EC2 instances. Fargate has the predefined FARGATE and FARGATE_SPOT capacity providers.

", "smithy.api#examples": [ { "title": "To create a capacity provider ", @@ -3091,11 +3479,22 @@ "smithy.api#required": {} } }, + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster to associate with the capacity provider. When you create a capacity provider with Amazon ECS Managed Instances, it becomes available only within the specified cluster.

" + } + }, "autoScalingGroupProvider": { "target": "com.amazonaws.ecs#AutoScalingGroupProvider", "traits": { - "smithy.api#documentation": "

The details of the Auto Scaling group for the capacity provider.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The details of the Auto Scaling group for the capacity provider.

" + } + }, + "managedInstancesProvider": { + "target": "com.amazonaws.ecs#CreateManagedInstancesProviderConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the Amazon ECS Managed Instances provider. This configuration specifies how Amazon ECS manages Amazon EC2 instances on your behalf, including the infrastructure role, instance launch template, and tag propagation settings.

" } }, "tags": { @@ -3233,6 +3632,34 @@ "smithy.api#output": {} } }, + "com.amazonaws.ecs#CreateManagedInstancesProviderConfiguration": { + "type": "structure", + "members": { + "infrastructureRoleArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure role that Amazon ECS uses to manage instances on your behalf. This role must have permissions to launch, terminate, and manage Amazon EC2 instances, as well as access to other Amazon Web Services services required for Amazon ECS Managed Instances functionality.

\n

For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.\n\t\t

", + "smithy.api#required": {} + } + }, + "instanceLaunchTemplate": { + "target": "com.amazonaws.ecs#InstanceLaunchTemplate", + "traits": { + "smithy.api#documentation": "

The launch template configuration that specifies how Amazon ECS should launch Amazon EC2 instances. This includes the instance profile, network configuration, storage settings, and instance requirements for attribute-based instance type selection.

\n

For more information, see Store instance launch parameters in Amazon EC2 launch templates in the Amazon EC2 User Guide.

", + "smithy.api#required": {} + } + }, + "propagateTags": { + "target": "com.amazonaws.ecs#PropagateMITags", + "traits": { + "smithy.api#documentation": "

Specifies whether to propagate tags from the capacity provider to the Amazon ECS Managed Instances. When enabled, tags applied to the capacity provider are automatically applied to all instances launched by this provider.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for creating a Amazon ECS Managed Instances provider. This specifies how Amazon ECS should manage Amazon EC2 instances, including the infrastructure role, instance launch template, and whether to propagate tags from the capacity provider to the instances.

" + } + }, "com.amazonaws.ecs#CreateService": { "type": "operation", "input": { @@ -3406,13 +3833,13 @@ "availabilityZoneRebalancing": { "target": "com.amazonaws.ecs#AvailabilityZoneRebalancing", "traits": { - "smithy.api#documentation": "

Indicates whether to use Availability Zone rebalancing for the service.

\n

For more information, see Balancing an Amazon ECS service across Availability Zones in\n\t\t\tthe \n Amazon Elastic Container Service Developer Guide\n .

" + "smithy.api#documentation": "

Indicates whether to use Availability Zone rebalancing for the service.

\n

For more information, see Balancing an Amazon ECS service across Availability Zones in\n\t\t\tthe \n Amazon Elastic Container Service Developer Guide\n .

\n

The default behavior of AvailabilityZoneRebalancing differs between create and update requests:

\n
    \n
  • \n

    For create service requests, when no value is specified for AvailabilityZoneRebalancing, Amazon ECS defaults the value to ENABLED.

    \n
  • \n
  • \n

    For update service requests, when no value is specified for AvailabilityZoneRebalancing, Amazon ECS defaults to the existing service’s AvailabilityZoneRebalancing value. If the service never had an AvailabilityZoneRebalancing value set, Amazon ECS treats this as DISABLED.

    \n
  • \n
" } }, "loadBalancers": { "target": "com.amazonaws.ecs#LoadBalancers", "traits": { - "smithy.api#documentation": "

A load balancer object representing the load balancers to use with your service. For\n\t\t\tmore information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

\n

If the service uses the rolling update (ECS) deployment controller and\n\t\t\tusing either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach\n\t\t\tto the service. The service-linked role is required for services that use multiple\n\t\t\ttarget groups. For more information, see Using service-linked roles for Amazon ECS in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

\n

If the service uses the CODE_DEPLOY deployment controller, the service is\n\t\t\trequired to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you\n\t\t\tspecify two target groups (referred to as a targetGroupPair). During a\n\t\t\tdeployment, CodeDeploy determines which task set in your service has the status\n\t\t\t\tPRIMARY, and it associates one target group with it. Then, it also\n\t\t\tassociates the other target group with the replacement task set. The load balancer can\n\t\t\talso have up to two listeners: a required listener for production traffic and an\n\t\t\toptional listener that you can use to perform validation tests with Lambda functions\n\t\t\tbefore routing production traffic to it.

\n

If you use the CODE_DEPLOY deployment controller, these values can be\n\t\t\tchanged when updating the service.

\n

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n\t\t\tthe container name, and the container port to access from the load balancer. The\n\t\t\tcontainer name must be as it appears in a container definition. The load balancer name\n\t\t\tparameter must be omitted. When a task from this service is placed on a container\n\t\t\tinstance, the container instance and port combination is registered as a target in the\n\t\t\ttarget group that's specified here.

\n

For Classic Load Balancers, this object must contain the load balancer name, the container name , and\n\t\t\tthe container port to access from the load balancer. The container name must be as it\n\t\t\tappears in a container definition. The target group ARN parameter must be omitted.\n\t\t\tWhen a task from this service is placed on a container instance, the container instance\n\t\t\tis registered with the load balancer that's specified here.

\n

Services with tasks that use the awsvpc network mode (for example, those\n\t\t\twith the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers\n\t\t\taren't supported. Also, when you create any target groups for these services, you must\n\t\t\tchoose ip as the target type, not instance. This is because\n\t\t\ttasks that use the awsvpc network mode are associated with an elastic\n\t\t\tnetwork interface, not an Amazon EC2 instance.

" + "smithy.api#documentation": "

A load balancer object representing the load balancers to use with your service. For\n\t\t\tmore information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

\n

If the service uses the ECS deployment controller and\n\t\t\tusing either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach\n\t\t\tto the service. The service-linked role is required for services that use multiple\n\t\t\ttarget groups. For more information, see Using service-linked roles for Amazon ECS in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

\n

If the service uses the CODE_DEPLOY deployment controller, the service is\n\t\t\trequired to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you\n\t\t\tspecify two target groups (referred to as a targetGroupPair). During a\n\t\t\tdeployment, CodeDeploy determines which task set in your service has the status\n\t\t\t\tPRIMARY, and it associates one target group with it. Then, it also\n\t\t\tassociates the other target group with the replacement task set. The load balancer can\n\t\t\talso have up to two listeners: a required listener for production traffic and an\n\t\t\toptional listener that you can use to perform validation tests with Lambda functions\n\t\t\tbefore routing production traffic to it.

\n

If you use the CODE_DEPLOY deployment controller, these values can be\n\t\t\tchanged when updating the service.

\n

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n\t\t\tthe container name, and the container port to access from the load balancer. The\n\t\t\tcontainer name must be as it appears in a container definition. The load balancer name\n\t\t\tparameter must be omitted. When a task from this service is placed on a container\n\t\t\tinstance, the container instance and port combination is registered as a target in the\n\t\t\ttarget group that's specified here.

\n

For Classic Load Balancers, this object must contain the load balancer name, the container name , and\n\t\t\tthe container port to access from the load balancer. The container name must be as it\n\t\t\tappears in a container definition. The target group ARN parameter must be omitted.\n\t\t\tWhen a task from this service is placed on a container instance, the container instance\n\t\t\tis registered with the load balancer that's specified here.

\n

Services with tasks that use the awsvpc network mode (for example, those\n\t\t\twith the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers\n\t\t\taren't supported. Also, when you create any target groups for these services, you must\n\t\t\tchoose ip as the target type, not instance. This is because\n\t\t\ttasks that use the awsvpc network mode are associated with an elastic\n\t\t\tnetwork interface, not an Amazon EC2 instance.

" } }, "serviceRegistries": { @@ -3484,7 +3911,7 @@ "healthCheckGracePeriodSeconds": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't\n\t\t\tspecify a health check grace period value, the default value of 0 is used.\n\t\t\tIf you don't use any of the health checks, then\n\t\t\t\thealthCheckGracePeriodSeconds is unused.

\n

If your service's tasks take a while to start and respond to health checks, you can\n\t\t\tspecify a health check grace period of up to 2,147,483,647 seconds (about 69 years).\n\t\t\tDuring that time, the Amazon ECS service scheduler ignores health check status. This grace\n\t\t\tperiod can prevent the service scheduler from marking tasks as unhealthy and stopping\n\t\t\tthem before they have time to come up.

" + "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you do not specify a health check grace period value, the default value of 0 is used. If you do not use any of the health checks, then healthCheckGracePeriodSeconds is unused.

\n

If your service has more running tasks than desired, unhealthy tasks in the grace period might be stopped to reach the desired count.

" } }, "schedulingStrategy": { @@ -3968,11 +4395,17 @@ { "target": "com.amazonaws.ecs#ClientException" }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#UnsupportedFeatureException" } ], "traits": { @@ -4016,6 +4449,12 @@ "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.

", "smithy.api#required": {} } + }, + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster that contains the capacity provider to delete. Managed instances capacity providers are cluster-scoped and can only be deleted from their associated cluster.

" + } } }, "traits": { @@ -4048,6 +4487,9 @@ { "target": "com.amazonaws.ecs#ClientException" }, + { + "target": "com.amazonaws.ecs#ClusterContainsCapacityProviderException" + }, { "target": "com.amazonaws.ecs#ClusterContainsContainerInstancesException" }, @@ -4653,7 +5095,7 @@ "minimumHealthyPercent": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tminimumHealthyPercent represents a lower limit on the number of your\n\t\t\tservice's tasks that must remain in the RUNNING state during a deployment,\n\t\t\tas a percentage of the desiredCount (rounded up to the nearest integer).\n\t\t\tThis parameter enables you to deploy without using additional cluster capacity. For\n\t\t\texample, if your service has a desiredCount of four tasks and a\n\t\t\t\tminimumHealthyPercent of 50%, the service scheduler may stop two\n\t\t\texisting tasks to free up cluster capacity before starting two new tasks.

\n

If any tasks are unhealthy and if maximumPercent doesn't allow the Amazon ECS\n\t\t\tscheduler to start replacement tasks, the scheduler stops the unhealthy tasks one-by-one\n\t\t\t— using the minimumHealthyPercent as a constraint — to clear up capacity to\n\t\t\tlaunch replacement tasks. For more information about how the scheduler replaces\n\t\t\tunhealthy tasks, see Amazon ECS services .

\n

For services that do not use a load balancer, the following\n\t\t\tshould be noted:

\n
    \n
  • \n

    A service is considered healthy if all essential containers within the tasks\n\t\t\t\t\tin the service pass their health checks.

    \n
  • \n
  • \n

    If a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for 40 seconds after a task reaches a RUNNING\n\t\t\t\t\tstate before the task is counted towards the minimum healthy percent\n\t\t\t\t\ttotal.

    \n
  • \n
  • \n

    If a task has one or more essential containers with a health check defined,\n\t\t\t\t\tthe service scheduler will wait for the task to reach a healthy status before\n\t\t\t\t\tcounting it towards the minimum healthy percent total. A task is considered\n\t\t\t\t\thealthy when all essential containers within the task have passed their health\n\t\t\t\t\tchecks. The amount of time the service scheduler can wait for is determined by\n\t\t\t\t\tthe container health check settings.

    \n
  • \n
\n

For services that do use a load balancer, the following should be\n\t\t\tnoted:

\n
    \n
  • \n

    If a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for the load balancer target group health check to return a\n\t\t\t\t\thealthy status before counting the task towards the minimum healthy percent\n\t\t\t\t\ttotal.

    \n
  • \n
  • \n

    If a task has an essential container with a health check defined, the service\n\t\t\t\t\tscheduler will wait for both the task to reach a healthy status and the load\n\t\t\t\t\tbalancer target group health check to return a healthy status before counting\n\t\t\t\t\tthe task towards the minimum healthy percent total.

    \n
  • \n
\n

The default value for a replica service for minimumHealthyPercent is\n\t\t\t100%. The default minimumHealthyPercent value for a service using the\n\t\t\t\tDAEMON service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the\n\t\t\tAPIs and 50% for the Amazon Web Services Management Console.

\n

The minimum number of healthy tasks during a deployment is the\n\t\t\t\tdesiredCount multiplied by the minimumHealthyPercent/100,\n\t\t\trounded up to the nearest integer value.

\n

If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and is running tasks that use the\n\t\t\tEC2 launch type, the minimum healthy\n\t\t\t\tpercent value is set to the default value. The minimum healthy percent value is used to define the lower limit on the\n\t\t\tnumber of the tasks in the service that remain in the RUNNING state while\n\t\t\tthe container instances are in the DRAINING state.

\n \n

You can't specify a custom minimumHealthyPercent value for a service\n\t\t\t\tthat uses either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\t\tdeployment types and has tasks that use the EC2 launch type.

\n
\n

If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and is running tasks that use the\n\t\t\tFargate launch type, the minimum healthy percent value is not used,\n\t\t\talthough it is returned when describing your service.

" + "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tminimumHealthyPercent represents a lower limit on the number of your\n\t\t\tservice's tasks that must remain in the RUNNING state during a deployment,\n\t\t\tas a percentage of the desiredCount (rounded up to the nearest integer).\n\t\t\tThis parameter enables you to deploy without using additional cluster capacity. For\n\t\t\texample, if your service has a desiredCount of four tasks and a\n\t\t\t\tminimumHealthyPercent of 50%, the service scheduler may stop two\n\t\t\texisting tasks to free up cluster capacity before starting two new tasks.

\n

If any tasks are unhealthy and if maximumPercent doesn't allow the Amazon ECS\n\t\t\tscheduler to start replacement tasks, the scheduler stops the unhealthy tasks one-by-one\n\t\t\t— using the minimumHealthyPercent as a constraint — to clear up capacity to\n\t\t\tlaunch replacement tasks. For more information about how the scheduler replaces\n\t\t\tunhealthy tasks, see Amazon ECS services.

\n

For services that do not use a load balancer, the following\n\t\t\tshould be noted:

\n
    \n
  • \n

    A service is considered healthy if all essential containers within the tasks\n\t\t\t\t\tin the service pass their health checks.

    \n
  • \n
  • \n

    If a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for 40 seconds after a task reaches a RUNNING\n\t\t\t\t\tstate before the task is counted towards the minimum healthy percent\n\t\t\t\t\ttotal.

    \n
  • \n
  • \n

    If a task has one or more essential containers with a health check defined,\n\t\t\t\t\tthe service scheduler will wait for the task to reach a healthy status before\n\t\t\t\t\tcounting it towards the minimum healthy percent total. A task is considered\n\t\t\t\t\thealthy when all essential containers within the task have passed their health\n\t\t\t\t\tchecks. The amount of time the service scheduler can wait for is determined by\n\t\t\t\t\tthe container health check settings.

    \n
  • \n
\n

For services that do use a load balancer, the following should be\n\t\t\tnoted:

\n
    \n
  • \n

    If a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for the load balancer target group health check to return a\n\t\t\t\t\thealthy status before counting the task towards the minimum healthy percent\n\t\t\t\t\ttotal.

    \n
  • \n
  • \n

    If a task has an essential container with a health check defined, the service\n\t\t\t\t\tscheduler will wait for both the task to reach a healthy status and the load\n\t\t\t\t\tbalancer target group health check to return a healthy status before counting\n\t\t\t\t\tthe task towards the minimum healthy percent total.

    \n
  • \n
\n

The default value for a replica service for minimumHealthyPercent is\n\t\t\t100%. The default minimumHealthyPercent value for a service using the\n\t\t\t\tDAEMON service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the\n\t\t\tAPIs and 50% for the Amazon Web Services Management Console.

\n

The minimum number of healthy tasks during a deployment is the\n\t\t\t\tdesiredCount multiplied by the minimumHealthyPercent/100,\n\t\t\trounded up to the nearest integer value.

\n

If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and is running tasks that use the\n\t\t\tEC2 launch type, the minimum healthy\n\t\t\t\tpercent value is set to the default value. The minimum healthy percent value is used to define the lower limit on the\n\t\t\tnumber of the tasks in the service that remain in the RUNNING state while\n\t\t\tthe container instances are in the DRAINING state.

\n \n

You can't specify a custom minimumHealthyPercent value for a service\n\t\t\t\tthat uses either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\t\tdeployment types and has tasks that use the EC2 launch type.

\n
\n

If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and is running tasks that use the\n\t\t\tFargate launch type, the minimum healthy percent value is not used,\n\t\t\talthough it is returned when describing your service.

" } }, "alarms": { @@ -4757,6 +5199,12 @@ "traits": { "smithy.api#documentation": "

The lifecycle stages at which to run the hook. Choose from these valid values:

\n
    \n
  • \n

    RECONCILE_SERVICE

    \n

    The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

    \n

    You can use a lifecycle hook for this stage.

    \n
  • \n
  • \n

    PRE_SCALE_UP

    \n

    The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

    \n

    You can use a lifecycle hook for this stage.

    \n
  • \n
  • \n

    POST_SCALE_UP

    \n

    The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

    \n

    You can use a lifecycle hook for this stage.

    \n
  • \n
  • \n

    TEST_TRAFFIC_SHIFT

    \n

    The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

    \n

    You can use a lifecycle hook for this stage.

    \n
  • \n
  • \n

    POST_TEST_TRAFFIC_SHIFT

    \n

    The test traffic shift is complete. The green service revision handles 100% of the test traffic.

    \n

    You can use a lifecycle hook for this stage.

    \n
  • \n
  • \n

    PRODUCTION_TRAFFIC_SHIFT

    \n

    Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.

    \n

    You can use a lifecycle hook for this stage.

    \n
  • \n
  • \n

    POST_PRODUCTION_TRAFFIC_SHIFT

    \n

    The production traffic shift is complete.

    \n

    You can use a lifecycle hook for this stage.

    \n
  • \n
\n

You must provide this parameter when configuring a deployment lifecycle hook.

" } + }, + "hookDetails": { + "target": "com.amazonaws.ecs#HookDetails", + "traits": { + "smithy.api#documentation": "

Use this field to specify custom parameters that Amazon ECS will pass to your hook target invocations (such as a Lambda function).

" + } } }, "traits": { @@ -5044,11 +5492,17 @@ { "target": "com.amazonaws.ecs#ClientException" }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#UnsupportedFeatureException" } ], "traits": { @@ -5139,6 +5593,12 @@ "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to\n\t\t\t\t100 capacity providers can be described in an action.

" } }, + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster to describe capacity providers for. When specified, only capacity providers associated with this cluster are returned, including Amazon ECS Managed Instances capacity providers.

" + } + }, "include": { "target": "com.amazonaws.ecs#CapacityProviderFieldList", "traits": { @@ -6155,7 +6615,7 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to\n\t\t\tdescribe. If you do not specify a cluster, the default cluster is assumed. If you do not specify a\n\t\t\tvalue, the default cluster is used.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to\n\t\t\tdescribe. If you do not specify a cluster, the default cluster is assumed.

" } }, "tasks": { @@ -6619,6 +7079,31 @@ "smithy.api#documentation": "

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Using data volumes in\n\t\t\t\ttasks in the Amazon ECS Developer Guide;.

\n \n

For tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:

\n
    \n
  • \n

    Linux platform version 1.4.0 or later.

    \n
  • \n
  • \n

    Windows platform version 1.0.0 or later.

    \n
  • \n
\n
" } }, + "com.amazonaws.ecs#ExcludedInstanceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*\\-]+$" + } + }, + "com.amazonaws.ecs#ExcludedInstanceTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ExcludedInstanceType", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + } + } + }, "com.amazonaws.ecs#ExecuteCommand": { "type": "operation", "input": { @@ -7148,6 +7633,9 @@ } } }, + "com.amazonaws.ecs#HookDetails": { + "type": "document" + }, "com.amazonaws.ecs#HostEntry": { "type": "structure", "members": { @@ -7247,6 +7735,32 @@ "target": "com.amazonaws.ecs#InferenceAccelerator" } }, + "com.amazonaws.ecs#InstanceGeneration": { + "type": "enum", + "members": { + "CURRENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "current" + } + }, + "PREVIOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "previous" + } + } + } + }, + "com.amazonaws.ecs#InstanceGenerationSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#InstanceGeneration", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ecs#InstanceHealthCheckResult": { "type": "structure", "members": { @@ -7291,38 +7805,278 @@ "OK": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "OK" + "smithy.api#enumValue": "OK" + } + }, + "IMPAIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPAIRED" + } + }, + "INSUFFICIENT_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSUFFICIENT_DATA" + } + }, + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZING" + } + } + } + }, + "com.amazonaws.ecs#InstanceHealthCheckType": { + "type": "enum", + "members": { + "CONTAINER_RUNTIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINER_RUNTIME" + } + } + } + }, + "com.amazonaws.ecs#InstanceLaunchTemplate": { + "type": "structure", + "members": { + "ec2InstanceProfileArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance profile that Amazon ECS applies to Amazon ECS Managed Instances. This instance profile must include the necessary permissions for your tasks to access Amazon Web Services services and resources.

\n

For more information, see Amazon ECS instance profile for Managed Instances in the Amazon ECS Developer Guide.\n\t\t

", + "smithy.api#required": {} + } + }, + "networkConfiguration": { + "target": "com.amazonaws.ecs#ManagedInstancesNetworkConfiguration", + "traits": { + "smithy.api#documentation": "

The network configuration for Amazon ECS Managed Instances. This specifies the subnets and security groups that instances use for network connectivity.

", + "smithy.api#required": {} + } + }, + "storageConfiguration": { + "target": "com.amazonaws.ecs#ManagedInstancesStorageConfiguration", + "traits": { + "smithy.api#documentation": "

The storage configuration for Amazon ECS Managed Instances. This defines the root volume size and type for the instances.

" + } + }, + "monitoring": { + "target": "com.amazonaws.ecs#ManagedInstancesMonitoringOptions", + "traits": { + "smithy.api#documentation": "

CloudWatch provides two categories of monitoring: basic monitoring and detailed monitoring. By default, your managed instance is configured for basic monitoring. You can optionally enable detailed monitoring to help you more quickly identify and act on operational issues. You can enable or turn off detailed monitoring at launch or when the managed instance is running or stopped. For more information, see Detailed monitoring for Amazon ECS Managed Instances in the Amazon ECS Developer Guide.

" + } + }, + "instanceRequirements": { + "target": "com.amazonaws.ecs#InstanceRequirementsRequest", + "traits": { + "smithy.api#documentation": "

The instance requirements. You can specify:

\n
    \n
  • \n

    The instance types

    \n
  • \n
  • \n

    Instance requirements such as vCPU count, memory, network performance, and accelerator specifications

    \n
  • \n
\n

Amazon ECS automatically selects the instances that match the specified criteria.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The launch template configuration for Amazon ECS Managed Instances. This defines how Amazon ECS launches Amazon EC2 instances, including the instance profile for your tasks, network and storage configuration, capacity options, and instance requirements for flexible instance type selection.

" + } + }, + "com.amazonaws.ecs#InstanceLaunchTemplateUpdate": { + "type": "structure", + "members": { + "ec2InstanceProfileArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The updated Amazon Resource Name (ARN) of the instance profile. The new instance profile must have the necessary permissions for your tasks.

\n

For more information, see Amazon ECS instance profile for Managed Instances in the Amazon ECS Developer Guide.\n\t\t

" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.ecs#ManagedInstancesNetworkConfiguration", + "traits": { + "smithy.api#documentation": "

The updated network configuration for Amazon ECS Managed Instances. Changes to subnets and security groups affect new instances launched after the update.

" + } + }, + "storageConfiguration": { + "target": "com.amazonaws.ecs#ManagedInstancesStorageConfiguration", + "traits": { + "smithy.api#documentation": "

The updated storage configuration for Amazon ECS Managed Instances. Changes to storage settings apply to new instances launched after the update.

" + } + }, + "monitoring": { + "target": "com.amazonaws.ecs#ManagedInstancesMonitoringOptions", + "traits": { + "smithy.api#documentation": "

CloudWatch provides two categories of monitoring: basic monitoring and detailed monitoring. By default, your managed instance is configured for basic monitoring. You can optionally enable detailed monitoring to help you more quickly identify and act on operational issues. You can enable or turn off detailed monitoring at launch or when the managed instance is running or stopped. For more information, see Detailed monitoring for Amazon ECS Managed Instances in the Amazon ECS Developer Guide.

" + } + }, + "instanceRequirements": { + "target": "com.amazonaws.ecs#InstanceRequirementsRequest", + "traits": { + "smithy.api#documentation": "

The updated instance requirements for attribute-based instance type selection. Changes to instance requirements affect which instance types Amazon ECS selects for new instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The updated launch template configuration for Amazon ECS Managed Instances. You can modify the instance profile, network configuration, storage settings, and instance requirements. Changes apply to new instances launched after the update.

\n

For more information, see Store instance launch parameters in Amazon EC2 launch templates in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ecs#InstanceRequirementsRequest": { + "type": "structure", + "members": { + "vCpuCount": { + "target": "com.amazonaws.ecs#VCpuCountRangeRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of vCPUs for the instance types. Amazon ECS selects instance types that have vCPU counts within this range.

", + "smithy.api#required": {} + } + }, + "memoryMiB": { + "target": "com.amazonaws.ecs#MemoryMiBRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory in mebibytes (MiB) for the instance types. Amazon ECS selects instance types that have memory within this range.

", + "smithy.api#required": {} + } + }, + "cpuManufacturers": { + "target": "com.amazonaws.ecs#CpuManufacturerSet", + "traits": { + "smithy.api#documentation": "

The CPU manufacturers to include or exclude. You can specify intel, amd, or amazon-web-services to control which CPU types are used for your workloads.

", + "smithy.api#xmlName": "CpuManufacturer" + } + }, + "memoryGiBPerVCpu": { + "target": "com.amazonaws.ecs#MemoryGiBPerVCpuRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU in gibibytes (GiB). This helps ensure that instance types have the appropriate memory-to-CPU ratio for your workloads.

" + } + }, + "excludedInstanceTypes": { + "target": "com.amazonaws.ecs#ExcludedInstanceTypeSet", + "traits": { + "smithy.api#documentation": "

The instance types to exclude from selection. Use this to prevent Amazon ECS from selecting specific instance types that may not be suitable for your workloads.

", + "smithy.api#xmlName": "ExcludedInstanceType" + } + }, + "instanceGenerations": { + "target": "com.amazonaws.ecs#InstanceGenerationSet", + "traits": { + "smithy.api#documentation": "

The instance generations to include. You can specify current to use the latest generation instances, or previous to include previous generation instances for cost optimization.

", + "smithy.api#xmlName": "InstanceGeneration" + } + }, + "spotMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The maximum price for Spot instances as a percentage over the lowest priced On-Demand instance. This helps control Spot instance costs while maintaining access to capacity.

" + } + }, + "onDemandMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon ECS selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

" + } + }, + "bareMetal": { + "target": "com.amazonaws.ecs#BareMetal", + "traits": { + "smithy.api#documentation": "

Indicates whether to include bare metal instance types. Set to included to allow bare metal instances, excluded to exclude them, or required to use only bare metal instances.

" + } + }, + "burstablePerformance": { + "target": "com.amazonaws.ecs#BurstablePerformance", + "traits": { + "smithy.api#documentation": "

Indicates whether to include burstable performance instance types (T2, T3, T3a, T4g). Set to included to allow burstable instances, excluded to exclude them, or required to use only burstable instances.

" + } + }, + "requireHibernateSupport": { + "target": "com.amazonaws.ecs#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the instance types must support hibernation. When set to true, only instance types that support hibernation are selected.

" + } + }, + "networkInterfaceCount": { + "target": "com.amazonaws.ecs#NetworkInterfaceCountRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of network interfaces for the instance types. This is useful for workloads that require multiple network interfaces.

" + } + }, + "localStorage": { + "target": "com.amazonaws.ecs#LocalStorage", + "traits": { + "smithy.api#documentation": "

Indicates whether to include instance types with local storage. Set to included to allow local storage, excluded to exclude it, or required to use only instances with local storage.

" + } + }, + "localStorageTypes": { + "target": "com.amazonaws.ecs#LocalStorageTypeSet", + "traits": { + "smithy.api#documentation": "

The local storage types to include. You can specify hdd for hard disk drives, ssd for solid state drives, or both.

", + "smithy.api#xmlName": "LocalStorageType" + } + }, + "totalLocalStorageGB": { + "target": "com.amazonaws.ecs#TotalLocalStorageGBRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum total local storage in gigabytes (GB) for instance types with local storage.

" + } + }, + "baselineEbsBandwidthMbps": { + "target": "com.amazonaws.ecs#BaselineEbsBandwidthMbpsRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum baseline Amazon EBS bandwidth in megabits per second (Mbps). This is important for workloads with high storage I/O requirements.

" + } + }, + "acceleratorTypes": { + "target": "com.amazonaws.ecs#AcceleratorTypeSet", + "traits": { + "smithy.api#documentation": "

The accelerator types to include. You can specify gpu for graphics processing units, fpga for field programmable gate arrays, or inference for machine learning inference accelerators.

", + "smithy.api#xmlName": "AcceleratorType" + } + }, + "acceleratorCount": { + "target": "com.amazonaws.ecs#AcceleratorCountRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of accelerators for the instance types. This is used when you need instances with specific numbers of GPUs or other accelerators.

" + } + }, + "acceleratorManufacturers": { + "target": "com.amazonaws.ecs#AcceleratorManufacturerSet", + "traits": { + "smithy.api#documentation": "

The accelerator manufacturers to include. You can specify nvidia, amd, amazon-web-services, or xilinx depending on your accelerator requirements.

", + "smithy.api#xmlName": "AcceleratorManufacturer" } }, - "IMPAIRED": { - "target": "smithy.api#Unit", + "acceleratorNames": { + "target": "com.amazonaws.ecs#AcceleratorNameSet", "traits": { - "smithy.api#enumValue": "IMPAIRED" + "smithy.api#documentation": "

The specific accelerator names to include. For example, you can specify a100, v100, k80, or other specific accelerator models.

", + "smithy.api#xmlName": "AcceleratorName" } }, - "INSUFFICIENT_DATA": { - "target": "smithy.api#Unit", + "acceleratorTotalMemoryMiB": { + "target": "com.amazonaws.ecs#AcceleratorTotalMemoryMiBRequest", "traits": { - "smithy.api#enumValue": "INSUFFICIENT_DATA" + "smithy.api#documentation": "

The minimum and maximum total accelerator memory in mebibytes (MiB). This is important for GPU workloads that require specific amounts of video memory.

" } }, - "INITIALIZING": { - "target": "smithy.api#Unit", + "networkBandwidthGbps": { + "target": "com.amazonaws.ecs#NetworkBandwidthGbpsRequest", "traits": { - "smithy.api#enumValue": "INITIALIZING" + "smithy.api#documentation": "

The minimum and maximum network bandwidth in gigabits per second (Gbps). This is crucial for network-intensive workloads that require high throughput.

" } - } - } - }, - "com.amazonaws.ecs#InstanceHealthCheckType": { - "type": "enum", - "members": { - "CONTAINER_RUNTIME": { - "target": "smithy.api#Unit", + }, + "allowedInstanceTypes": { + "target": "com.amazonaws.ecs#AllowedInstanceTypeSet", "traits": { - "smithy.api#enumValue": "CONTAINER_RUNTIME" + "smithy.api#documentation": "

The instance types to include in the selection. When specified, Amazon ECS only considers these instance types, subject to the other requirements specified.

", + "smithy.api#xmlName": "AllowedInstanceType" + } + }, + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The maximum price for Spot instances as a percentage of the optimal On-Demand price. This provides more precise cost control for Spot instance selection.

" } } + }, + "traits": { + "smithy.api#documentation": "

The instance requirements for attribute-based instance type selection. Instead of specifying exact instance types, you define requirements such as vCPU count, memory size, network performance, and accelerator specifications. Amazon ECS automatically selects Amazon EC2 instance types that match these requirements, providing flexibility and helping to mitigate capacity constraints.

" } }, "com.amazonaws.ecs#Integer": { @@ -7435,6 +8189,12 @@ "traits": { "smithy.api#enumValue": "EXTERNAL" } + }, + "MANAGED_INSTANCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED_INSTANCES" + } } } }, @@ -8752,6 +9512,55 @@ "target": "com.amazonaws.ecs#LoadBalancer" } }, + "com.amazonaws.ecs#LocalStorage": { + "type": "enum", + "members": { + "INCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "included" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + }, + "EXCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "excluded" + } + } + } + }, + "com.amazonaws.ecs#LocalStorageType": { + "type": "enum", + "members": { + "HDD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hdd" + } + }, + "SSD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ssd" + } + } + } + }, + "com.amazonaws.ecs#LocalStorageTypeSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#LocalStorageType", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ecs#LogConfiguration": { "type": "structure", "members": { @@ -8765,7 +9574,7 @@ "options": { "target": "com.amazonaws.ecs#LogConfigurationOptionsMap", "traits": { - "smithy.api#documentation": "

The configuration options to send to the log driver.

\n

The options you can specify depend on the log driver. Some of the options you can\n\t\t\tspecify when you use the awslogs log driver to route logs to Amazon CloudWatch\n\t\t\tinclude the following:

\n
\n
awslogs-create-group
\n
\n

Required: No

\n

Specify whether you want the log group to be created automatically. If\n\t\t\t\t\t\tthis option isn't specified, it defaults to false.

\n \n

Your IAM policy must include the logs:CreateLogGroup\n\t\t\t\t\t\t\tpermission before you attempt to use\n\t\t\t\t\t\t\tawslogs-create-group.

\n
\n
\n
awslogs-region
\n
\n

Required: Yes

\n

Specify the Amazon Web Services Region that the awslogs log driver is to\n\t\t\t\t\t\tsend your Docker logs to. You can choose to send all of your logs from\n\t\t\t\t\t\tclusters in different Regions to a single region in CloudWatch Logs. This is so that\n\t\t\t\t\t\tthey're all visible in one location. Otherwise, you can separate them by\n\t\t\t\t\t\tRegion for more granularity. Make sure that the specified log group exists\n\t\t\t\t\t\tin the Region that you specify with this option.

\n
\n
awslogs-group
\n
\n

Required: Yes

\n

Make sure to specify a log group that the awslogs log driver\n\t\t\t\t\t\tsends its log streams to.

\n
\n
awslogs-stream-prefix
\n
\n

Required: Yes, when using Fargate.Optional when using EC2.

\n

Use the awslogs-stream-prefix option to associate a log\n\t\t\t\t\t\tstream with the specified prefix, the container name, and the ID of the\n\t\t\t\t\t\tAmazon ECS task that the container belongs to. If you specify a prefix with this\n\t\t\t\t\t\toption, then the log stream takes the format\n\t\t\t\t\t\t\tprefix-name/container-name/ecs-task-id.

\n

If you don't specify a prefix with this option, then the log stream is\n\t\t\t\t\t\tnamed after the container ID that's assigned by the Docker daemon on the\n\t\t\t\t\t\tcontainer instance. Because it's difficult to trace logs back to the\n\t\t\t\t\t\tcontainer that sent them with just the Docker container ID (which is only\n\t\t\t\t\t\tavailable on the container instance), we recommend that you specify a prefix\n\t\t\t\t\t\twith this option.

\n

For Amazon ECS services, you can use the service name as the prefix. Doing so,\n\t\t\t\t\t\tyou can trace log streams to the service that the container belongs to, the\n\t\t\t\t\t\tname of the container that sent them, and the ID of the task that the\n\t\t\t\t\t\tcontainer belongs to.

\n

You must specify a stream-prefix for your logs to have your logs appear in\n\t\t\t\t\t\tthe Log pane when using the Amazon ECS console.

\n
\n
awslogs-datetime-format
\n
\n

Required: No

\n

This option defines a multiline start pattern in Python\n\t\t\t\t\t\t\tstrftime format. A log message consists of a line that\n\t\t\t\t\t\tmatches the pattern and any following lines that don’t match the pattern.\n\t\t\t\t\t\tThe matched line is the delimiter between log messages.

\n

One example of a use case for using this format is for parsing output such\n\t\t\t\t\t\tas a stack dump, which might otherwise be logged in multiple entries. The\n\t\t\t\t\t\tcorrect pattern allows it to be captured in a single entry.

\n

For more information, see awslogs-datetime-format.

\n

You cannot configure both the awslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern options.

\n \n

Multiline logging performs regular expression parsing and matching of\n\t\t\t\t\t\t\tall log messages. This might have a negative impact on logging\n\t\t\t\t\t\t\tperformance.

\n
\n
\n
awslogs-multiline-pattern
\n
\n

Required: No

\n

This option defines a multiline start pattern that uses a regular\n\t\t\t\t\t\texpression. A log message consists of a line that matches the pattern and\n\t\t\t\t\t\tany following lines that don’t match the pattern. The matched line is the\n\t\t\t\t\t\tdelimiter between log messages.

\n

For more information, see awslogs-multiline-pattern.

\n

This option is ignored if awslogs-datetime-format is also\n\t\t\t\t\t\tconfigured.

\n

You cannot configure both the awslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern options.

\n \n

Multiline logging performs regular expression parsing and matching of\n\t\t\t\t\t\t\tall log messages. This might have a negative impact on logging\n\t\t\t\t\t\t\tperformance.

\n
\n
\n
\n

The following options apply to all supported log drivers.

\n
\n
mode
\n
\n

Required: No

\n

Valid values: non-blocking | blocking\n

\n

This option defines the delivery mode of log messages from the container\n\t\t\t\t\t\tto the log driver specified using logDriver. The delivery mode\n\t\t\t\t\t\tyou choose affects application availability when the flow of logs from\n\t\t\t\t\t\tcontainer is interrupted.

\n

If you use the blocking mode and the flow of logs is\n\t\t\t\t\t\tinterrupted, calls from container code to write to the stdout\n\t\t\t\t\t\tand stderr streams will block. The logging thread of the\n\t\t\t\t\t\tapplication will block as a result. This may cause the application to become\n\t\t\t\t\t\tunresponsive and lead to container healthcheck failure.

\n

If you use the non-blocking mode, the container's logs are\n\t\t\t\t\t\tinstead stored in an in-memory intermediate buffer configured with the\n\t\t\t\t\t\t\tmax-buffer-size option. This prevents the application from\n\t\t\t\t\t\tbecoming unresponsive when logs cannot be sent. We recommend using this mode\n\t\t\t\t\t\tif you want to ensure service availability and are okay with some log loss.\n\t\t\t\t\t\tFor more information, see Preventing log loss with non-blocking mode in the awslogs\n\t\t\t\t\t\t\tcontainer log driver.

\n

You can set a default mode for all containers in a specific\n\t\t\t\t\t\tAmazon Web Services Region by using the defaultLogDriverMode account setting.\n\t\t\t\t\t\tIf you don't specify the mode option or\n\t\t\t\t\t\tconfigure the account setting, Amazon ECS will default to the\n\t\t\t\t\t\t\tnon-blocking mode. For more information about the account setting, see Default log driver mode in the Amazon Elastic Container Service Developer Guide.

\n \n

On June 25, 2025, Amazon ECS changed the default log driver mode from blocking to non-blocking to prioritize task availability over logging. To continue using the blocking mode after this change, do one of the following:

\n
    \n
  • \n

    Set the mode option in your container definition's logConfiguration as blocking.

    \n
  • \n
  • \n

    Set the defaultLogDriverMode account setting to blocking.

    \n
  • \n
\n
\n
\n
max-buffer-size
\n
\n

Required: No

\n

Default value: 1m\n

\n

When non-blocking mode is used, the\n\t\t\t\t\t\t\tmax-buffer-size log option controls the size of the buffer\n\t\t\t\t\t\tthat's used for intermediate message storage. Make sure to specify an\n\t\t\t\t\t\tadequate buffer size based on your application. When the buffer fills up,\n\t\t\t\t\t\tfurther logs cannot be stored. Logs that cannot be stored are lost.

\n
\n
\n

To route logs using the splunk log router, you need to specify a\n\t\t\t\tsplunk-token and a splunk-url.

\n

When you use the awsfirelens log router to route logs to an Amazon Web Services Service\n\t\t\tor Amazon Web Services Partner Network destination for log storage and analytics, you can set the\n\t\t\t\tlog-driver-buffer-limit option to limit the number of events that are\n\t\t\tbuffered in memory, before being sent to the log router container. It can help to\n\t\t\tresolve potential log loss issue because high throughput might result in memory running\n\t\t\tout for the buffer inside of Docker.

\n

Other options you can specify when using awsfirelens to route logs depend\n\t\t\ton the destination. When you export logs to Amazon Data Firehose, you can specify the Amazon Web Services Region\n\t\t\twith region and a name for the log stream with\n\t\t\tdelivery_stream.

\n

When you export logs to Amazon Kinesis Data Streams, you can specify an Amazon Web Services Region with\n\t\t\t\tregion and a data stream name with stream.

\n

When you export logs to Amazon OpenSearch Service, you can specify options like Name,\n\t\t\t\tHost (OpenSearch Service endpoint without protocol), Port,\n\t\t\t\tIndex, Type, Aws_auth,\n\t\t\t\tAws_region, Suppress_Type_Name, and tls. For\n\t\t\tmore information, see Under the hood:\n\t\t\t\tFireLens for Amazon ECS Tasks.

\n

When you export logs to Amazon S3, you can specify the bucket using the bucket\n\t\t\toption. You can also specify region, total_file_size,\n\t\t\t\tupload_timeout, and use_put_object as options.

\n

This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n

" + "smithy.api#documentation": "

The configuration options to send to the log driver.

\n

The options you can specify depend on the log driver. Some of the options you can\n\t\t\tspecify when you use the awslogs log driver to route logs to Amazon CloudWatch\n\t\t\tinclude the following:

\n
\n
awslogs-create-group
\n
\n

Required: No

\n

Specify whether you want the log group to be created automatically. If\n\t\t\t\t\t\tthis option isn't specified, it defaults to false.

\n \n

Your IAM policy must include the logs:CreateLogGroup\n\t\t\t\t\t\t\tpermission before you attempt to use\n\t\t\t\t\t\t\tawslogs-create-group.

\n
\n
\n
awslogs-region
\n
\n

Required: Yes

\n

Specify the Amazon Web Services Region that the awslogs log driver is to\n\t\t\t\t\t\tsend your Docker logs to. You can choose to send all of your logs from\n\t\t\t\t\t\tclusters in different Regions to a single region in CloudWatch Logs. This is so that\n\t\t\t\t\t\tthey're all visible in one location. Otherwise, you can separate them by\n\t\t\t\t\t\tRegion for more granularity. Make sure that the specified log group exists\n\t\t\t\t\t\tin the Region that you specify with this option.

\n
\n
awslogs-group
\n
\n

Required: Yes

\n

Make sure to specify a log group that the awslogs log driver\n\t\t\t\t\t\tsends its log streams to.

\n
\n
awslogs-stream-prefix
\n
\n

Required: Yes, when using Fargate.Optional when using EC2.

\n

Use the awslogs-stream-prefix option to associate a log\n\t\t\t\t\t\tstream with the specified prefix, the container name, and the ID of the\n\t\t\t\t\t\tAmazon ECS task that the container belongs to. If you specify a prefix with this\n\t\t\t\t\t\toption, then the log stream takes the format\n\t\t\t\t\t\t\tprefix-name/container-name/ecs-task-id.

\n

If you don't specify a prefix with this option, then the log stream is\n\t\t\t\t\t\tnamed after the container ID that's assigned by the Docker daemon on the\n\t\t\t\t\t\tcontainer instance. Because it's difficult to trace logs back to the\n\t\t\t\t\t\tcontainer that sent them with just the Docker container ID (which is only\n\t\t\t\t\t\tavailable on the container instance), we recommend that you specify a prefix\n\t\t\t\t\t\twith this option.

\n

For Amazon ECS services, you can use the service name as the prefix. Doing so,\n\t\t\t\t\t\tyou can trace log streams to the service that the container belongs to, the\n\t\t\t\t\t\tname of the container that sent them, and the ID of the task that the\n\t\t\t\t\t\tcontainer belongs to.

\n

You must specify a stream-prefix for your logs to have your logs appear in\n\t\t\t\t\t\tthe Log pane when using the Amazon ECS console.

\n
\n
awslogs-datetime-format
\n
\n

Required: No

\n

This option defines a multiline start pattern in Python\n\t\t\t\t\t\t\tstrftime format. A log message consists of a line that\n\t\t\t\t\t\tmatches the pattern and any following lines that don’t match the pattern.\n\t\t\t\t\t\tThe matched line is the delimiter between log messages.

\n

One example of a use case for using this format is for parsing output such\n\t\t\t\t\t\tas a stack dump, which might otherwise be logged in multiple entries. The\n\t\t\t\t\t\tcorrect pattern allows it to be captured in a single entry.

\n

For more information, see awslogs-datetime-format.

\n

You cannot configure both the awslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern options.

\n \n

Multiline logging performs regular expression parsing and matching of\n\t\t\t\t\t\t\tall log messages. This might have a negative impact on logging\n\t\t\t\t\t\t\tperformance.

\n
\n
\n
awslogs-multiline-pattern
\n
\n

Required: No

\n

This option defines a multiline start pattern that uses a regular\n\t\t\t\t\t\texpression. A log message consists of a line that matches the pattern and\n\t\t\t\t\t\tany following lines that don’t match the pattern. The matched line is the\n\t\t\t\t\t\tdelimiter between log messages.

\n

For more information, see awslogs-multiline-pattern.

\n

This option is ignored if awslogs-datetime-format is also\n\t\t\t\t\t\tconfigured.

\n

You cannot configure both the awslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern options.

\n \n

Multiline logging performs regular expression parsing and matching of\n\t\t\t\t\t\t\tall log messages. This might have a negative impact on logging\n\t\t\t\t\t\t\tperformance.

\n
\n
\n
\n

The following options apply to all supported log drivers.

\n
\n
mode
\n
\n

Required: No

\n

Valid values: non-blocking | blocking\n

\n

This option defines the delivery mode of log messages from the container\n\t\t\t\t\t\tto the log driver specified using logDriver. The delivery mode\n\t\t\t\t\t\tyou choose affects application availability when the flow of logs from\n\t\t\t\t\t\tcontainer is interrupted.

\n

If you use the blocking mode and the flow of logs is\n\t\t\t\t\t\tinterrupted, calls from container code to write to the stdout\n\t\t\t\t\t\tand stderr streams will block. The logging thread of the\n\t\t\t\t\t\tapplication will block as a result. This may cause the application to become\n\t\t\t\t\t\tunresponsive and lead to container healthcheck failure.

\n

If you use the non-blocking mode, the container's logs are\n\t\t\t\t\t\tinstead stored in an in-memory intermediate buffer configured with the\n\t\t\t\t\t\t\tmax-buffer-size option. This prevents the application from\n\t\t\t\t\t\tbecoming unresponsive when logs cannot be sent. We recommend using this mode\n\t\t\t\t\t\tif you want to ensure service availability and are okay with some log loss.\n\t\t\t\t\t\tFor more information, see Preventing log loss with non-blocking mode in the awslogs\n\t\t\t\t\t\t\tcontainer log driver.

\n

You can set a default mode for all containers in a specific\n\t\t\t\t\t\tAmazon Web Services Region by using the defaultLogDriverMode account setting.\n\t\t\t\t\t\tIf you don't specify the mode option or\n\t\t\t\t\t\tconfigure the account setting, Amazon ECS will default to the\n\t\t\t\t\t\t\tnon-blocking mode. For more information about the account setting, see Default log driver mode in the Amazon Elastic Container Service Developer Guide.

\n \n

On June 25, 2025, Amazon ECS changed the default log driver mode from blocking to non-blocking to prioritize task availability over logging. To continue using the blocking mode after this change, do one of the following:

\n
    \n
  • \n

    Set the mode option in your container definition's logConfiguration as blocking.

    \n
  • \n
  • \n

    Set the defaultLogDriverMode account setting to blocking.

    \n
  • \n
\n
\n
\n
max-buffer-size
\n
\n

Required: No

\n

Default value: 10m\n

\n

When non-blocking mode is used, the\n\t\t\t\t\t\t\tmax-buffer-size log option controls the size of the buffer\n\t\t\t\t\t\tthat's used for intermediate message storage. Make sure to specify an\n\t\t\t\t\t\tadequate buffer size based on your application. When the buffer fills up,\n\t\t\t\t\t\tfurther logs cannot be stored. Logs that cannot be stored are lost.

\n
\n
\n

To route logs using the splunk log router, you need to specify a\n\t\t\t\tsplunk-token and a splunk-url.

\n

When you use the awsfirelens log router to route logs to an Amazon Web Services Service\n\t\t\tor Amazon Web Services Partner Network destination for log storage and analytics, you can set the\n\t\t\t\tlog-driver-buffer-limit option to limit the number of events that are\n\t\t\tbuffered in memory, before being sent to the log router container. It can help to\n\t\t\tresolve potential log loss issue because high throughput might result in memory running\n\t\t\tout for the buffer inside of Docker.

\n

Other options you can specify when using awsfirelens to route logs depend\n\t\t\ton the destination. When you export logs to Amazon Data Firehose, you can specify the Amazon Web Services Region\n\t\t\twith region and a name for the log stream with\n\t\t\tdelivery_stream.

\n

When you export logs to Amazon Kinesis Data Streams, you can specify an Amazon Web Services Region with\n\t\t\t\tregion and a data stream name with stream.

\n

When you export logs to Amazon OpenSearch Service, you can specify options like Name,\n\t\t\t\tHost (OpenSearch Service endpoint without protocol), Port,\n\t\t\t\tIndex, Type, Aws_auth,\n\t\t\t\tAws_region, Suppress_Type_Name, and tls. For\n\t\t\tmore information, see Under the hood:\n\t\t\t\tFireLens for Amazon ECS Tasks.

\n

When you export logs to Amazon S3, you can specify the bucket using the bucket\n\t\t\toption. You can also specify region, total_file_size,\n\t\t\t\tupload_timeout, and use_put_object as options.

\n

This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n

" } }, "secretOptions": { @@ -8954,6 +9763,83 @@ } } }, + "com.amazonaws.ecs#ManagedInstancesMonitoringOptions": { + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC" + } + }, + "DETAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DETAILED" + } + } + } + }, + "com.amazonaws.ecs#ManagedInstancesNetworkConfiguration": { + "type": "structure", + "members": { + "subnets": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "

The list of subnet IDs where Amazon ECS can launch Amazon ECS Managed Instances. Instances are distributed across the specified subnets for high availability. All subnets must be in the same VPC.

" + } + }, + "securityGroups": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "

The list of security group IDs to apply to Amazon ECS Managed Instances. These security groups control the network traffic allowed to and from the instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The network configuration for Amazon ECS Managed Instances. This specifies the VPC subnets and security groups that instances use for network connectivity. Amazon ECS Managed Instances support multiple network modes including awsvpc (instances receive ENIs for task isolation), host (instances share network namespace with tasks), and none (no external network connectivity), ensuring backward compatibility for migrating workloads from Fargate or Amazon EC2.

" + } + }, + "com.amazonaws.ecs#ManagedInstancesProvider": { + "type": "structure", + "members": { + "infrastructureRoleArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the infrastructure role that Amazon ECS assumes to manage instances. This role must include permissions for Amazon EC2 instance lifecycle management, networking, and any additional Amazon Web Services services required for your workloads.

\n

For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.

" + } + }, + "instanceLaunchTemplate": { + "target": "com.amazonaws.ecs#InstanceLaunchTemplate", + "traits": { + "smithy.api#documentation": "

The launch template that defines how Amazon ECS launches Amazon ECS Managed Instances. This includes the instance profile for your tasks, network and storage configuration, and instance requirements that determine which Amazon EC2 instance types can be used.

\n

For more information, see Store instance launch parameters in Amazon EC2 launch templates in the Amazon EC2 User Guide.

" + } + }, + "propagateTags": { + "target": "com.amazonaws.ecs#PropagateMITags", + "traits": { + "smithy.api#documentation": "

Determines whether tags from the capacity provider are automatically applied to Amazon ECS Managed Instances. This helps with cost allocation and resource management by ensuring consistent tagging across your infrastructure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a Amazon ECS Managed Instances provider. Amazon ECS uses this configuration to automatically launch, manage, and terminate Amazon EC2 instances on your behalf. Managed instances provide access to the full range of Amazon EC2 instance types and features while offloading infrastructure management to Amazon Web Services.

" + } + }, + "com.amazonaws.ecs#ManagedInstancesStorageConfiguration": { + "type": "structure", + "members": { + "storageSizeGiB": { + "target": "com.amazonaws.ecs#TaskVolumeStorageGiB", + "traits": { + "smithy.api#documentation": "

The size of the tasks volume.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The storage configuration for Amazon ECS Managed Instances. This defines the root volume configuration for the instances.

" + } + }, "com.amazonaws.ecs#ManagedScaling": { "type": "structure", "members": { @@ -8972,7 +9858,7 @@ "minimumScalingStepSize": { "target": "com.amazonaws.ecs#ManagedScalingStepSize", "traits": { - "smithy.api#documentation": "

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale\n\t\t\tin process is not affected by this parameter If this parameter is omitted, the default\n\t\t\tvalue of 1 is used.

\n

When additional capacity is required, Amazon ECS will scale up the minimum scaling step\n\t\t\tsize even if the actual demand is less than the minimum scaling step size.

\n

If you use a capacity provider with an Auto Scaling group configured with more than\n\t\t\tone Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum\n\t\t\tscaling step size value and will ignore both the maximum scaling step size as well as\n\t\t\tthe capacity demand.

" + "smithy.api#documentation": "

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale\n\t\t\tin process is not affected by this parameter If this parameter is omitted, the default\n\t\t\tvalue of 1 is used.

\n

When additional capacity is required, Amazon ECS will scale up the minimum scaling step\n\t\t\tsize even if the actual demand is less than the minimum scaling step size.

" } }, "maximumScalingStepSize": { @@ -9073,6 +9959,47 @@ } } }, + "com.amazonaws.ecs#MemoryGiBPerVCpuRequest": { + "type": "structure", + "members": { + "min": { + "target": "com.amazonaws.ecs#BoxedDouble", + "traits": { + "smithy.api#documentation": "

The minimum amount of memory per vCPU in GiB. Instance types with a lower memory-to-vCPU ratio are excluded from selection.

" + } + }, + "max": { + "target": "com.amazonaws.ecs#BoxedDouble", + "traits": { + "smithy.api#documentation": "

The maximum amount of memory per vCPU in GiB. Instance types with a higher memory-to-vCPU ratio are excluded from selection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU in gibibytes (GiB). This helps ensure that instance types have the appropriate memory-to-CPU ratio for your workloads.

" + } + }, + "com.amazonaws.ecs#MemoryMiBRequest": { + "type": "structure", + "members": { + "min": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The minimum amount of memory in MiB. Instance types with less memory than this value are excluded from selection.

", + "smithy.api#required": {} + } + }, + "max": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The maximum amount of memory in MiB. Instance types with more memory than this value are excluded from selection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory in mebibytes (MiB) for instance type selection. This ensures that selected instance types have adequate memory for your workloads.

" + } + }, "com.amazonaws.ecs#MissingVersionException": { "type": "structure", "members": { @@ -9135,6 +10062,26 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ecs#NetworkBandwidthGbpsRequest": { + "type": "structure", + "members": { + "min": { + "target": "com.amazonaws.ecs#BoxedDouble", + "traits": { + "smithy.api#documentation": "

The minimum network bandwidth in Gbps. Instance types with lower network bandwidth are excluded from selection.

" + } + }, + "max": { + "target": "com.amazonaws.ecs#BoxedDouble", + "traits": { + "smithy.api#documentation": "

The maximum network bandwidth in Gbps. Instance types with higher network bandwidth are excluded from selection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum network bandwidth in gigabits per second (Gbps) for instance type selection. This is important for network-intensive workloads.

" + } + }, "com.amazonaws.ecs#NetworkBinding": { "type": "structure", "members": { @@ -9225,6 +10172,26 @@ "smithy.api#documentation": "

An object representing the elastic network interface for tasks that use the\n\t\t\t\tawsvpc network mode.

" } }, + "com.amazonaws.ecs#NetworkInterfaceCountRequest": { + "type": "structure", + "members": { + "min": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The minimum number of network interfaces. Instance types that support fewer network interfaces are excluded from selection.

" + } + }, + "max": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of network interfaces. Instance types that support more network interfaces are excluded from selection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of network interfaces for instance type selection. This is useful for workloads that require multiple network interfaces.

" + } + }, "com.amazonaws.ecs#NetworkInterfaces": { "type": "list", "member": { @@ -9577,6 +10544,23 @@ } } }, + "com.amazonaws.ecs#PropagateMITags": { + "type": "enum", + "members": { + "CAPACITY_PROVIDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAPACITY_PROVIDER" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, "com.amazonaws.ecs#PropagateTags": { "type": "enum", "members": { @@ -9966,7 +10950,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the available capacity providers and the default capacity provider strategy\n\t\t\tfor a cluster.

\n

You must specify both the available capacity providers and a default capacity provider\n\t\t\tstrategy for the cluster. If the specified cluster has existing capacity providers\n\t\t\tassociated with it, you must specify all existing capacity providers in addition to any\n\t\t\tnew ones you want to add. Any existing capacity providers that are associated with a\n\t\t\tcluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the\n\t\t\tcluster. You can only disassociate an existing capacity provider from a cluster if it's\n\t\t\tnot being used by any existing tasks.

\n

When creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified, then the cluster's default capacity provider strategy is used.\n\t\t\tWe recommend that you define a default capacity provider strategy for your cluster.\n\t\t\tHowever, you must specify an empty array ([]) to bypass defining a default\n\t\t\tstrategy.

", + "smithy.api#documentation": "

Modifies the available capacity providers and the default capacity provider strategy\n\t\t\tfor a cluster.

\n

You must specify both the available capacity providers and a default capacity provider\n\t\t\tstrategy for the cluster. If the specified cluster has existing capacity providers\n\t\t\tassociated with it, you must specify all existing capacity providers in addition to any\n\t\t\tnew ones you want to add. Any existing capacity providers that are associated with a\n\t\t\tcluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the\n\t\t\tcluster. You can only disassociate an existing capacity provider from a cluster if it's\n\t\t\tnot being used by any existing tasks.

\n

When creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified, then the cluster's default capacity provider strategy is used.\n\t\t\tWe recommend that you define a default capacity provider strategy for your cluster.\n\t\t\tHowever, you must specify an empty array ([]) to bypass defining a default\n\t\t\tstrategy.

\n

Amazon ECS Managed Instances doesn't support this, because when you create a capacity provider with Amazon ECS Managed Instances, it becomes available only within the specified cluster.

", "smithy.api#examples": [ { "title": "To add an existing capacity provider to a cluuster", @@ -10947,7 +11931,7 @@ "volumeConfigurations": { "target": "com.amazonaws.ecs#TaskVolumeConfigurations", "traits": { - "smithy.api#documentation": "

The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tthe size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. The name of the volume must\n\t\t\tmatch the name from the task definition.

" + "smithy.api#documentation": "

The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tthe size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must\n\t\t\tmatch the name from the task definition.

" } } }, @@ -11257,7 +12241,7 @@ "healthCheckGracePeriodSeconds": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started.

" + "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing, VPC Lattice, and container health checks after a task has first started.

\n

If your service has more running tasks than desired, unhealthy tasks in the grace period might be stopped to reach the desired count.

" } }, "schedulingStrategy": { @@ -11307,7 +12291,7 @@ "availabilityZoneRebalancing": { "target": "com.amazonaws.ecs#AvailabilityZoneRebalancing", "traits": { - "smithy.api#documentation": "

Indicates whether to use Availability Zone rebalancing for the service.

\n

For more information, see Balancing an Amazon ECS service across Availability Zones in\n\t\t\tthe \n Amazon Elastic Container Service Developer Guide\n .

" + "smithy.api#documentation": "

Indicates whether to use Availability Zone rebalancing for the service.

\n

For more information, see Balancing an Amazon ECS service across Availability Zones in\n\t\t\tthe \n Amazon Elastic Container Service Developer Guide\n .

\n

The default behavior of AvailabilityZoneRebalancing differs between create and update requests:

\n
    \n
  • \n

    For create service requests, when no value is specified for AvailabilityZoneRebalancing, Amazon ECS defaults the value to ENABLED.

    \n
  • \n
  • \n

    For update service requests, when no value is specified for AvailabilityZoneRebalancing, Amazon ECS defaults to the existing service’s AvailabilityZoneRebalancing value. If the service never had an AvailabilityZoneRebalancing value set, Amazon ECS treats this as DISABLED.

    \n
  • \n
" } } }, @@ -14428,6 +15412,14 @@ "target": "com.amazonaws.ecs#TaskVolumeConfiguration" } }, + "com.amazonaws.ecs#TaskVolumeStorageGiB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.ecs#Tasks": { "type": "list", "member": { @@ -14492,6 +15484,26 @@ "target": "com.amazonaws.ecs#Tmpfs" } }, + "com.amazonaws.ecs#TotalLocalStorageGBRequest": { + "type": "structure", + "members": { + "min": { + "target": "com.amazonaws.ecs#BoxedDouble", + "traits": { + "smithy.api#documentation": "

The minimum total local storage in GB. Instance types with less local storage are excluded from selection.

" + } + }, + "max": { + "target": "com.amazonaws.ecs#BoxedDouble", + "traits": { + "smithy.api#documentation": "

The maximum total local storage in GB. Instance types with more local storage are excluded from selection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum total local storage in gigabytes (GB) for instance types with local storage. This is useful for workloads that require local storage for temporary data or caching.

" + } + }, "com.amazonaws.ecs#TransportProtocol": { "type": "enum", "members": { @@ -14739,15 +15751,21 @@ { "target": "com.amazonaws.ecs#ClientException" }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, { "target": "com.amazonaws.ecs#InvalidParameterException" }, { "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#UnsupportedFeatureException" } ], "traits": { - "smithy.api#documentation": "

Modifies the parameters for a capacity provider.

", + "smithy.api#documentation": "

Modifies the parameters for a capacity provider.

\n

These changes only apply to new Amazon ECS Managed Instances, or EC2 instances, not existing ones.

", "smithy.api#examples": [ { "title": "To update a capacity provider's parameters", @@ -14796,11 +15814,22 @@ "smithy.api#required": {} } }, + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster that contains the capacity provider to update. Managed instances capacity providers are cluster-scoped and can only be updated within their associated cluster.

" + } + }, "autoScalingGroupProvider": { "target": "com.amazonaws.ecs#AutoScalingGroupProviderUpdate", "traits": { - "smithy.api#documentation": "

An object that represent the parameters to update for the Auto Scaling group capacity\n\t\t\tprovider.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An object that represent the parameters to update for the Auto Scaling group capacity\n\t\t\tprovider.

" + } + }, + "managedInstancesProvider": { + "target": "com.amazonaws.ecs#UpdateManagedInstancesProviderConfiguration", + "traits": { + "smithy.api#documentation": "

The updated configuration for the Amazon ECS Managed Instances provider. You can modify the infrastructure role, instance launch template, and tag propagation settings. Changes take effect for new instances launched after the update.

" } } }, @@ -15521,6 +16550,34 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ecs#UpdateManagedInstancesProviderConfiguration": { + "type": "structure", + "members": { + "infrastructureRoleArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The updated Amazon Resource Name (ARN) of the infrastructure role. The new role must have the necessary permissions to manage instances and access required Amazon Web Services services.

\n

For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.

", + "smithy.api#required": {} + } + }, + "instanceLaunchTemplate": { + "target": "com.amazonaws.ecs#InstanceLaunchTemplateUpdate", + "traits": { + "smithy.api#documentation": "

The updated launch template configuration. Changes to the launch template affect new instances launched after the update, while existing instances continue to use their original configuration.

", + "smithy.api#required": {} + } + }, + "propagateTags": { + "target": "com.amazonaws.ecs#PropagateMITags", + "traits": { + "smithy.api#documentation": "

The updated tag propagation setting. When changed, this affects only new instances launched after the update.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The updated configuration for a Amazon ECS Managed Instances provider. You can modify the infrastructure role, instance launch template, and tag propagation settings. Changes apply to new instances launched after the update.

" + } + }, "com.amazonaws.ecs#UpdateService": { "type": "operation", "input": { @@ -15735,55 +16792,55 @@ "desiredCount": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The number of instantiations of the task to place and keep running in your\n\t\t\tservice.

" + "smithy.api#documentation": "

The number of instantiations of the task to place and keep running in your\n\t\t\tservice.

\n

This parameter doesn't trigger a new service deployment.

" } }, "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision is\n\t\t\tnot specified, the latest ACTIVE revision is used. If you modify the task\n\t\t\tdefinition with UpdateService, Amazon ECS spawns a task with the new version of\n\t\t\tthe task definition and then stops an old task after the new version is running.

" + "smithy.api#documentation": "

The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision is\n\t\t\tnot specified, the latest ACTIVE revision is used. If you modify the task\n\t\t\tdefinition with UpdateService, Amazon ECS spawns a task with the new version of\n\t\t\tthe task definition and then stops an old task after the new version is running.

\n

This parameter triggers a new service deployment.

" } }, "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The details of a capacity provider strategy. You can set a capacity provider when you\n\t\t\tcreate a cluster, run a task, or update a service.

\n

When you use Fargate, the capacity providers are FARGATE or\n\t\t\t\tFARGATE_SPOT.

\n

When you use Amazon EC2, the capacity providers are Auto Scaling groups.

\n

You can change capacity providers for rolling deployments and blue/green\n\t\t\tdeployments.

\n

The following list provides the valid transitions:

\n
    \n
  • \n

    Update the Fargate launch type to an Auto Scaling group capacity provider.

    \n
  • \n
  • \n

    Update the Amazon EC2 launch type to a Fargate capacity provider.

    \n
  • \n
  • \n

    Update the Fargate capacity provider to an Auto Scaling group capacity provider.

    \n
  • \n
  • \n

    Update the Amazon EC2 capacity provider to a Fargate capacity provider.

    \n
  • \n
  • \n

    Update the Auto Scaling group or Fargate capacity provider back to the launch type.

    \n

    Pass an empty list in the capacityProviderStrategy parameter.

    \n
  • \n
\n

For information about Amazon Web Services CDK considerations, see Amazon Web Services CDK considerations.

" + "smithy.api#documentation": "

The details of a capacity provider strategy. You can set a capacity provider when you\n\t\t\tcreate a cluster, run a task, or update a service.

\n

When you use Fargate, the capacity providers are FARGATE or\n\t\t\t\tFARGATE_SPOT.

\n

When you use Amazon EC2, the capacity providers are Auto Scaling groups.

\n

You can change capacity providers for rolling deployments and blue/green\n\t\t\tdeployments.

\n

The following list provides the valid transitions:

\n
    \n
  • \n

    Update the Fargate launch type to an Auto Scaling group capacity provider.

    \n
  • \n
  • \n

    Update the Amazon EC2 launch type to a Fargate capacity provider.

    \n
  • \n
  • \n

    Update the Fargate capacity provider to an Auto Scaling group capacity provider.

    \n
  • \n
  • \n

    Update the Amazon EC2 capacity provider to a Fargate capacity provider.

    \n
  • \n
  • \n

    Update the Auto Scaling group or Fargate capacity provider back to the launch type.

    \n

    Pass an empty list in the capacityProviderStrategy parameter.

    \n
  • \n
\n

For information about Amazon Web Services CDK considerations, see Amazon Web Services CDK considerations.

\n

This parameter doesn't trigger a new service deployment.

" } }, "deploymentConfiguration": { "target": "com.amazonaws.ecs#DeploymentConfiguration", "traits": { - "smithy.api#documentation": "

Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.

" + "smithy.api#documentation": "

Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.

\n

This parameter doesn't trigger a new service deployment.

" } }, "availabilityZoneRebalancing": { "target": "com.amazonaws.ecs#AvailabilityZoneRebalancing", "traits": { - "smithy.api#documentation": "

Indicates whether to use Availability Zone rebalancing for the service.

\n

For more information, see Balancing an Amazon ECS service across Availability Zones in\n\t\t\tthe \n Amazon Elastic Container Service Developer Guide\n .

" + "smithy.api#documentation": "

Indicates whether to use Availability Zone rebalancing for the service.

\n

For more information, see Balancing an Amazon ECS service across Availability Zones in\n\t\t\tthe \n Amazon Elastic Container Service Developer Guide\n .

\n

The default behavior of AvailabilityZoneRebalancing differs between create and update requests:

\n
    \n
  • \n

    For create service requests, when no value is specified for AvailabilityZoneRebalancing, Amazon ECS defaults the value to ENABLED.

    \n
  • \n
  • \n

    For update service requests, when no value is specified for AvailabilityZoneRebalancing, Amazon ECS defaults to the existing service’s AvailabilityZoneRebalancing value. If the service never had an AvailabilityZoneRebalancing value set, Amazon ECS treats this as DISABLED.

    \n
  • \n
\n

This parameter doesn't trigger a new service deployment.

" } }, "networkConfiguration": { "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

An object representing the network configuration for the service.

" + "smithy.api#documentation": "

An object representing the network configuration for the service.

\n

This parameter triggers a new service deployment.

" } }, "placementConstraints": { "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "

An array of task placement constraint objects to update the service to use. If no\n\t\t\tvalue is specified, the existing placement constraints for the service will remain\n\t\t\tunchanged. If this value is specified, it will override any existing placement\n\t\t\tconstraints defined for the service. To remove all existing placement constraints,\n\t\t\tspecify an empty array.

\n

You can specify a maximum of 10 constraints for each task. This limit includes\n\t\t\tconstraints in the task definition and those specified at runtime.

" + "smithy.api#documentation": "

An array of task placement constraint objects to update the service to use. If no\n\t\t\tvalue is specified, the existing placement constraints for the service will remain\n\t\t\tunchanged. If this value is specified, it will override any existing placement\n\t\t\tconstraints defined for the service. To remove all existing placement constraints,\n\t\t\tspecify an empty array.

\n

You can specify a maximum of 10 constraints for each task. This limit includes\n\t\t\tconstraints in the task definition and those specified at runtime.

\n

This parameter doesn't trigger a new service deployment.

" } }, "placementStrategy": { "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "

The task placement strategy objects to update the service to use. If no value is\n\t\t\tspecified, the existing placement strategy for the service will remain unchanged. If\n\t\t\tthis value is specified, it will override the existing placement strategy defined for\n\t\t\tthe service. To remove an existing placement strategy, specify an empty object.

\n

You can specify a maximum of five strategy rules for each service.

" + "smithy.api#documentation": "

The task placement strategy objects to update the service to use. If no value is\n\t\t\tspecified, the existing placement strategy for the service will remain unchanged. If\n\t\t\tthis value is specified, it will override the existing placement strategy defined for\n\t\t\tthe service. To remove an existing placement strategy, specify an empty object.

\n

You can specify a maximum of five strategy rules for each service.

\n

This parameter doesn't trigger a new service deployment.

" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The platform version that your tasks in the service run on. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If a platform version\n\t\t\tis not specified, the LATEST platform version is used. For more\n\t\t\tinformation, see Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The platform version that your tasks in the service run on. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If a platform version\n\t\t\tis not specified, the LATEST platform version is used. For more\n\t\t\tinformation, see Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.

\n

This parameter triggers a new service deployment.

" } }, "forceNewDeployment": { @@ -15796,7 +16853,7 @@ "healthCheckGracePeriodSeconds": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't\n\t\t\tspecify a health check grace period value, the default value of 0 is used.\n\t\t\tIf you don't use any of the health checks, then\n\t\t\t\thealthCheckGracePeriodSeconds is unused.

\n

If your service's tasks take a while to start and respond to health checks, you can\n\t\t\tspecify a health check grace period of up to 2,147,483,647 seconds (about 69 years).\n\t\t\tDuring that time, the Amazon ECS service scheduler ignores health check status. This grace\n\t\t\tperiod can prevent the service scheduler from marking tasks as unhealthy and stopping\n\t\t\tthem before they have time to come up.

" + "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't\n\t\t\tspecify a health check grace period value, the default value of 0 is used.\n\t\t\tIf you don't use any of the health checks, then\n\t\t\t\thealthCheckGracePeriodSeconds is unused.

\n

If your service's tasks take a while to start and respond to health checks, you can\n\t\t\tspecify a health check grace period of up to 2,147,483,647 seconds (about 69 years).\n\t\t\tDuring that time, the Amazon ECS service scheduler ignores health check status. This grace\n\t\t\tperiod can prevent the service scheduler from marking tasks as unhealthy and stopping\n\t\t\tthem before they have time to come up.

\n

If your service has more running tasks than desired, unhealthy tasks in the grace period might be stopped to reach the desired count.

\n

This parameter doesn't trigger a new service deployment.

" } }, "deploymentController": { @@ -15805,49 +16862,49 @@ "enableExecuteCommand": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If true, this enables execute command functionality on all task\n\t\t\tcontainers.

\n

If you do not want to override the value that was set when the service was created,\n\t\t\tyou can set this to null when performing this action.

" + "smithy.api#documentation": "

If true, this enables execute command functionality on all task\n\t\t\tcontainers.

\n

If you do not want to override the value that was set when the service was created,\n\t\t\tyou can set this to null when performing this action.

\n

This parameter doesn't trigger a new service deployment.

" } }, "enableECSManagedTags": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For\n\t\t\tmore information, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

\n

Only tasks launched after the update will reflect the update. To update the tags on\n\t\t\tall tasks, set forceNewDeployment to true, so that Amazon ECS\n\t\t\tstarts new tasks with the updated tags.

" + "smithy.api#documentation": "

Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For\n\t\t\tmore information, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

\n

Only tasks launched after the update will reflect the update. To update the tags on\n\t\t\tall tasks, set forceNewDeployment to true, so that Amazon ECS\n\t\t\tstarts new tasks with the updated tags.

\n

This parameter doesn't trigger a new service deployment.

" } }, "loadBalancers": { "target": "com.amazonaws.ecs#LoadBalancers", "traits": { - "smithy.api#documentation": "\n

You must have a service-linked role when you update this property

\n
\n

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the\n\t\t\tcontainer name, and the container port to access from the load balancer. The container\n\t\t\tname is as it appears in a container definition.

\n

When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks\n\t\t\twith the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks\n\t\t\tare running.

\n

For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target\n\t\t\tgroups. You can update from a single target group to multiple target groups and from\n\t\t\tmultiple target groups to a single target group.

\n

For services that use blue/green deployments, you can update Elastic Load Balancing target groups by\n\t\t\tusing \n CreateDeployment\n through CodeDeploy. Note that multiple target groups\n\t\t\tare not supported for blue/green deployments. For more information see Register\n\t\t\t\tmultiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

\n

For services that use the external deployment controller, you can add, update, or\n\t\t\tremove load balancers by using CreateTaskSet.\n\t\t\tNote that multiple target groups are not supported for external deployments. For more\n\t\t\tinformation see Register\n\t\t\t\tmultiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

\n

You can remove existing loadBalancers by passing an empty list.

" + "smithy.api#documentation": "\n

You must have a service-linked role when you update this property

\n
\n

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the\n\t\t\tcontainer name, and the container port to access from the load balancer. The container\n\t\t\tname is as it appears in a container definition.

\n

When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks\n\t\t\twith the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks\n\t\t\tare running.

\n

For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target\n\t\t\tgroups. You can update from a single target group to multiple target groups and from\n\t\t\tmultiple target groups to a single target group.

\n

For services that use blue/green deployments, you can update Elastic Load Balancing target groups by\n\t\t\tusing \n CreateDeployment\n through CodeDeploy. Note that multiple target groups\n\t\t\tare not supported for blue/green deployments. For more information see Register\n\t\t\t\tmultiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

\n

For services that use the external deployment controller, you can add, update, or\n\t\t\tremove load balancers by using CreateTaskSet.\n\t\t\tNote that multiple target groups are not supported for external deployments. For more\n\t\t\tinformation see Register\n\t\t\t\tmultiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

\n

You can remove existing loadBalancers by passing an empty list.

\n

This parameter triggers a new service deployment.

" } }, "propagateTags": { "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "

Determines whether to propagate the tags from the task definition or the service to\n\t\t\tthe task. If no value is specified, the tags aren't propagated.

\n

Only tasks launched after the update will reflect the update. To update the tags on\n\t\t\tall tasks, set forceNewDeployment to true, so that Amazon ECS\n\t\t\tstarts new tasks with the updated tags.

" + "smithy.api#documentation": "

Determines whether to propagate the tags from the task definition or the service to\n\t\t\tthe task. If no value is specified, the tags aren't propagated.

\n

Only tasks launched after the update will reflect the update. To update the tags on\n\t\t\tall tasks, set forceNewDeployment to true, so that Amazon ECS\n\t\t\tstarts new tasks with the updated tags.

\n

This parameter doesn't trigger a new service deployment.

" } }, "serviceRegistries": { "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { - "smithy.api#documentation": "\n

You must have a service-linked role when you update this property.

\n

For more information about the role see the CreateService request\n\t\t\t\tparameter \n role\n .

\n
\n

The details for the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.

\n

When you add, update, or remove the service registries configuration, Amazon ECS starts new\n\t\t\ttasks with the updated service registries configuration, and then stops the old tasks\n\t\t\twhen the new tasks are running.

\n

You can remove existing serviceRegistries by passing an empty\n\t\t\tlist.

" + "smithy.api#documentation": "\n

You must have a service-linked role when you update this property.

\n

For more information about the role see the CreateService request\n\t\t\t\tparameter \n role\n .

\n
\n

The details for the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.

\n

When you add, update, or remove the service registries configuration, Amazon ECS starts new\n\t\t\ttasks with the updated service registries configuration, and then stops the old tasks\n\t\t\twhen the new tasks are running.

\n

You can remove existing serviceRegistries by passing an empty\n\t\t\tlist.

\n

This parameter triggers a new service deployment.

" } }, "serviceConnectConfiguration": { "target": "com.amazonaws.ecs#ServiceConnectConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

\n

This parameter triggers a new service deployment.

" } }, "volumeConfigurations": { "target": "com.amazonaws.ecs#ServiceVolumeConfigurations", "traits": { - "smithy.api#documentation": "

The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tthe size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume\n\t\t\tmust match the name from the task definition. If set to null, no new\n\t\t\tdeployment is triggered. Otherwise, if this configuration differs from the existing one,\n\t\t\tit triggers a new deployment.

" + "smithy.api#documentation": "

The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tthe size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume\n\t\t\tmust match the name from the task definition. If set to null, no new\n\t\t\tdeployment is triggered. Otherwise, if this configuration differs from the existing one,\n\t\t\tit triggers a new deployment.

\n

This parameter triggers a new service deployment.

" } }, "vpcLatticeConfigurations": { "target": "com.amazonaws.ecs#VpcLatticeConfigurations", "traits": { - "smithy.api#documentation": "

An object representing the VPC Lattice configuration for the service being\n\t\t\tupdated.

" + "smithy.api#documentation": "

An object representing the VPC Lattice configuration for the service being\n\t\t\tupdated.

\n

This parameter triggers a new service deployment.

" } } }, @@ -16164,6 +17221,27 @@ "smithy.api#output": {} } }, + "com.amazonaws.ecs#VCpuCountRangeRequest": { + "type": "structure", + "members": { + "min": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The minimum number of vCPUs. Instance types with fewer vCPUs than this value are excluded from selection.

", + "smithy.api#required": {} + } + }, + "max": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of vCPUs. Instance types with more vCPUs than this value are excluded from selection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of vCPUs for instance type selection. This allows you to specify a range of vCPU counts that meet your workload requirements.

" + } + }, "com.amazonaws.ecs#VersionConsistency": { "type": "enum", "members": { diff --git a/codegen/sdk/aws-models/efs.json b/codegen/sdk/aws-models/efs.json index 1cdec4a0301..aaa7eb096f6 100644 --- a/codegen/sdk/aws-models/efs.json +++ b/codegen/sdk/aws-models/efs.json @@ -3684,17 +3684,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3708,17 +3697,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3732,17 +3710,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3756,17 +3723,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3780,17 +3736,6 @@ "UseDualStack": false } }, - { - "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": { @@ -3804,17 +3749,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3829,49 +3763,53 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://elasticfilesystem-fips.us-isof-south-1.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://elasticfilesystem-fips.us-isof-south-1.csp.hci.ic.gov" + "url": "https://elasticfilesystem.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://elasticfilesystem-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://elasticfilesystem.us-isof-south-1.csp.hci.ic.gov" + "url": "https://elasticfilesystem.eusc-de-east-1.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } diff --git a/codegen/sdk/aws-models/eks.json b/codegen/sdk/aws-models/eks.json index 590f2e90497..7a2bd91984e 100644 --- a/codegen/sdk/aws-models/eks.json +++ b/codegen/sdk/aws-models/eks.json @@ -236,6 +236,9 @@ { "target": "com.amazonaws.eks#DescribeInsight" }, + { + "target": "com.amazonaws.eks#DescribeInsightsRefresh" + }, { "target": "com.amazonaws.eks#DescribeNodegroup" }, @@ -293,6 +296,9 @@ { "target": "com.amazonaws.eks#RegisterCluster" }, + { + "target": "com.amazonaws.eks#StartInsightsRefresh" + }, { "target": "com.amazonaws.eks#TagResource" }, @@ -1224,17 +1230,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1248,17 +1243,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1272,17 +1256,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1296,17 +1269,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -1631,6 +1593,12 @@ "traits": { "smithy.api#documentation": "

An array of EKS Pod Identity associations owned by the add-on. Each association maps a role to a service\n account in a namespace in the cluster.

\n

For more information, see Attach an IAM Role to an Amazon EKS add-on\n using EKS Pod Identity in the Amazon EKS User Guide.

" } + }, + "namespaceConfig": { + "target": "com.amazonaws.eks#AddonNamespaceConfigResponse", + "traits": { + "smithy.api#documentation": "

The namespace configuration for the addon. This specifies the Kubernetes namespace where the addon is installed.

" + } } }, "traits": { @@ -1715,6 +1683,12 @@ "traits": { "smithy.api#documentation": "

Information about the add-on from the Amazon Web Services Marketplace.

" } + }, + "defaultNamespace": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The default Kubernetes namespace where this addon is typically installed if no custom namespace is specified.

" + } } }, "traits": { @@ -1818,6 +1792,34 @@ "target": "com.amazonaws.eks#AddonIssue" } }, + "com.amazonaws.eks#AddonNamespaceConfigRequest": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.eks#namespace", + "traits": { + "smithy.api#documentation": "

The name of the Kubernetes namespace to install the addon in. Must be a valid RFC 1123 DNS label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The namespace configuration request object for specifying a custom namespace when creating an addon.

" + } + }, + "com.amazonaws.eks#AddonNamespaceConfigResponse": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.eks#namespace", + "traits": { + "smithy.api#documentation": "

The name of the Kubernetes namespace where the addon is installed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The namespace configuration response object containing information about the namespace where an addon is installed.

" + } + }, "com.amazonaws.eks#AddonPodIdentityAssociations": { "type": "structure", "members": { @@ -3451,6 +3453,12 @@ "traits": { "smithy.api#documentation": "

An array of EKS Pod Identity associations to be created. Each association maps a Kubernetes service account to\n an IAM role.

\n

For more information, see Attach an IAM Role to an Amazon EKS add-on\n using EKS Pod Identity in the Amazon EKS User Guide.

" } + }, + "namespaceConfig": { + "target": "com.amazonaws.eks#AddonNamespaceConfigRequest", + "traits": { + "smithy.api#documentation": "

The namespace configuration for the addon. If specified, this will override the default namespace for the addon.

" + } } }, "traits": { @@ -5781,6 +5789,85 @@ "smithy.api#output": {} } }, + "com.amazonaws.eks#DescribeInsightsRefresh": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeInsightsRefreshRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeInsightsRefreshResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the status of the latest on-demand cluster insights refresh operation.

", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/insights-refresh", + "code": 200 + } + } + }, + "com.amazonaws.eks#DescribeInsightsRefreshRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster associated with the insights refresh operation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeInsightsRefreshResponse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The message associated with the insights refresh operation.

" + } + }, + "status": { + "target": "com.amazonaws.eks#InsightsRefreshStatus", + "traits": { + "smithy.api#documentation": "

The current status of the insights refresh operation.

" + } + }, + "startedAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the insights refresh operation started.

" + } + }, + "endedAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the insights refresh operation ended.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.eks#DescribeNodegroup": { "type": "operation", "input": { @@ -7140,6 +7227,29 @@ "smithy.api#documentation": "

The criteria to use for the insights.

" } }, + "com.amazonaws.eks#InsightsRefreshStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + } + } + }, "com.amazonaws.eks#Integer": { "type": "integer", "traits": { @@ -8789,12 +8899,80 @@ "traits": { "smithy.api#documentation": "

Specifies whether to enable node auto repair for the node group. Node auto repair is\n disabled by default.

" } + }, + "maxUnhealthyNodeThresholdCount": { + "target": "com.amazonaws.eks#NonZeroInteger", + "traits": { + "smithy.api#documentation": "

Specify a count threshold of unhealthy nodes, above which node auto \n repair actions will stop. When using this, you cannot also set \n maxUnhealthyNodeThresholdPercentage at the same time.

" + } + }, + "maxUnhealthyNodeThresholdPercentage": { + "target": "com.amazonaws.eks#PercentCapacity", + "traits": { + "smithy.api#documentation": "

Specify a percentage threshold of unhealthy nodes, above which node auto \n repair actions will stop. When using this, you cannot also set \n maxUnhealthyNodeThresholdCount at the same time.

" + } + }, + "maxParallelNodesRepairedCount": { + "target": "com.amazonaws.eks#NonZeroInteger", + "traits": { + "smithy.api#documentation": "

Specify the maximum number of nodes that can be repaired concurrently or in parallel, \n expressed as a count of unhealthy nodes. This gives you finer-grained control over the \n pace of node replacements. When using this, you cannot also set \n maxParallelNodesRepairedPercentage at the same time.

" + } + }, + "maxParallelNodesRepairedPercentage": { + "target": "com.amazonaws.eks#PercentCapacity", + "traits": { + "smithy.api#documentation": "

Specify the maximum number of nodes that can be repaired concurrently or in parallel, \n expressed as a percentage of unhealthy nodes. This gives you finer-grained control over the \n pace of node replacements. When using this, you cannot also set \n maxParallelNodesRepairedCount at the same time.

" + } + }, + "nodeRepairConfigOverrides": { + "target": "com.amazonaws.eks#NodeRepairConfigOverridesList", + "traits": { + "smithy.api#documentation": "

Specify granular overrides for specific repair actions. These overrides control the \n repair action and the repair delay time before a node is considered eligible for repair.\n If you use this, you must specify all the values.

" + } } }, "traits": { "smithy.api#documentation": "

The node auto repair configuration for the node group.

" } }, + "com.amazonaws.eks#NodeRepairConfigOverrides": { + "type": "structure", + "members": { + "nodeMonitoringCondition": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

Specify an unhealthy condition reported by the node monitoring agent that this\n override would apply to.

" + } + }, + "nodeUnhealthyReason": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

Specify a reason reported by the node monitoring agent that this\n override would apply to.

" + } + }, + "minRepairWaitTimeMins": { + "target": "com.amazonaws.eks#NonZeroInteger", + "traits": { + "smithy.api#documentation": "

Specify the minimum time in minutes to wait before attempting to repair a node \n with this specific nodeMonitoringCondition and\n nodeUnhealthyReason.

" + } + }, + "repairAction": { + "target": "com.amazonaws.eks#RepairAction", + "traits": { + "smithy.api#documentation": "

Specify the repair action to take for nodes when all of the specified conditions are\n met.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specify granular overrides for specific repair actions. These overrides control the \n repair action and the repair delay time before a node is considered eligible for repair.\n If you use this, you must specify all the values.

" + } + }, + "com.amazonaws.eks#NodeRepairConfigOverridesList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#NodeRepairConfigOverrides" + } + }, "com.amazonaws.eks#Nodegroup": { "type": "structure", "members": { @@ -9911,6 +10089,29 @@ } } }, + "com.amazonaws.eks#RepairAction": { + "type": "enum", + "members": { + "Replace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Replace" + } + }, + "Reboot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Reboot" + } + }, + "NoAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NoAction" + } + } + } + }, "com.amazonaws.eks#ResolveConflicts": { "type": "enum", "members": { @@ -10129,6 +10330,73 @@ "smithy.api#httpError": 503 } }, + "com.amazonaws.eks#StartInsightsRefresh": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#StartInsightsRefreshRequest" + }, + "output": { + "target": "com.amazonaws.eks#StartInsightsRefreshResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Initiates an on-demand refresh operation for cluster insights, getting the latest analysis outside of the standard refresh schedule.

", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/insights-refresh", + "code": 200 + } + } + }, + "com.amazonaws.eks#StartInsightsRefreshRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster for the refresh insights operation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#StartInsightsRefreshResponse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The message associated with the insights refresh operation.

" + } + }, + "status": { + "target": "com.amazonaws.eks#InsightsRefreshStatus", + "traits": { + "smithy.api#documentation": "

The current status of the insights refresh operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.eks#StorageConfigRequest": { "type": "structure", "members": { @@ -11477,6 +11745,12 @@ "traits": { "smithy.api#enumValue": "DeletionProtection" } + }, + "NODE_REPAIR_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NodeRepairConfig" + } } } }, @@ -11957,6 +12231,15 @@ "target": "com.amazonaws.eks#labelValue" } }, + "com.amazonaws.eks#namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, "com.amazonaws.eks#requiredClaimsKey": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/elastic-beanstalk.json b/codegen/sdk/aws-models/elastic-beanstalk.json index 2d84b27963e..a9819095ce1 100644 --- a/codegen/sdk/aws-models/elastic-beanstalk.json +++ b/codegen/sdk/aws-models/elastic-beanstalk.json @@ -1044,17 +1044,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1068,17 +1057,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1092,17 +1070,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1116,17 +1083,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/elastic-load-balancing-v2.json b/codegen/sdk/aws-models/elastic-load-balancing-v2.json index 0f590ee0bb3..fc678096f53 100644 --- a/codegen/sdk/aws-models/elastic-load-balancing-v2.json +++ b/codegen/sdk/aws-models/elastic-load-balancing-v2.json @@ -5124,17 +5124,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5148,17 +5137,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5172,17 +5150,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5196,17 +5163,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/elastic-load-balancing.json b/codegen/sdk/aws-models/elastic-load-balancing.json index 6f2556ab02a..99a8419b6b3 100644 --- a/codegen/sdk/aws-models/elastic-load-balancing.json +++ b/codegen/sdk/aws-models/elastic-load-balancing.json @@ -3426,17 +3426,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3450,17 +3439,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3474,17 +3452,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3498,17 +3465,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/elastic-transcoder.json b/codegen/sdk/aws-models/elastic-transcoder.json index 9efdaacd6b7..585c9ec0965 100644 --- a/codegen/sdk/aws-models/elastic-transcoder.json +++ b/codegen/sdk/aws-models/elastic-transcoder.json @@ -1839,17 +1839,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1863,17 +1852,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1887,17 +1865,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1911,17 +1878,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/elasticache.json b/codegen/sdk/aws-models/elasticache.json index b785a380e3e..9743caf4c4f 100644 --- a/codegen/sdk/aws-models/elasticache.json +++ b/codegen/sdk/aws-models/elasticache.json @@ -1339,17 +1339,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1363,17 +1352,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1387,17 +1365,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1411,17 +1378,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/elasticsearch-service.json b/codegen/sdk/aws-models/elasticsearch-service.json index cccb5274d85..ea63903b946 100644 --- a/codegen/sdk/aws-models/elasticsearch-service.json +++ b/codegen/sdk/aws-models/elasticsearch-service.json @@ -1451,17 +1451,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1475,17 +1464,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1499,17 +1477,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1523,17 +1490,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/emr-containers.json b/codegen/sdk/aws-models/emr-containers.json index 641c0e223e1..973c14f7f5e 100644 --- a/codegen/sdk/aws-models/emr-containers.json +++ b/codegen/sdk/aws-models/emr-containers.json @@ -960,17 +960,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -984,17 +973,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1008,17 +986,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1032,17 +999,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1684,6 +1640,12 @@ "smithy.api#required": {} } }, + "containerProvider": { + "target": "com.amazonaws.emrcontainers#ContainerProvider", + "traits": { + "smithy.api#documentation": "

The container provider associated with the security configuration.

" + } + }, "securityConfigurationData": { "target": "com.amazonaws.emrcontainers#SecurityConfigurationData", "traits": { @@ -2363,6 +2325,12 @@ "traits": { "smithy.api#documentation": "

The namespaces of the Amazon EKS cluster.

" } + }, + "nodeLabel": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The nodeLabel of the nodes where the resources of this virtual cluster can get scheduled. It requires relevant scaling and policy engine addons.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/emr-serverless.json b/codegen/sdk/aws-models/emr-serverless.json index 57150277ae0..599f972b373 100644 --- a/codegen/sdk/aws-models/emr-serverless.json +++ b/codegen/sdk/aws-models/emr-serverless.json @@ -999,17 +999,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1023,17 +1012,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1047,17 +1025,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1071,17 +1038,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/emr.json b/codegen/sdk/aws-models/emr.json index afb6b9ff04b..3a97db8ab2f 100644 --- a/codegen/sdk/aws-models/emr.json +++ b/codegen/sdk/aws-models/emr.json @@ -3910,17 +3910,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3934,17 +3923,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3958,17 +3936,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3982,17 +3949,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/entityresolution.json b/codegen/sdk/aws-models/entityresolution.json index b5756dcf645..3c22231bed7 100644 --- a/codegen/sdk/aws-models/entityresolution.json +++ b/codegen/sdk/aws-models/entityresolution.json @@ -656,17 +656,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -680,17 +669,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -704,17 +682,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -728,17 +695,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1086,7 +1042,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

", + "smithy.api#documentation": "

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1120,7 +1076,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.

Incremental processing is not supported for ID mapping workflows.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1164,6 +1120,12 @@ "smithy.api#required": {} } }, + "incrementalRunConfig": { + "target": "com.amazonaws.entityresolution#IdMappingIncrementalRunConfig", + "traits": { + "smithy.api#documentation": "

The incremental run configuration for the ID mapping workflow.

" + } + }, "roleArn": { "target": "com.amazonaws.entityresolution#IdMappingRoleArn", "traits": { @@ -1226,6 +1188,12 @@ "smithy.api#required": {} } }, + "incrementalRunConfig": { + "target": "com.amazonaws.entityresolution#IdMappingIncrementalRunConfig", + "traits": { + "smithy.api#documentation": "

The incremental run configuration for the ID mapping workflow.

" + } + }, "roleArn": { "target": "com.amazonaws.entityresolution#IdMappingRoleArn", "traits": { @@ -1430,7 +1398,7 @@ } ], "traits": { - "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#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 or PROVIDER, incremental processing is not supported.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1478,7 +1446,7 @@ "incrementalRunConfig": { "target": "com.amazonaws.entityresolution#IncrementalRunConfig", "traits": { - "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.

" + "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 or PROVIDER, incremental processing is not supported.

" } }, "roleArn": { @@ -2025,20 +1993,20 @@ "uniqueId": { "target": "com.amazonaws.entityresolution#HeaderSafeUniqueId", "traits": { - "smithy.api#documentation": "

The unique ID that could not be deleted.

", + "smithy.api#documentation": "

The unique ID that couldn't be deleted.

", "smithy.api#required": {} } }, "errorType": { "target": "com.amazonaws.entityresolution#DeleteUniqueIdErrorType", "traits": { - "smithy.api#documentation": "

The error type for the batch delete unique ID operation.

", + "smithy.api#documentation": "

The error type for the delete unique ID operation.

The SERVICE_ERROR value indicates that an internal service-side problem occurred during the deletion operation.

The VALIDATION_ERROR value indicates that the deletion operation couldn't complete because of invalid input parameters or data.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The Delete Unique Id error.

" + "smithy.api#documentation": "

The error information provided when the delete unique ID operation doesn't complete.

" } }, "com.amazonaws.entityresolution#DeleteUniqueIdErrorType": { @@ -2190,10 +2158,9 @@ "type": "structure", "members": { "inputSourceARN": { - "target": "smithy.api#String", + "target": "com.amazonaws.entityresolution#InputSourceARN", "traits": { "smithy.api#documentation": "

The input source ARN of the record that didn't generate a Match ID.

", - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$", "smithy.api#required": {} } }, @@ -2414,6 +2381,12 @@ "traits": { "smithy.api#documentation": "

A list of OutputSource objects.

" } + }, + "jobType": { + "target": "com.amazonaws.entityresolution#JobType", + "traits": { + "smithy.api#documentation": "

The job type of the ID mapping job.

A value of INCREMENTAL indicates that only new or changed data was processed since the last job run. This is the default job type if the workflow was created with an incrementalRunConfig.

A value of BATCH indicates that all data was processed from the input source, regardless of previous job runs. This is the default job type if the workflow wasn't created with an incrementalRunConfig.

A value of DELETE_ONLY indicates that only deletion requests from BatchDeleteUniqueIds were processed.

" + } } }, "traits": { @@ -2528,6 +2501,12 @@ "smithy.api#required": {} } }, + "incrementalRunConfig": { + "target": "com.amazonaws.entityresolution#IdMappingIncrementalRunConfig", + "traits": { + "smithy.api#documentation": "

The incremental run configuration for the ID mapping workflow.

" + } + }, "roleArn": { "target": "com.amazonaws.entityresolution#IdMappingRoleArn", "traits": { @@ -2697,7 +2676,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the corresponding Match ID of a customer record if the record has been processed in a rule-based matching workflow or ML matching workflow.

You can call this API as a dry run of an incremental load on the rule-based matching workflow.

", + "smithy.api#documentation": "

Returns the corresponding Match ID of a customer record if the record has been processed in a rule-based matching workflow.

You can call this API as a dry run of an incremental load on the rule-based matching workflow.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -3356,6 +3335,31 @@ "smithy.api#pattern": "^[a-zA-Z_0-9-+=/,]*$" } }, + "com.amazonaws.entityresolution#IdMappingIncrementalRunConfig": { + "type": "structure", + "members": { + "incrementalRunType": { + "target": "com.amazonaws.entityresolution#IdMappingIncrementalRunType", + "traits": { + "smithy.api#documentation": "

The incremental run type for an ID mapping workflow.

It takes only one value: ON_DEMAND. This setting runs the ID mapping workflow when it's manually triggered through the StartIdMappingJob API.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Incremental run configuration for an ID mapping workflow.

" + } + }, + "com.amazonaws.entityresolution#IdMappingIncrementalRunType": { + "type": "enum", + "members": { + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } + } + } + }, "com.amazonaws.entityresolution#IdMappingJobMetrics": { "type": "structure", "members": { @@ -3377,6 +3381,12 @@ "smithy.api#documentation": "

The total number of records that did not get processed.

" } }, + "deleteRecordsProcessed": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of records processed that were marked for deletion in the input file using the DELETE schema mapping field. These are the records to be removed from the ID mapping table.

" + } + }, "totalMappedRecords": { "target": "smithy.api#Integer", "traits": { @@ -3398,7 +3408,49 @@ "uniqueRecordsLoaded": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of records remaining after loading and aggregating duplicate records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping - records sharing the same value in this field are considered duplicates. For example, if you specified \"customer_id\" as a UNIQUE_ID field and had three records with the same customer_id value, they would count as one unique record in this metric.

" + "smithy.api#documentation": "

The number of de-duplicated processed records across all runs, excluding deletion-related records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping. Records sharing the same value in this field are considered duplicates. For example, if you specified \"customer_id\" as a UNIQUE_ID field and had three records with the same customer_id value, they would count as one unique record in this metric.

" + } + }, + "newMappedRecords": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of new mapped records.

" + } + }, + "newMappedSourceRecords": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of new source records mapped.

" + } + }, + "newMappedTargetRecords": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of new mapped target records.

" + } + }, + "newUniqueRecordsLoaded": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of new unique records processed in the current job run, after removing duplicates. This metric excludes deletion-related records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping. Records sharing the same value in this field are considered duplicates. For example, if your current run processes five new records with the same UNIQUE_ID value, they would count as one new unique record in this metric.

" + } + }, + "mappedRecordsRemoved": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of mapped records removed.

" + } + }, + "mappedSourceRecordsRemoved": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of source records removed due to ID mapping.

" + } + }, + "mappedTargetRecordsRemoved": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of mapped target records removed.

" } } }, @@ -3549,10 +3601,9 @@ "type": "structure", "members": { "inputSourceARN": { - "target": "smithy.api#String", + "target": "com.amazonaws.entityresolution#InputSourceARN", "traits": { "smithy.api#documentation": "

An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.

", - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$", "smithy.api#required": {} } }, @@ -3759,10 +3810,9 @@ "type": "structure", "members": { "inputSourceARN": { - "target": "smithy.api#String", + "target": "com.amazonaws.entityresolution#InputSourceARN", "traits": { "smithy.api#documentation": "

An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.

", - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$", "smithy.api#required": {} } }, @@ -3873,12 +3923,12 @@ "incrementalRunType": { "target": "com.amazonaws.entityresolution#IncrementalRunType", "traits": { - "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.

" + "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 or PROVIDER, incremental processing is not supported.

" } } }, "traits": { - "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.

" + "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 or PROVIDER, incremental processing is not supported.

" } }, "com.amazonaws.entityresolution#IncrementalRunType": { @@ -3896,10 +3946,9 @@ "type": "structure", "members": { "inputSourceARN": { - "target": "smithy.api#String", + "target": "com.amazonaws.entityresolution#InputSourceARN", "traits": { "smithy.api#documentation": "

An Glue table Amazon Resource Name (ARN) for the input source table.

", - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$", "smithy.api#required": {} } }, @@ -3921,6 +3970,12 @@ "smithy.api#documentation": "

An object containing inputSourceARN, schemaName, and applyNormalization.

" } }, + "com.amazonaws.entityresolution#InputSourceARN": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$" + } + }, "com.amazonaws.entityresolution#InputSourceConfig": { "type": "list", "member": { @@ -3995,6 +4050,12 @@ "smithy.api#documentation": "

The total number of records that did not get processed.

" } }, + "deleteRecordsProcessed": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of records processed that were marked for deletion (DELETE = True) in the input file. This metric tracks records flagged for removal during the job execution.

" + } + }, "matchIDs": { "target": "smithy.api#Integer", "traits": { @@ -4110,6 +4171,29 @@ "smithy.api#documentation": "

An object containing the jobId, status, startTime, and endTime of a job.

" } }, + "com.amazonaws.entityresolution#JobType": { + "type": "enum", + "members": { + "BATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BATCH" + } + }, + "INCREMENTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREMENTAL" + } + }, + "DELETE_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_ONLY" + } + } + } + }, "com.amazonaws.entityresolution#KMSArn": { "type": "string", "traits": { @@ -4844,10 +4928,9 @@ "type": "structure", "members": { "inputSourceARN": { - "target": "smithy.api#String", + "target": "com.amazonaws.entityresolution#InputSourceARN", "traits": { "smithy.api#documentation": "

The input source ARN of the matched record.

", - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$", "smithy.api#required": {} } }, @@ -5464,10 +5547,9 @@ "type": "structure", "members": { "inputSourceARN": { - "target": "smithy.api#String", + "target": "com.amazonaws.entityresolution#InputSourceARN", "traits": { "smithy.api#documentation": "

The input source ARN of the record.

", - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})$", "smithy.api#required": {} } }, @@ -5577,7 +5659,7 @@ "resolutionType": { "target": "com.amazonaws.entityresolution#ResolutionType", "traits": { - "smithy.api#documentation": "

The type of matching. There are three types of matching: RULE_MATCHING, ML_MATCHING, and PROVIDER.

", + "smithy.api#documentation": "

The type of matching workflow to create. Specify one of the following types:

  • RULE_MATCHING: Match records using configurable rule-based criteria

  • ML_MATCHING: Match records using machine learning models

  • PROVIDER: Match records using a third-party matching provider

", "smithy.api#required": {} } }, @@ -5635,7 +5717,7 @@ } }, "traits": { - "smithy.api#documentation": "

The resource could not be found.

", + "smithy.api#documentation": "

The resource couldn't be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -6122,6 +6204,12 @@ "traits": { "smithy.api#documentation": "

A list of OutputSource objects.

" } + }, + "jobType": { + "target": "com.amazonaws.entityresolution#JobType", + "traits": { + "smithy.api#documentation": "

The job type for the ID mapping job.

If the jobType value is set to INCREMENTAL, only new or changed data is processed since the last job run. This is the default value if the CreateIdMappingWorkflow API is configured with an incrementalRunConfig.

If the jobType value is set to BATCH, all data is processed from the input source, regardless of previous job runs. This is the default value if the CreateIdMappingWorkflow API isn't configured with an incrementalRunConfig.

If the jobType value is set to DELETE_ONLY, only deletion requests from BatchDeleteUniqueIds are processed.

" + } } }, "traits": { @@ -6143,6 +6231,12 @@ "traits": { "smithy.api#documentation": "

A list of OutputSource objects.

" } + }, + "jobType": { + "target": "com.amazonaws.entityresolution#JobType", + "traits": { + "smithy.api#documentation": "

The job type for the started ID mapping job.

A value of INCREMENTAL indicates that only new or changed data was processed since the last job run. This is the default job type if the workflow was created with an incrementalRunConfig.

A value of BATCH indicates that all data was processed from the input source, regardless of previous job runs. This is the default job type if the workflow wasn't created with an incrementalRunConfig.

A value of DELETE_ONLY indicates that only deletion requests from BatchDeleteUniqueIds were processed.

" + } } }, "traits": { @@ -6514,7 +6608,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.

Incremental processing is not supported for ID mapping workflows.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -6560,6 +6654,12 @@ "smithy.api#required": {} } }, + "incrementalRunConfig": { + "target": "com.amazonaws.entityresolution#IdMappingIncrementalRunConfig", + "traits": { + "smithy.api#documentation": "

The incremental run configuration for the update ID mapping workflow.

" + } + }, "roleArn": { "target": "com.amazonaws.entityresolution#IdMappingRoleArn", "traits": { @@ -6616,6 +6716,12 @@ "smithy.api#required": {} } }, + "incrementalRunConfig": { + "target": "com.amazonaws.entityresolution#IdMappingIncrementalRunConfig", + "traits": { + "smithy.api#documentation": "

The incremental run configuration for the update ID mapping workflow output.

" + } + }, "roleArn": { "target": "com.amazonaws.entityresolution#IdMappingRoleArn", "traits": { @@ -6797,7 +6903,7 @@ } ], "traits": { - "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#documentation": "

Updates an existing matching workflow. The workflow must already exist for this operation to succeed.

For workflows where resolutionType is ML_MATCHING or PROVIDER, incremental processing is not supported.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -6847,7 +6953,7 @@ "incrementalRunConfig": { "target": "com.amazonaws.entityresolution#IncrementalRunConfig", "traits": { - "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.

" + "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 or PROVIDER, incremental processing is not supported.

" } }, "roleArn": { diff --git a/codegen/sdk/aws-models/eventbridge.json b/codegen/sdk/aws-models/eventbridge.json index eaaad283c57..1432f4af891 100644 --- a/codegen/sdk/aws-models/eventbridge.json +++ b/codegen/sdk/aws-models/eventbridge.json @@ -1333,17 +1333,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1357,17 +1346,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1381,17 +1359,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1405,17 +1372,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/evidently.json b/codegen/sdk/aws-models/evidently.json index b40d5bcb755..1168325eaec 100644 --- a/codegen/sdk/aws-models/evidently.json +++ b/codegen/sdk/aws-models/evidently.json @@ -1918,17 +1918,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1942,17 +1931,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1966,17 +1944,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1990,17 +1957,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/evs.json b/codegen/sdk/aws-models/evs.json index 3c8b2df5174..b236ed9823f 100644 --- a/codegen/sdk/aws-models/evs.json +++ b/codegen/sdk/aws-models/evs.json @@ -1,6 +1,16 @@ { "smithy": "2.0", "shapes": { + "com.amazonaws.evs#AllocationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 9, + "max": 26 + }, + "smithy.api#pattern": "^eipalloc-[a-zA-Z0-9_-]+$" + } + }, "com.amazonaws.evs#AmazonElasticVMwareService": { "type": "service", "version": "2023-07-27", @@ -51,7 +61,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 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#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#title": "Amazon Elastic VMware Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -561,17 +571,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -585,17 +584,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -609,17 +597,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -633,17 +610,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -729,6 +695,91 @@ "smithy.api#pattern": "^arn:aws:evs:[a-z]{2}-[a-z]+-[0-9]:[0-9]{12}:environment/[a-zA-Z0-9_-]+$" } }, + "com.amazonaws.evs#AssociateEipToVlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.evs#AssociateEipToVlanRequest" + }, + "output": { + "target": "com.amazonaws.evs#AssociateEipToVlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evs#ThrottlingException" + }, + { + "target": "com.amazonaws.evs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.evs#AssociateEipToVlanRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.evs#ClientToken", + "traits": { + "smithy.api#documentation": "

This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "environmentId": { + "target": "com.amazonaws.evs#EnvironmentId", + "traits": { + "smithy.api#documentation": "

A unique ID for the environment containing the VLAN that the Elastic IP address associates with.

", + "smithy.api#required": {} + } + }, + "vlanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the VLAN. hcx is the only accepted VLAN name at this time.

", + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#required": {} + } + }, + "allocationId": { + "target": "com.amazonaws.evs#AllocationId", + "traits": { + "smithy.api#documentation": "

The Elastic IP address allocation ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.evs#AssociateEipToVlanResponse": { + "type": "structure", + "members": { + "vlan": { + "target": "com.amazonaws.evs#Vlan" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.evs#AssociationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 9, + "max": 26 + }, + "smithy.api#pattern": "^eipassoc-[a-zA-Z0-9_-]+$" + } + }, "com.amazonaws.evs#Check": { "type": "structure", "members": { @@ -752,7 +803,7 @@ } }, "traits": { - "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.

" + "smithy.api#documentation": "

A check on the environment to identify environment health and validate VMware VCF licensing compliance.

" } }, "com.amazonaws.evs#CheckResult": { @@ -841,7 +892,7 @@ } }, "traits": { - "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.

" + "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.

" } }, "com.amazonaws.evs#CreateEnvironment": { @@ -862,7 +913,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "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#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 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 +934,7 @@ } ], "traits": { - "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#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.

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": {} } }, @@ -1086,7 +1137,7 @@ } ], "traits": { - "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#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 and Amazon Web Services Secrets Manager secrets that Amazon EVS created. Amazon Web Services resources that you create are not deleted. These resources may continue to incur costs.

", "smithy.api#idempotent": {} } }, @@ -1107,7 +1158,7 @@ } ], "traits": { - "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#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#idempotent": {} } }, @@ -1197,6 +1248,113 @@ "smithy.api#output": {} } }, + "com.amazonaws.evs#DisassociateEipFromVlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.evs#DisassociateEipFromVlanRequest" + }, + "output": { + "target": "com.amazonaws.evs#DisassociateEipFromVlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.evs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.evs#ThrottlingException" + }, + { + "target": "com.amazonaws.evs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates an Elastic IP address from a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.evs#DisassociateEipFromVlanRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.evs#ClientToken", + "traits": { + "smithy.api#documentation": "

This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "environmentId": { + "target": "com.amazonaws.evs#EnvironmentId", + "traits": { + "smithy.api#documentation": "

A unique ID for the environment containing the VLAN that the Elastic IP address disassociates from.

", + "smithy.api#required": {} + } + }, + "vlanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the VLAN. hcx is the only accepted VLAN name at this time.

", + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.evs#AssociationId", + "traits": { + "smithy.api#documentation": "

A unique ID for the Elastic IP address association.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.evs#DisassociateEipFromVlanResponse": { + "type": "structure", + "members": { + "vlan": { + "target": "com.amazonaws.evs#Vlan" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.evs#EipAssociation": { + "type": "structure", + "members": { + "associationId": { + "target": "com.amazonaws.evs#AssociationId", + "traits": { + "smithy.api#documentation": "

A unique ID for the elastic IP address association with the VLAN subnet.

" + } + }, + "allocationId": { + "target": "com.amazonaws.evs#AllocationId", + "traits": { + "smithy.api#documentation": "

The Elastic IP address allocation ID.

" + } + }, + "ipAddress": { + "target": "com.amazonaws.evs#IpAddress", + "traits": { + "smithy.api#documentation": "

The Elastic IP address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Elastic IP address association with the elastic network interface in the VLAN subnet.

" + } + }, + "com.amazonaws.evs#EipAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.evs#EipAssociation" + } + }, "com.amazonaws.evs#Environment": { "type": "structure", "members": { @@ -1322,7 +1480,7 @@ } }, "traits": { - "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

An object that represents an Amazon EVS environment.

" + "smithy.api#documentation": "

An object that represents an Amazon EVS environment.

" } }, "com.amazonaws.evs#EnvironmentId": { @@ -1361,12 +1519,18 @@ "target": "com.amazonaws.evs#ListEnvironments" }, "operations": [ + { + "target": "com.amazonaws.evs#AssociateEipToVlan" + }, { "target": "com.amazonaws.evs#CreateEnvironmentHost" }, { "target": "com.amazonaws.evs#DeleteEnvironmentHost" }, + { + "target": "com.amazonaws.evs#DisassociateEipFromVlan" + }, { "target": "com.amazonaws.evs#ListEnvironmentHosts" }, @@ -1480,7 +1644,7 @@ } }, "traits": { - "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

A list of environments with summarized environment details.

" + "smithy.api#documentation": "

A list of environments with summarized environment details.

" } }, "com.amazonaws.evs#EnvironmentSummaryList": { @@ -1506,7 +1670,7 @@ } ], "traits": { - "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

Returns a description of the specified environment.

", + "smithy.api#documentation": "

Returns a description of the specified environment.

", "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { @@ -1634,7 +1798,7 @@ } }, "traits": { - "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.

" + "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.

" } }, "com.amazonaws.evs#HostInfoForCreate": { @@ -1675,7 +1839,7 @@ } }, "traits": { - "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.

" + "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.

" } }, "com.amazonaws.evs#HostInfoForCreateList": { @@ -1761,7 +1925,7 @@ } }, "traits": { - "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.

" + "smithy.api#documentation": "

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": { @@ -1819,7 +1983,7 @@ "hcx": { "target": "com.amazonaws.evs#InitialVlanInfo", "traits": { - "smithy.api#documentation": "

The HCX VLAN subnet. This VLAN subnet allows the HCX Interconnnect (IX) and HCX Network Extension (NE) to reach their peers and enable HCX Service Mesh creation.

", + "smithy.api#documentation": "

The HCX VLAN subnet. This VLAN subnet allows the HCX Interconnnect (IX) and HCX Network Extension (NE) to reach their peers and enable HCX Service Mesh creation.

If you plan to use a public HCX VLAN subnet, the following requirements must be met:

  • Must have a /28 netmask and be allocated from the IPAM public pool. Required for HCX internet access configuration.

  • The HCX public VLAN CIDR block must be added to the VPC as a secondary CIDR block.

  • Must have at least three Elastic IP addresses to be allocated from the public IPAM pool for HCX components.

", "smithy.api#required": {} } }, @@ -1836,10 +2000,23 @@ "smithy.api#documentation": "

An additional VLAN subnet that can be used to extend VCF capabilities once configured. For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations.

", "smithy.api#required": {} } + }, + "isHcxPublic": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Determines if the HCX VLAN that Amazon EVS provisions is public or private.

" + } + }, + "hcxNetworkAclId": { + "target": "com.amazonaws.evs#NetworkAclId", + "traits": { + "smithy.api#documentation": "

A unique ID for a network access control list that the HCX VLAN uses. Required when isHcxPublic is set to true.

" + } } }, "traits": { - "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.

" + "smithy.api#documentation": "

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": { @@ -1888,7 +2065,7 @@ } }, "traits": { - "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.

" + "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.

" } }, "com.amazonaws.evs#LicenseInfoList": { @@ -1920,7 +2097,7 @@ } ], "traits": { - "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

List the hosts within an environment.

", + "smithy.api#documentation": "

List the hosts within an environment.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2014,7 +2191,7 @@ } ], "traits": { - "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#documentation": "

Lists environment VLANs that are associated with the specified environment.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2105,7 +2282,7 @@ } ], "traits": { - "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#documentation": "

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 +2355,7 @@ } ], "traits": { - "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#documentation": "

Lists the tags for an Amazon EVS resource.

", "smithy.api#readonly": {} } }, @@ -2228,6 +2405,16 @@ } } }, + "com.amazonaws.evs#NetworkAclId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 21 + }, + "smithy.api#pattern": "^acl-[a-zA-Z0-9_-]+$" + } + }, "com.amazonaws.evs#NetworkInterface": { "type": "structure", "members": { @@ -2239,7 +2426,7 @@ } }, "traits": { - "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.

" + "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.

" } }, "com.amazonaws.evs#NetworkInterfaceId": { @@ -2362,7 +2549,7 @@ } }, "traits": { - "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.

" + "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.

" } }, "com.amazonaws.evs#SecretList": { @@ -2403,7 +2590,7 @@ } }, "traits": { - "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.

" + "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.

" } }, "com.amazonaws.evs#ServiceQuotaExceededException": { @@ -2509,7 +2696,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "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#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#idempotent": {} } }, @@ -2579,7 +2766,7 @@ } }, "traits": { - "smithy.api#documentation": "

The CreateEnvironmentHost operation couldn't be performed because the service is throttling requests. This exception is thrown when the CreateEnvironmentHost request exceeds concurrency of 1 transaction per second (TPS).

", + "smithy.api#documentation": "

The operation couldn't be performed because the service is throttling requests. This exception is thrown when there are too many requests accepted concurrently from the service endpoint.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": {} @@ -2623,7 +2810,7 @@ "aws:ResourceTag/${TagKey}", "aws:TagKeys" ], - "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#documentation": "

Deletes specified tags from an Amazon EVS resource.

", "smithy.api#idempotent": {} } }, @@ -2720,7 +2907,7 @@ } }, "traits": { - "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.

" + "smithy.api#documentation": "

Stores information about a field passed inside a request that resulted in an exception.

" } }, "com.amazonaws.evs#ValidationExceptionFieldList": { @@ -2826,7 +3013,7 @@ } }, "traits": { - "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.

" + "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.

" } }, "com.amazonaws.evs#VcfVersion": { @@ -2896,10 +3083,28 @@ "traits": { "smithy.api#documentation": "

The state details of the VLAN.

" } + }, + "eipAssociations": { + "target": "com.amazonaws.evs#EipAssociationList", + "traits": { + "smithy.api#documentation": "

An array of Elastic IP address associations.

" + } + }, + "isPublic": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Determines if the VLAN that Amazon EVS provisions is public or private.

" + } + }, + "networkAclId": { + "target": "com.amazonaws.evs#NetworkAclId", + "traits": { + "smithy.api#documentation": "

A unique ID for a network access control list.

" + } } }, "traits": { - "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

The VLANs that Amazon EVS creates during environment creation.

" + "smithy.api#documentation": "

The VLANs that Amazon EVS creates during environment creation.

" } }, "com.amazonaws.evs#VlanId": { diff --git a/codegen/sdk/aws-models/finspace-data.json b/codegen/sdk/aws-models/finspace-data.json index 2bc2fd0087f..822b4b5760b 100644 --- a/codegen/sdk/aws-models/finspace-data.json +++ b/codegen/sdk/aws-models/finspace-data.json @@ -666,17 +666,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -690,17 +679,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -714,17 +692,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -738,17 +705,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/finspace.json b/codegen/sdk/aws-models/finspace.json index 0d850b0733a..a9eab40ad05 100644 --- a/codegen/sdk/aws-models/finspace.json +++ b/codegen/sdk/aws-models/finspace.json @@ -722,17 +722,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -746,17 +735,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -770,17 +748,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -794,17 +761,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/firehose.json b/codegen/sdk/aws-models/firehose.json index 85b431ff8e1..0fb62c3d4f7 100644 --- a/codegen/sdk/aws-models/firehose.json +++ b/codegen/sdk/aws-models/firehose.json @@ -3986,17 +3986,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4010,28 +3999,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4045,17 +4012,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/fis.json b/codegen/sdk/aws-models/fis.json index ea5fa6a3627..41372da9856 100644 --- a/codegen/sdk/aws-models/fis.json +++ b/codegen/sdk/aws-models/fis.json @@ -3340,17 +3340,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3364,17 +3353,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3388,17 +3366,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3412,17 +3379,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/fms.json b/codegen/sdk/aws-models/fms.json index 7158767a1ff..784fefc4f77 100644 --- a/codegen/sdk/aws-models/fms.json +++ b/codegen/sdk/aws-models/fms.json @@ -1195,17 +1195,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1219,17 +1208,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1243,17 +1221,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1267,17 +1234,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/forecast.json b/codegen/sdk/aws-models/forecast.json index cd657ef6934..fcf6ba79e43 100644 --- a/codegen/sdk/aws-models/forecast.json +++ b/codegen/sdk/aws-models/forecast.json @@ -914,17 +914,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -938,17 +927,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -962,17 +940,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -986,17 +953,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/forecastquery.json b/codegen/sdk/aws-models/forecastquery.json index 570fb204d08..9f12ce31ab9 100644 --- a/codegen/sdk/aws-models/forecastquery.json +++ b/codegen/sdk/aws-models/forecastquery.json @@ -669,17 +669,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -693,17 +682,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -717,17 +695,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -741,17 +708,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/frauddetector.json b/codegen/sdk/aws-models/frauddetector.json index ecd26551d33..29693a187aa 100644 --- a/codegen/sdk/aws-models/frauddetector.json +++ b/codegen/sdk/aws-models/frauddetector.json @@ -879,17 +879,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -903,17 +892,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -927,17 +905,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -951,17 +918,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/fsx.json b/codegen/sdk/aws-models/fsx.json index 70418a0396e..e4437592e0d 100644 --- a/codegen/sdk/aws-models/fsx.json +++ b/codegen/sdk/aws-models/fsx.json @@ -1026,17 +1026,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1050,17 +1039,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1074,17 +1052,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1098,17 +1065,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1283,6 +1239,12 @@ "smithy.api#enumValue": "WRONG_VPC" } }, + "INVALID_NETWORK_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_NETWORK_TYPE" + } + }, "INVALID_DOMAIN_STAGE": { "target": "smithy.api#Unit", "traits": { @@ -1365,6 +1327,9 @@ "traits": { "smithy.api#documentation": "

The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're\n copying.

" } + }, + "Message": { + "target": "com.amazonaws.fsx#ErrorMessage" } }, "traits": { @@ -1607,7 +1572,7 @@ "target": "com.amazonaws.fsx#Alias" }, "traits": { - "smithy.api#documentation": "

An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. \n Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. \n You can associate up to 50 aliases with a file system at any time. \n You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. \n You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation.\n You only need to specify the alias name in the request payload. For more information, see \n DNS aliases.

", + "smithy.api#documentation": "

An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. \n Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. \n You can associate up to 50 aliases with a file system at any time. \n You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. \n You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation.\n You only need to specify the alias name in the request payload. For more information, see \n Managing DNS aliases.

", "smithy.api#length": { "min": 0, "max": 50 @@ -2585,7 +2550,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an S3 access point and attaches it to an Amazon FSx volume. For FSx for OpenZFS file systems, the \n volume must be hosted on a high-availability file system, either Single-AZ or Multi-AZ. For more information, \n see Accessing your data using access points \n in the Amazon FSx for OpenZFS User Guide.\n

\n

The requester requires the following permissions to perform these actions:

\n
    \n
  • \n

    \n fsx:CreateAndAttachS3AccessPoint\n

    \n
  • \n
  • \n

    \n s3:CreateAccessPoint\n

    \n
  • \n
  • \n

    \n s3:GetAccessPoint\n

    \n
  • \n
  • \n

    \n s3:PutAccessPointPolicy\n

    \n
  • \n
  • \n

    \n s3:DeleteAccessPoint\n

    \n
  • \n
\n

The following actions are related to CreateAndAttachS3AccessPoint:

\n " + "smithy.api#documentation": "

Creates an S3 access point and attaches it to an Amazon FSx volume. For FSx for OpenZFS file systems, the \n volume must be hosted on a high-availability file system, either Single-AZ or Multi-AZ. For more information,\n see Accessing your data using Amazon S3 access points.\n in the Amazon FSx for OpenZFS User Guide.\n

\n

The requester requires the following permissions to perform these actions:

\n
    \n
  • \n

    \n fsx:CreateAndAttachS3AccessPoint\n

    \n
  • \n
  • \n

    \n s3:CreateAccessPoint\n

    \n
  • \n
  • \n

    \n s3:GetAccessPoint\n

    \n
  • \n
  • \n

    \n s3:PutAccessPointPolicy\n

    \n
  • \n
  • \n

    \n s3:DeleteAccessPoint\n

    \n
  • \n
\n

The following actions are related to CreateAndAttachS3AccessPoint:

\n " } }, "com.amazonaws.fsx#CreateAndAttachS3AccessPointOpenZFSConfiguration": { @@ -3320,6 +3285,12 @@ "traits": { "smithy.api#documentation": "

Sets the storage capacity of the OpenZFS file system that you're creating\n from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB\n (512 TiB). However, the value that you specify must be equal to or greater than the\n backup's storage capacity value. If you don't use the StorageCapacity\n parameter, the default is the backup's StorageCapacity value.

\n

If used to create a file system other than OpenZFS, you must provide a value\n that matches the backup's StorageCapacity value. If you provide any\n other value, Amazon FSx responds with an HTTP status code 400 Bad Request.

" } + }, + "NetworkType": { + "target": "com.amazonaws.fsx#NetworkType", + "traits": { + "smithy.api#documentation": "

Sets the network type for the Amazon FSx for OpenZFS file system\n that you're creating from a backup.

" + } } }, "traits": { @@ -3497,7 +3468,7 @@ "EndpointIpAddressRange": { "target": "com.amazonaws.fsx#IpAddressRange", "traits": { - "smithy.api#documentation": "

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API, Amazon FSx\n selects an unused IP address range for you from the 198.19.* range. By default in the \n Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from\n the VPC’s primary CIDR range to use as the endpoint IP address range for the file system.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables, as long as they don't overlap with any subnet.

" + "smithy.api#documentation": "

(Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API, Amazon FSx\n selects an unused IP address range for you from the 198.19.* range. By default in the \n Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from\n the VPC’s primary CIDR range to use as the endpoint IP address range for the file system.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables, as long as they don't overlap with any subnet.

" } }, "FsxAdminPassword": { @@ -3544,6 +3515,12 @@ "traits": { "smithy.api#documentation": "

Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.

\n

You can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file system, but not both.

\n

This field and ThroughputCapacity are the same for file systems powered by one HA pair.

\n
    \n
  • \n

    For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

    \n
  • \n
  • \n

    For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.

    \n
  • \n
  • \n

    For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.

    \n
  • \n
\n

Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

\n
    \n
  • \n

    The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.

    \n
  • \n
  • \n

    The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).

    \n
  • \n
  • \n

    The value of ThroughputCapacityPerHAPair is not a valid value.

    \n
  • \n
" } + }, + "EndpointIpv6AddressRange": { + "target": "com.amazonaws.fsx#Ipv6AddressRange", + "traits": { + "smithy.api#documentation": "

(Multi-AZ only) Specifies the IPv6 address range in which the endpoints to access\n your file system will be created. By default in the Amazon FSx API and\n Amazon FSx console, Amazon FSx selects an available /118 IP address\n range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint\n IP addresses for file systems deployed in the same VPC/route tables, as long as they\n don't overlap with any subnet.

" + } } }, "traits": { @@ -3608,7 +3585,13 @@ "EndpointIpAddressRange": { "target": "com.amazonaws.fsx#IpAddressRange", "traits": { - "smithy.api#documentation": "

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx\n selects an available /28 IP address range for you from one of the VPC's CIDR ranges.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables, as long as they don't overlap with any subnet.

" + "smithy.api#documentation": "

(Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx\n selects an available /28 IP address range for you from one of the VPC's CIDR ranges.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables, as long as they don't overlap with any subnet.

" + } + }, + "EndpointIpv6AddressRange": { + "target": "com.amazonaws.fsx#Ipv6AddressRange", + "traits": { + "smithy.api#documentation": "

(Multi-AZ only) Specifies the IPv6 address range in which the endpoints to access\n your file system will be created. By default in the Amazon FSx API and\n Amazon FSx console, Amazon FSx selects an available /118 IP address\n range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint\n IP addresses for file systems deployed in the same VPC/route tables, as long as they\n don't overlap with any subnet.

" } }, "RouteTableIds": { @@ -3704,6 +3687,12 @@ "traits": { "smithy.api#documentation": "

The OpenZFS configuration for the file system that's being created.

" } + }, + "NetworkType": { + "target": "com.amazonaws.fsx#NetworkType", + "traits": { + "smithy.api#documentation": "

The network type of the Amazon FSx file system that you\n are creating. Valid values are IPV4 (which supports\n IPv4 only) and DUAL (for dual-stack mode, which supports\n both IPv4 and IPv6). The default is IPV4. Supported\n for FSx for OpenZFS, FSx for ONTAP, and FSx for Windows File Server\n file systems.

" + } } }, "traits": { @@ -3785,7 +3774,7 @@ "Aliases": { "target": "com.amazonaws.fsx#AlternateDNSNames", "traits": { - "smithy.api#documentation": "

An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. \n Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. \n You can associate up to 50 aliases with a file system at any time. \n You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. \n You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation.\n You only need to specify the alias name in the request payload.

\n

For more information, see Working with DNS Aliases and \n Walkthrough 5: Using DNS aliases to access your file system, including\n additional steps you must take to be able to access your file system using a DNS alias.

\n

An alias name has to meet the following requirements:

\n
    \n
  • \n

    Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

    \n
  • \n
  • \n

    Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

    \n
  • \n
  • \n

    Cannot start or end with a hyphen.

    \n
  • \n
  • \n

    Can start with a numeric.

    \n
  • \n
\n

For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: \n as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

" + "smithy.api#documentation": "

An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. \n Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. \n You can associate up to 50 aliases with a file system at any time. \n You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. \n You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation.\n You only need to specify the alias name in the request payload.\n For more information, see Managing DNS aliases and \n Accessing data using DNS aliases.

\n

An alias name has to meet the following requirements:

\n
    \n
  • \n

    Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

    \n
  • \n
  • \n

    Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

    \n
  • \n
  • \n

    Cannot start or end with a hyphen.

    \n
  • \n
  • \n

    Can start with a numeric.

    \n
  • \n
\n

For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: \n as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

" } }, "AuditLogConfiguration": { @@ -5337,7 +5326,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a file system. After deletion, the file system no longer exists, and its data\n is gone. Any existing automatic backups and snapshots are also deleted.

\n

To delete an Amazon FSx for NetApp ONTAP file system, first delete all the\n volumes and storage virtual machines (SVMs) on the file system. Then provide a\n FileSystemId value to the DeleteFileSystem operation.

\n

Before deleting an Amazon FSx for OpenZFS file system, make sure that there aren't \n any Amazon S3 access points attached to any volume. For more information on how to list S3 \n access points that are attached to volumes, see \n Listing S3 access point attachments. \n For more information on how to delete S3 access points, see \n Deleting an S3 access point attachment.

\n

By default, when you delete an Amazon FSx for Windows File Server file system,\n a final backup is created upon deletion. This final backup isn't subject to the file\n system's retention policy, and must be manually deleted.

\n

To delete an Amazon FSx for Lustre file system, first \n unmount\n it from every connected Amazon EC2 instance, then provide a FileSystemId\n value to the DeleteFileSystem operation. By default, Amazon FSx will not\n take a final backup when the DeleteFileSystem operation is invoked. On file systems\n not linked to an Amazon S3 bucket, set SkipFinalBackup to false\n to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked\n file systems. To ensure all of your data is written back to S3 before deleting your file system,\n you can either monitor for the\n AgeOfOldestQueuedMessage\n metric to be zero (if using automatic export) or you can run an\n export data repository task.\n If you have automatic export enabled and want to use an export data repository task, you have\n to disable automatic export before executing the export data repository task.

\n

The DeleteFileSystem operation returns while the file system has the\n DELETING status. You can check the file system deletion status by\n calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass the file system ID for a deleted file system, the\n DescribeFileSystems operation returns a FileSystemNotFound\n error.

\n \n

If a data repository task is in a PENDING or EXECUTING state,\n deleting an Amazon FSx for Lustre file system will fail with an HTTP status\n code 400 (Bad Request).

\n
\n \n

The data in a deleted file system is also deleted and can't be recovered by\n any means.

\n
", + "smithy.api#documentation": "

Deletes a file system. After deletion, the file system no longer exists, and its data\n is gone. Any existing automatic backups and snapshots are also deleted.

\n

To delete an Amazon FSx for NetApp ONTAP file system, first delete all the\n volumes and storage virtual machines (SVMs) on the file system. Then provide a\n FileSystemId value to the DeleteFileSystem operation.

\n

Before deleting an Amazon FSx for OpenZFS file system, make sure that there aren't \n any Amazon S3 access points attached to any volume. For more information on how to list S3 \n access points that are attached to volumes, see \n Listing S3 access point attachments. \n For more information on how to delete S3 access points, see \n Deleting an S3 access point attachment.

\n

By default, when you delete an Amazon FSx for Windows File Server file system,\n a final backup is created upon deletion. This final backup isn't subject to the file\n system's retention policy, and must be manually deleted.

\n

To delete an Amazon FSx for Lustre file system, first \n unmount\n it from every connected Amazon EC2 instance, then provide a FileSystemId\n value to the DeleteFileSystem operation. By default, Amazon FSx will not\n take a final backup when the DeleteFileSystem operation is invoked. On file systems\n not linked to an Amazon S3 bucket, set SkipFinalBackup to false\n to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked\n file systems. To ensure all of your data is written back to S3 before deleting your file system,\n you can either monitor for the\n AgeOfOldestQueuedMessage\n metric to be zero (if using automatic export) or you can run an\n export data repository task.\n If you have automatic export enabled and want to use an export data repository task, you have\n to disable automatic export before executing the export data repository task.

\n

The DeleteFileSystem operation returns while the file system has the\n DELETING status. You can check the file system deletion status by\n calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass the file system ID for a deleted file system, the\n DescribeFileSystems operation returns a FileSystemNotFound\n error.

\n \n

If a data repository task is in a PENDING or EXECUTING state,\n deleting an Amazon FSx for Lustre file system will fail with an HTTP status\n code 400 (Bad Request).

\n
\n \n

The data in a deleted file system is also deleted and can't be recovered by\n any means.

\n
", "smithy.api#examples": [ { "title": "To delete a file system", @@ -7519,6 +7508,12 @@ "traits": { "smithy.api#documentation": "

The configuration for this Amazon FSx for OpenZFS file system.

" } + }, + "NetworkType": { + "target": "com.amazonaws.fsx#NetworkType", + "traits": { + "smithy.api#documentation": "

The network type of the file system.

" + } } }, "traits": { @@ -7544,7 +7539,13 @@ "IpAddresses": { "target": "com.amazonaws.fsx#OntapEndpointIpAddresses", "traits": { - "smithy.api#documentation": "

IP addresses of the file system endpoint.

" + "smithy.api#documentation": "

The IPv4 addresses of the file system endpoint.

" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.fsx#OntapEndpointIpAddresses", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses of the file system endpoint.

" } } }, @@ -8225,10 +8226,10 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 7, - "max": 15 + "min": 1, + "max": 45 }, - "smithy.api#pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" + "smithy.api#pattern": "^(^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$)$" } }, "com.amazonaws.fsx#IpAddressRange": { @@ -8241,6 +8242,16 @@ "smithy.api#pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{9,17}$" } }, + "com.amazonaws.fsx#Ipv6AddressRange": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 43 + }, + "smithy.api#pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{4,43}$" + } + }, "com.amazonaws.fsx#JunctionPath": { "type": "string", "traits": { @@ -8860,6 +8871,23 @@ } } }, + "com.amazonaws.fsx#NetworkType": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4" + } + }, + "DUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUAL" + } + } + } + }, "com.amazonaws.fsx#NextToken": { "type": "string", "traits": { @@ -8961,7 +8989,7 @@ "EndpointIpAddressRange": { "target": "com.amazonaws.fsx#IpAddressRange", "traits": { - "smithy.api#documentation": "

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API, Amazon FSx\n selects an unused IP address range for you from the 198.19.* range. By default in the \n Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from\n the VPC’s primary CIDR range to use as the endpoint IP address range for the file system.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables.

" + "smithy.api#documentation": "

(Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API, Amazon FSx\n selects an unused IP address range for you from the 198.19.* range. By default in the \n Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from\n the VPC’s primary CIDR range to use as the endpoint IP address range for the file system.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables.

" } }, "Endpoints": { @@ -9008,6 +9036,12 @@ "traits": { "smithy.api#documentation": "

Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.

\n

This field and ThroughputCapacity cannot be defined in the same API call, but one is required.

\n

This field and ThroughputCapacity are the same for file systems with one HA pair.

\n
    \n
  • \n

    For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

    \n
  • \n
  • \n

    For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.

    \n
  • \n
  • \n

    For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.

    \n
  • \n
\n

Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

\n
    \n
  • \n

    The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.

    \n
  • \n
  • \n

    The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).

    \n
  • \n
  • \n

    The value of ThroughputCapacityPerHAPair is not a valid value.

    \n
  • \n
" } + }, + "EndpointIpv6AddressRange": { + "target": "com.amazonaws.fsx#Ipv6AddressRange", + "traits": { + "smithy.api#documentation": "

(Multi-AZ only) Specifies the IPv6 address range in which the endpoints to access\n your file system will be created. By default in the Amazon FSx API and\n Amazon FSx console, Amazon FSx selects an available /118 IP address\n range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint\n IP addresses for file systems deployed in the same VPC/route tables, as long as they\n don't overlap with any subnet.

" + } } }, "traits": { @@ -9366,7 +9400,13 @@ "EndpointIpAddressRange": { "target": "com.amazonaws.fsx#IpAddressRange", "traits": { - "smithy.api#documentation": "

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx\n selects an available /28 IP address range for you from one of the VPC's CIDR ranges.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables.

" + "smithy.api#documentation": "

(Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx\n selects an available /28 IP address range for you from one of the VPC's CIDR ranges.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables.

" + } + }, + "EndpointIpv6AddressRange": { + "target": "com.amazonaws.fsx#Ipv6AddressRange", + "traits": { + "smithy.api#documentation": "

(Multi-AZ only) Specifies the IPv6 address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API and Amazon FSx\n console, Amazon FSx selects an available /118 IP address range for you from one of the\n VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed\n in the same VPC/route tables, as long as they don't overlap with any subnet.

" } }, "RouteTableIds": { @@ -9378,7 +9418,13 @@ "EndpointIpAddress": { "target": "com.amazonaws.fsx#IpAddress", "traits": { - "smithy.api#documentation": "

The IP address of the endpoint\n that is used to access data or to manage the file system.

" + "smithy.api#documentation": "

The IPv4 address of the endpoint\n that is used to access data or to manage the file system.

" + } + }, + "EndpointIpv6Address": { + "target": "com.amazonaws.fsx#IpAddress", + "traits": { + "smithy.api#documentation": "

The IPv6 address of the endpoint that is used to access data or to manage the file system.

" } }, "ReadCacheConfiguration": { @@ -10775,7 +10821,7 @@ } }, "traits": { - "smithy.api#documentation": "

The types of limits on your service utilization. Limits include file system count,\n total throughput capacity, total storage, and total user-initiated backups. These limits\n apply for a specific account in a specific Amazon Web Services Region. You can increase some of them by\n contacting Amazon Web ServicesSupport.

" + "smithy.api#documentation": "

The types of limits on your service utilization. Limits include file system count,\n total throughput capacity, total storage, and total user-initiated backups. These limits\n apply for a specific account in a specific Amazon Web Services Region. You can increase some of them by\n contacting Amazon Web Services Support.

" } }, "com.amazonaws.fsx#ServiceLimitExceeded": { @@ -10794,7 +10840,7 @@ } }, "traits": { - "smithy.api#documentation": "

An error indicating that a particular service limit was exceeded. You can increase\n some service limits by contacting Amazon Web ServicesSupport.

", + "smithy.api#documentation": "

An error indicating that a particular service limit was exceeded. You can increase\n some service limits by contacting Amazon Web Services Support.

", "smithy.api#error": "client" } }, @@ -11235,6 +11281,18 @@ "traits": { "smithy.api#enumValue": "OPTIMIZING" } + }, + "PAUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAUSED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } } } }, @@ -11627,7 +11685,13 @@ "IpAddresses": { "target": "com.amazonaws.fsx#OntapEndpointIpAddresses", "traits": { - "smithy.api#documentation": "

The SVM endpoint's IP addresses.

" + "smithy.api#documentation": "

The SVM endpoint's IPv4 addresses.

" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.fsx#OntapEndpointIpAddresses", + "traits": { + "smithy.api#documentation": "

The SVM endpoint's IPv6 addresses.

" } } }, @@ -12256,7 +12320,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.

\n

For FSx for Windows File Server file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AuditLogConfiguration\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
  • \n
  • \n

    \n SelfManagedActiveDirectoryConfiguration\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n StorageType\n

    \n
  • \n
  • \n

    \n ThroughputCapacity\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
\n

For FSx for Lustre file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AutoImportPolicy\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n DataCompressionType\n

    \n
  • \n
  • \n

    \n FileSystemTypeVersion\n

    \n
  • \n
  • \n

    \n LogConfiguration\n

    \n
  • \n
  • \n

    \n LustreReadCacheConfiguration\n

    \n
  • \n
  • \n

    \n LustreRootSquashConfiguration\n

    \n
  • \n
  • \n

    \n MetadataConfiguration\n

    \n
  • \n
  • \n

    \n PerUnitStorageThroughput\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n ThroughputCapacity\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
\n

For FSx for ONTAP file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AddRouteTableIds\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
  • \n
  • \n

    \n FsxAdminPassword\n

    \n
  • \n
  • \n

    \n HAPairs\n

    \n
  • \n
  • \n

    \n RemoveRouteTableIds\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n ThroughputCapacity\n

    \n
  • \n
  • \n

    \n ThroughputCapacityPerHAPair\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
\n

For FSx for OpenZFS file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AddRouteTableIds\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n CopyTagsToBackups\n

    \n
  • \n
  • \n

    \n CopyTagsToVolumes\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
  • \n
  • \n

    \n ReadCacheConfiguration\n

    \n
  • \n
  • \n

    \n RemoveRouteTableIds\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n ThroughputCapacity\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
" + "smithy.api#documentation": "

Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.

\n

For FSx for Windows File Server file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AuditLogConfiguration\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
  • \n
  • \n

    \n SelfManagedActiveDirectoryConfiguration\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n StorageType\n

    \n
  • \n
  • \n

    \n ThroughputCapacity\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
\n

For FSx for Lustre file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AutoImportPolicy\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n DataCompressionType\n

    \n
  • \n
  • \n

    \n FileSystemTypeVersion\n

    \n
  • \n
  • \n

    \n LogConfiguration\n

    \n
  • \n
  • \n

    \n LustreReadCacheConfiguration\n

    \n
  • \n
  • \n

    \n LustreRootSquashConfiguration\n

    \n
  • \n
  • \n

    \n MetadataConfiguration\n

    \n
  • \n
  • \n

    \n PerUnitStorageThroughput\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n ThroughputCapacity\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
\n

For FSx for ONTAP file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AddRouteTableIds\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
  • \n
  • \n

    \n EndpointIpv6AddressRange\n

    \n
  • \n
  • \n

    \n FsxAdminPassword\n

    \n
  • \n
  • \n

    \n HAPairs\n

    \n
  • \n
  • \n

    \n RemoveRouteTableIds\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n ThroughputCapacity\n

    \n
  • \n
  • \n

    \n ThroughputCapacityPerHAPair\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
\n

For FSx for OpenZFS file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AddRouteTableIds\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n CopyTagsToBackups\n

    \n
  • \n
  • \n

    \n CopyTagsToVolumes\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
  • \n
  • \n

    \n EndpointIpv6AddressRange\n

    \n
  • \n
  • \n

    \n ReadCacheConfiguration\n

    \n
  • \n
  • \n

    \n RemoveRouteTableIds\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n ThroughputCapacity\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
" } }, "com.amazonaws.fsx#UpdateFileSystemLustreConfiguration": { @@ -12371,7 +12435,7 @@ "DiskIopsConfiguration": { "target": "com.amazonaws.fsx#DiskIopsConfiguration", "traits": { - "smithy.api#documentation": "

The SSD IOPS (input output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage capacity,\n but you can provision additional IOPS per GB of storage. The configuration consists\n of an IOPS mode (AUTOMATIC or USER_PROVISIONED), and in\n the case of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned. \n For more information, see \n Updating SSD storage capacity and IOPS.

" + "smithy.api#documentation": "

The SSD IOPS (input output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage capacity,\n but you can provision additional IOPS per GB of storage. The configuration consists\n of an IOPS mode (AUTOMATIC or USER_PROVISIONED), and in\n the case of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned. \n For more information, see \n File system storage capacity and IOPS.

" } }, "ThroughputCapacity": { @@ -12403,6 +12467,12 @@ "traits": { "smithy.api#documentation": "

Use to update the number of high-availability (HA) pairs for a second-generation single-AZ file system. \n If you increase the number of HA pairs for your file system, you must specify proportional increases for StorageCapacity, \n Iops, and ThroughputCapacity. For more information, see \n High-availability (HA) pairs in the FSx for ONTAP user guide. Block storage protocol support \n (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see \n Using block storage protocols.

" } + }, + "EndpointIpv6AddressRange": { + "target": "com.amazonaws.fsx#Ipv6AddressRange", + "traits": { + "smithy.api#documentation": "

(Multi-AZ only) Specifies the IPv6 address range in which the endpoints to access\n your file system will be created. By default in the Amazon FSx API and\n Amazon FSx console, Amazon FSx selects an available /118 IP address\n range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint\n IP addresses for file systems deployed in the same VPC/route tables, as long as they\n don't overlap with any subnet.

" + } } }, "traits": { @@ -12459,6 +12529,12 @@ "traits": { "smithy.api#documentation": "

\n The configuration for the optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class.

" } + }, + "EndpointIpv6AddressRange": { + "target": "com.amazonaws.fsx#Ipv6AddressRange", + "traits": { + "smithy.api#documentation": "

(Multi-AZ only) Specifies the IPv6 address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API and Amazon FSx console,\n Amazon FSx selects an available /118 IP address range for you from one of the VPC's CIDR ranges.\n You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables,\n as long as they don't overlap with any subnet.

" + } } }, "traits": { @@ -12486,7 +12562,7 @@ "StorageCapacity": { "target": "com.amazonaws.fsx#StorageCapacity", "traits": { - "smithy.api#documentation": "

Use this parameter to increase the storage capacity of an FSx for Windows File Server,\n FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system.\n Specifies the storage capacity target value, in GiB, to increase the storage capacity for\n the file system that you're updating.

\n \n

You can't make a storage capacity increase request if there is an existing storage\n capacity increase request in progress.

\n
\n

For Lustre file systems, the storage capacity target value can be the following:

\n
    \n
  • \n

    For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 SSD deployment types, valid values\n are in multiples of 2400 GiB. The value must be greater than the current storage capacity.

    \n
  • \n
  • \n

    For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for\n 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput\n per TiB file systems. The values must be greater than the current storage capacity.

    \n
  • \n
  • \n

    For SCRATCH_1 file systems, you can't increase the storage capacity.

    \n
  • \n
\n

For more information, see Managing storage and throughput\n capacity in the FSx for Lustre User Guide.

\n

For FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. For more information, see\n Managing storage capacity in the FSx for OpenZFS User\n Guide.

\n

For Windows file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. To increase storage capacity, the file system\n must have at least 16 MBps of throughput capacity. For more information, see Managing storage\n capacity in the Amazon FSxfor Windows File Server User\n Guide.

\n

For ONTAP file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. For more information, see\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.

" + "smithy.api#documentation": "

Use this parameter to increase the storage capacity of an FSx for Windows File Server,\n FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system.\n For second-generation FSx for ONTAP file systems, you can also decrease the storage capacity.\n Specifies the storage capacity target value, in GiB, for the file system that you're updating.

\n \n

You can't make a storage capacity increase request if there is an existing storage\n capacity increase request in progress.

\n
\n

For Lustre file systems, the storage capacity target value can be the following:

\n
    \n
  • \n

    For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 SSD deployment types, valid values\n are in multiples of 2400 GiB. The value must be greater than the current storage capacity.

    \n
  • \n
  • \n

    For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for\n 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput\n per TiB file systems. The values must be greater than the current storage capacity.

    \n
  • \n
  • \n

    For SCRATCH_1 file systems, you can't increase the storage capacity.

    \n
  • \n
\n

For more information, see Managing storage and throughput\n capacity in the FSx for Lustre User Guide.

\n

For FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. For more information, see\n Managing storage capacity in the FSx for OpenZFS User\n Guide.

\n

For Windows file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. To increase storage capacity, the file system\n must have at least 16 MBps of throughput capacity. For more information, see Managing storage\n capacity in the Amazon FSxfor Windows File Server User\n Guide.

\n

For ONTAP file systems, when increasing storage capacity, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. When decreasing storage capacity on second-generation file systems, the target value must be at least 9 percent smaller than the current SSD storage capacity. For more information, see\n File system storage capacity and IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.

" } }, "WindowsConfiguration": { @@ -12515,6 +12591,12 @@ "traits": { "smithy.api#documentation": "

The Lustre version you are updating an FSx for Lustre file system to.\n Valid values are 2.12 and 2.15. The value you choose must be\n newer than the file system's current Lustre version.

" } + }, + "NetworkType": { + "target": "com.amazonaws.fsx#NetworkType", + "traits": { + "smithy.api#documentation": "

Changes the network type of an FSx for OpenZFS file system.

" + } } }, "traits": { @@ -13551,7 +13633,7 @@ "PreferredFileServerIp": { "target": "com.amazonaws.fsx#IpAddress", "traits": { - "smithy.api#documentation": "

For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

\n

Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that \n are not joined to a Microsoft Active Directory. \n Applicable for all Windows file system deployment types. \n This IP address is temporarily unavailable \n when the file system is undergoing maintenance. For Linux and Windows \n SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information\n on mapping and mounting file shares, see \n Accessing File Shares.

" + "smithy.api#documentation": "

For MULTI_AZ_1 deployment types, the IPv4 address of the primary, or preferred, file server.

\n

Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that \n are not joined to a Microsoft Active Directory. \n Applicable for all Windows file system deployment types. \n This IPv4 address is temporarily unavailable \n when the file system is undergoing maintenance. For Linux and Windows \n SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information\n on mapping and mounting file shares, see \n Accessing data using file shares.

" } }, "ThroughputCapacity": { @@ -13604,6 +13686,12 @@ "traits": { "smithy.api#documentation": "

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system.\n By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional\n IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

" } + }, + "PreferredFileServerIpv6": { + "target": "com.amazonaws.fsx#IpAddress", + "traits": { + "smithy.api#documentation": "

For MULTI_AZ_1 deployment types, the IPv6 address of the primary, or preferred, file server.\n Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients\n that are not joined to a Microsoft Active Directory. Applicable for all Windows file system\n deployment types. This IPv6 address is temporarily unavailable when the file system is undergoing\n maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the\n file system's DNSName instead.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/gamelift.json b/codegen/sdk/aws-models/gamelift.json index bf88dfee1fe..5bc71cefc64 100644 --- a/codegen/sdk/aws-models/gamelift.json +++ b/codegen/sdk/aws-models/gamelift.json @@ -12225,17 +12225,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -12249,17 +12238,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -12273,17 +12251,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -12297,17 +12264,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/gameliftstreams.json b/codegen/sdk/aws-models/gameliftstreams.json index 442d16f2da0..5600c86ecb3 100644 --- a/codegen/sdk/aws-models/gameliftstreams.json +++ b/codegen/sdk/aws-models/gameliftstreams.json @@ -105,7 +105,7 @@ "Locations": { "target": "com.amazonaws.gameliftstreams#LocationStates", "traits": { - "smithy.api#documentation": "

This value is set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

  • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

  • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

  • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

  • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

", + "smithy.api#documentation": "

This value is set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

  • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

  • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

  • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

  • REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.

", "smithy.api#notProperty": {}, "smithy.api#required": {} } @@ -321,7 +321,7 @@ "RuntimeEnvironment": { "target": "com.amazonaws.gameliftstreams#RuntimeEnvironment", "traits": { - "smithy.api#documentation": "

Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

A runtime environment can be one of the following:

  • For Linux applications

    • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

  • For Windows applications

    • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

    • Proton 8.0-5 (Type=PROTON, Version=20241007)

    • Proton 8.0-2c (Type=PROTON, Version=20230704)

" + "smithy.api#documentation": "

Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

A runtime environment can be one of the following:

  • For Linux applications

    • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

  • For Windows applications

    • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

    • Proton 9.0-2 (Type=PROTON, Version=20250516)

    • Proton 8.0-5 (Type=PROTON, Version=20241007)

    • Proton 8.0-2c (Type=PROTON, Version=20230704)

" } } }, @@ -389,7 +389,7 @@ } } }, - "smithy.api#documentation": "

When you associate, or link, an application with a stream group, then Amazon GameLift Streams can launch the application using the stream group's allocated compute resources. The stream group must be in ACTIVE status. You can reverse this action by using DisassociateApplications.

", + "smithy.api#documentation": "

When you associate, or link, an application with a stream group, then Amazon GameLift Streams can launch the application using the stream group's allocated compute resources. The stream group must be in ACTIVE status. You can reverse this action by using DisassociateApplications.

If a stream group does not already have a linked application, Amazon GameLift Streams will automatically assign the first application provided in ApplicationIdentifiers as the default.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -548,7 +548,7 @@ "RuntimeEnvironment": { "target": "com.amazonaws.gameliftstreams#RuntimeEnvironment", "traits": { - "smithy.api#documentation": "

Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

A runtime environment can be one of the following:

  • For Linux applications

    • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

  • For Windows applications

    • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

    • Proton 8.0-5 (Type=PROTON, Version=20241007)

    • Proton 8.0-2c (Type=PROTON, Version=20230704)

", + "smithy.api#documentation": "

Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

A runtime environment can be one of the following:

  • For Linux applications

    • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

  • For Windows applications

    • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

    • Proton 9.0-2 (Type=PROTON, Version=20250516)

    • Proton 8.0-5 (Type=PROTON, Version=20241007)

    • Proton 8.0-2c (Type=PROTON, Version=20230704)

", "smithy.api#required": {} } }, @@ -618,7 +618,7 @@ "target": "com.amazonaws.gameliftstreams#RuntimeEnvironment", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "

Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

A runtime environment can be one of the following:

  • For Linux applications

    • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

  • For Windows applications

    • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

    • Proton 8.0-5 (Type=PROTON, Version=20241007)

    • Proton 8.0-2c (Type=PROTON, Version=20230704)

" + "smithy.api#documentation": "

Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

A runtime environment can be one of the following:

  • For Linux applications

    • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

  • For Windows applications

    • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

    • Proton 9.0-2 (Type=PROTON, Version=20250516)

    • Proton 8.0-5 (Type=PROTON, Version=20241007)

    • Proton 8.0-2c (Type=PROTON, Version=20230704)

" } }, "ExecutablePath": { @@ -740,7 +740,7 @@ "gameliftstreams:TagResource" ] }, - "smithy.api#documentation": "

Manage how Amazon GameLift Streams streams your applications by using a stream group. A stream group is a collection of resources that Amazon GameLift Streams uses to stream your application to end-users. When you create a stream group, you specify an application to stream by default and the type of hardware to use, such as the graphical processing unit (GPU). You can also link additional applications, which allows you to stream those applications using this stream group. Depending on your expected users, you also scale the number of concurrent streams you want to support at one time, and in what locations.

Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand:

  • Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session.

  • On-demand: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).

To adjust the capacity of any ACTIVE stream group, call UpdateStreamGroup.

If the request is successful, Amazon GameLift Streams begins creating the stream group. Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to ACTIVATING. When the stream group reaches ACTIVE status, you can start stream sessions by using StartStreamSession. To check the stream group's status, call GetStreamGroup.

", + "smithy.api#documentation": "

Manage how Amazon GameLift Streams streams your applications by using a stream group. A stream group is a collection of resources that Amazon GameLift Streams uses to stream your application to end-users. When you create a stream group, you specify an application to stream by default and the type of hardware to use, such as the graphical processing unit (GPU). You can also link additional applications, which allows you to stream those applications using this stream group. Depending on your expected users, you also scale the number of concurrent streams you want to support at one time, and in what locations.

Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand:

  • Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 when creating a stream group or adding a location.

  • On-demand: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location.

To adjust the capacity of any ACTIVE stream group, call UpdateStreamGroup.

If the request is successful, Amazon GameLift Streams begins creating the stream group. Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to ACTIVATING. When the stream group reaches ACTIVE status, you can start stream sessions by using StartStreamSession. To check the stream group's status, call GetStreamGroup.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -769,7 +769,7 @@ "DefaultApplicationIdentifier": { "target": "com.amazonaws.gameliftstreams#Identifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the Amazon GameLift Streams application that you want to associate to a stream group as the default application. The application must be in READY status. By setting the default application identifier, you will optimize startup performance of this application in your stream group. Once set, this application cannot be disassociated from the stream group, unlike applications that are associated using AssociateApplications. If not set when creating a stream group, you will need to call AssociateApplications later, before you can start streaming.

This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.

", + "smithy.api#documentation": "

The unique identifier of the Amazon GameLift Streams application that you want to set as the default application in a stream group. The application that you specify must be in READY status. The default application is pre-cached on always-on compute resources, reducing stream startup times. Other applications are automatically cached as needed.

If you do not link an application when you create a stream group, you will need to link one later, before you can start streaming, using AssociateApplications.

This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.

", "smithy.api#notProperty": {} } }, @@ -827,7 +827,7 @@ "target": "com.amazonaws.gameliftstreams#LocationStates", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

This value is the set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

  • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

  • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

  • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

  • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

" + "smithy.api#documentation": "

This value is the set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

  • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

  • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

  • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

  • REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.

" } }, "StreamClass": { @@ -854,7 +854,7 @@ "target": "com.amazonaws.gameliftstreams#StreamGroupStatusReason", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

  • internalError: The request can't process right now bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.

  • noAvailableInstances: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

" + "smithy.api#documentation": "

A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

  • internalError: The request can't process right now because of an issue with the server. Try again later.

  • noAvailableInstances: Amazon GameLift Streams does not currently have enough available on-demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

" } }, "LastUpdatedAt": { @@ -921,7 +921,7 @@ } } }, - "smithy.api#documentation": "

Allows clients to reconnect to a recently disconnected stream session without losing any data from the last session.

A client can reconnect to a stream session that's in PENDING_CLIENT_RECONNECTION or ACTIVE status. In the stream session life cycle, when the client disconnects from the stream session, the stream session transitions from CONNECTED to PENDING_CLIENT_RECONNECTION status. When a client requests to reconnect by calling CreateStreamSessionConnection, the stream session transitions to RECONNECTING status. When the reconnection is successful, the stream session transitions to ACTIVE status. After a stream session is disconnected for longer than ConnectionTimeoutSeconds, the stream session transitions to the TERMINATED status.

To connect to an existing stream session, specify the stream group ID and stream session ID that you want to reconnect to, as well as the signal request settings to use with the stream.

ConnectionTimeoutSeconds defines the amount of time after the stream session disconnects that a reconnection is allowed. If a client is disconnected from the stream for longer than ConnectionTimeoutSeconds, the stream session ends.

", + "smithy.api#documentation": "

Enables clients to reconnect to a stream session while preserving all session state and data in the disconnected session. This reconnection process can be initiated when a stream session is in either PENDING_CLIENT_RECONNECTION or ACTIVE status. The process works as follows:

  1. Initial disconnect:

    • When a client disconnects or loses connection, the stream session transitions from CONNECTED to PENDING_CLIENT_RECONNECTION

  2. Reconnection time window:

    • Clients have ConnectionTimeoutSeconds (defined in StartStreamSession) to reconnect before session termination

    • Your backend server must call CreateStreamSessionConnection to initiate reconnection

    • Session transitions to RECONNECTING status

  3. Reconnection completion:

    • On successful CreateStreamSessionConnection, session status changes to ACTIVE

    • Provide the new connection information to the requesting client

    • Client must establish connection within ConnectionTimeoutSeconds

    • Session terminates automatically if client fails to connect in time

For more information about the stream session lifecycle, see Stream sessions in the Amazon GameLift Streams Developer Guide.

To begin re-connecting to an existing stream session, specify the stream group ID and stream session ID that you want to reconnect to, and the signal request to use with the stream.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -942,7 +942,7 @@ "Identifier": { "target": "com.amazonaws.gameliftstreams#Identifier", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

The stream group that you want to run this stream session with. The stream group must be in ACTIVE status and have idle stream capacity.

", + "smithy.api#documentation": "

Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

The stream group that you want to run this stream session with. The stream group must be in ACTIVE status.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1162,7 +1162,7 @@ } } }, - "smithy.api#documentation": "

When you disassociate, or unlink, an application from a stream group, you can no longer stream this application by using that stream group's allocated compute resources. Any streams in process will continue until they terminate, which helps avoid interrupting an end-user's stream. Amazon GameLift Streams will not initiate new streams using this stream group. The disassociate action does not affect the stream capacity of a stream group.

You can only disassociate an application if it's not a default application of the stream group. Check DefaultApplicationIdentifier by calling GetStreamGroup.

", + "smithy.api#documentation": "

When you disassociate, or unlink, an application from a stream group, you can no longer stream this application by using that stream group's allocated compute resources. Any streams in process will continue until they terminate, which helps avoid interrupting an end-user's stream. Amazon GameLift Streams will not initiate new streams in the stream group using the disassociated application. The disassociate action does not affect the stream capacity of a stream group.

If you disassociate the default application, Amazon GameLift Streams will automatically choose a new default application from the remaining associated applications. To change which application is the default application, call UpdateStreamGroup and specify a new DefaultApplicationIdentifier.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1762,102 +1762,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://gameliftstreams-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://gameliftstreams.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://gameliftstreams-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://gameliftstreams.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://gameliftstreams-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://gameliftstreams.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://gameliftstreams-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://gameliftstreams.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { @@ -2000,7 +1904,7 @@ "target": "com.amazonaws.gameliftstreams#RuntimeEnvironment", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "

Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

A runtime environment can be one of the following:

  • For Linux applications

    • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

  • For Windows applications

    • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

    • Proton 8.0-5 (Type=PROTON, Version=20241007)

    • Proton 8.0-2c (Type=PROTON, Version=20230704)

" + "smithy.api#documentation": "

Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

A runtime environment can be one of the following:

  • For Linux applications

    • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

  • For Windows applications

    • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

    • Proton 9.0-2 (Type=PROTON, Version=20250516)

    • Proton 8.0-5 (Type=PROTON, Version=20241007)

    • Proton 8.0-2c (Type=PROTON, Version=20230704)

" } }, "ExecutablePath": { @@ -2242,7 +2146,7 @@ "target": "com.amazonaws.gameliftstreams#LocationStates", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

This value is the set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

  • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

  • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

  • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

  • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

" + "smithy.api#documentation": "

This value is the set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

  • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

  • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

  • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

  • REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.

" } }, "StreamClass": { @@ -2269,7 +2173,7 @@ "target": "com.amazonaws.gameliftstreams#StreamGroupStatusReason", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

  • internalError: The request can't process right now bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.

  • noAvailableInstances: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

" + "smithy.api#documentation": "

A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

  • internalError: The request can't process right now because of an issue with the server. Try again later.

  • noAvailableInstances: Amazon GameLift Streams does not currently have enough available on-demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

" } }, "LastUpdatedAt": { @@ -2441,7 +2345,7 @@ "Status": { "target": "com.amazonaws.gameliftstreams#StreamSessionStatus", "traits": { - "smithy.api#documentation": "

The current status of the stream session. A stream session can host clients when in ACTIVE status.

" + "smithy.api#documentation": "

The current status of the stream session. A stream session is ready for a client to connect when in ACTIVE status.

  • ACTIVATING: The stream session is starting and preparing to stream.

  • ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE state to establish a connection. If no client connects within this timeframe, the session automatically terminates.

  • CONNECTED: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified by SessionLengthSeconds in StartStreamSession is exceeded.

  • ERROR: The stream session failed to activate.

  • PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_CLIENT_RECONNECTION state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates.

  • RECONNECTING: A client has initiated a reconnect to a session that was in PENDING_CLIENT_RECONNECTION state.

  • TERMINATING: The stream session is ending.

  • TERMINATED: The stream session has ended.

" } }, "StatusReason": { @@ -2459,7 +2363,7 @@ "Location": { "target": "com.amazonaws.gameliftstreams#LocationName", "traits": { - "smithy.api#documentation": "

The location where Amazon GameLift Streams is hosting the stream session.

A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

" + "smithy.api#documentation": "

The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

" } }, "SignalRequest": { @@ -2477,13 +2381,13 @@ "ConnectionTimeoutSeconds": { "target": "com.amazonaws.gameliftstreams#ConnectionTimeoutSeconds", "traits": { - "smithy.api#documentation": "

The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session regardless of any existing client connections.

" + "smithy.api#documentation": "

The length of time that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. This time span starts when the stream session reaches ACTIVE or PENDING_CLIENT_RECONNECTION state. If no client connects (or reconnects) before the timeout, Amazon GameLift Streams terminates the stream session.

" } }, "SessionLengthSeconds": { "target": "com.amazonaws.gameliftstreams#SessionLengthSeconds", "traits": { - "smithy.api#documentation": "

The length of time that Amazon GameLift Streams keeps the game session open.

" + "smithy.api#documentation": "

The maximum duration of a session. Amazon GameLift Streams will automatically terminate a session after this amount of time has elapsed, regardless of any existing client connections.

" } }, "AdditionalLaunchArgs": { @@ -2972,7 +2876,7 @@ "ExportFilesStatus": { "target": "com.amazonaws.gameliftstreams#ExportFilesStatus", "traits": { - "smithy.api#documentation": "

Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status.

Exported files can be in one of the following states:

  • SUCCEEDED: The exported files are successfully stored in S3 bucket.

  • FAILED: The session ended but Amazon GameLift Streams couldn't collect and upload the to S3.

  • PENDING: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress.

", + "smithy.api#documentation": "

Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status.

Exported files can be in one of the following states:

  • SUCCEEDED: The exported files are successfully stored in an S3 bucket.

  • FAILED: The session ended but Amazon GameLift Streams couldn't collect and upload the files to S3.

  • PENDING: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress.

", "smithy.api#httpQuery": "ExportFilesStatus" } }, @@ -3123,13 +3027,13 @@ "AlwaysOnCapacity": { "target": "com.amazonaws.gameliftstreams#AlwaysOnCapacity", "traits": { - "smithy.api#documentation": "

The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session.

" + "smithy.api#documentation": "

The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 when creating a stream group or adding a location.

" } }, "OnDemandCapacity": { "target": "com.amazonaws.gameliftstreams#OnDemandCapacity", "traits": { - "smithy.api#documentation": "

The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).

" + "smithy.api#documentation": "

The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location.

" } } }, @@ -3185,21 +3089,21 @@ "target": "com.amazonaws.gameliftstreams#StreamGroupLocationStatus", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

This value is set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

  • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

  • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

  • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

  • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

" + "smithy.api#documentation": "

This value is set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

  • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

  • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

  • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

  • REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.

" } }, "AlwaysOnCapacity": { "target": "com.amazonaws.gameliftstreams#AlwaysOnCapacity", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session.

" + "smithy.api#documentation": "

The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 when creating a stream group or adding a location.

" } }, "OnDemandCapacity": { "target": "com.amazonaws.gameliftstreams#OnDemandCapacity", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).

" + "smithy.api#documentation": "

The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location.

" } }, "RequestedCapacity": { @@ -3345,7 +3249,7 @@ "Locations": { "target": "com.amazonaws.gameliftstreams#LocationsList", "traits": { - "smithy.api#documentation": "

A set of locations to remove this stream group.

A set of location names. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

", + "smithy.api#documentation": "

A set of locations to remove this stream group. For example, us-east-1.

For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

", "smithy.api#httpQuery": "locations", "smithy.api#notProperty": {}, "smithy.api#required": {} @@ -3435,7 +3339,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

A runtime environment can be one of the following:

  • For Linux applications

    • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

  • For Windows applications

    • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

    • Proton 8.0-5 (Type=PROTON, Version=20241007)

    • Proton 8.0-2c (Type=PROTON, Version=20230704)

" + "smithy.api#documentation": "

Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

A runtime environment can be one of the following:

  • For Linux applications

    • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

  • For Windows applications

    • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

    • Proton 9.0-2 (Type=PROTON, Version=20250516)

    • Proton 8.0-5 (Type=PROTON, Version=20241007)

    • Proton 8.0-2c (Type=PROTON, Version=20230704)

" } }, "com.amazonaws.gameliftstreams#RuntimeEnvironmentType": { @@ -3549,7 +3453,7 @@ } } }, - "smithy.api#documentation": "

This action initiates a new stream session and outputs connection information that clients can use to access the stream. A stream session refers to an instance of a stream that Amazon GameLift Streams transmits from the server to the end-user. A stream session runs on a compute resource that a stream group has allocated.

To start a new stream session, specify a stream group and application ID, along with the transport protocol and signal request settings to use with the stream. You must have associated at least one application to the stream group before starting a stream session, either when creating the stream group, or by using AssociateApplications.

For stream groups that have multiple locations, provide a set of locations ordered by priority using a Locations parameter. Amazon GameLift Streams will start a single stream session in the next available location. An application must be finished replicating in a remote location before the remote location can host a stream.

If the request is successful, Amazon GameLift Streams begins to prepare the stream. Amazon GameLift Streams assigns an Amazon Resource Name (ARN) value to the stream session resource and sets the status to ACTIVATING. During the stream preparation process, Amazon GameLift Streams queues the request and searches for available stream capacity to run the stream. This results in one of the following:

  • Amazon GameLift Streams identifies an available compute resource to run the application content and start the stream. When the stream is ready, the stream session's status changes to ACTIVE and includes stream connection information. Provide the connection information to the requesting client to join the stream session.

  • Amazon GameLift Streams doesn't identify an available resource within a certain time, set by ClientToken. In this case, Amazon GameLift Streams stops processing the request, and the stream session object status changes to ERROR with status reason placementTimeout.

", + "smithy.api#documentation": "

This action initiates a new stream session and outputs connection information that clients can use to access the stream. A stream session refers to an instance of a stream that Amazon GameLift Streams transmits from the server to the end-user. A stream session runs on a compute resource that a stream group has allocated. The start stream session process works as follows:

  1. Prerequisites:

    • You must have a stream group in ACTIVE state

    • You must have idle or on-demand capacity in a stream group in the location you want to stream from

    • You must have at least one application associated to the stream group (use AssociateApplications if needed)

  2. Start stream request:

    • Your backend server calls StartStreamSession to initiate connection

    • Amazon GameLift Streams creates the stream session resource, assigns an Amazon Resource Name (ARN) value, and begins searching for available stream capacity to run the stream

    • Session transitions to ACTIVATING status

  3. Placement completion:

    • If Amazon GameLift Streams is successful in finding capacity for the stream, the stream session status changes to ACTIVE status and StartStreamSession returns stream connection information

    • If Amazon GameLift Streams was not successful in finding capacity within the placement timeout period (defined according to the capacity type and platform type), the stream session status changes to ERROR status and StartStreamSession returns a StatusReason of placementTimeout

  4. Connection completion:

    • Provide the new connection information to the requesting client

    • Client must establish connection within ConnectionTimeoutSeconds (specified in StartStreamSession parameters)

    • Session terminates automatically if client fails to connect in time

For more information about the stream session lifecycle, see Stream sessions in the Amazon GameLift Streams Developer Guide.

Timeouts to be aware of that affect a stream session:

  • Placement timeout: The amount of time that Amazon GameLift Streams has to find capacity for a stream request. Placement timeout varies based on the capacity type used to fulfill your stream request:

    • Always-on capacity: 75 seconds

    • On-demand capacity:

      • Linux/Proton runtimes: 90 seconds

      • Windows runtime: 10 minutes

  • Connection timeout: The amount of time that Amazon GameLift Streams waits for a client to connect to a stream session in ACTIVE status, or reconnect to a stream session in PENDING_CLIENT_RECONNECTION status, the latter of which occurs when a client disconnects or loses connection from a stream session. If no client connects before the timeout, Amazon GameLift Streams terminates the stream session. This value is specified by ConnectionTimeoutSeconds in the StartStreamSession parameters.

  • Idle timeout: A stream session will be terminated if no user input has been received for 60 minutes.

  • Maximum session length: A stream session will be terminated after this amount of time has elapsed since it started, regardless of any existing client connections. This value is specified by SessionLengthSeconds in the StartStreamSession parameters.

To start a new stream session, specify a stream group ID and application ID, along with the transport protocol and signal request to use with the stream session.

For stream groups that have multiple locations, provide a set of locations ordered by priority using a Locations parameter. Amazon GameLift Streams will start a single stream session in the next available location. An application must be finished replicating to a remote location before the remote location can host a stream.

To reconnect to a stream session after a client disconnects or loses connection, use CreateStreamSessionConnection.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -3611,19 +3515,19 @@ "Locations": { "target": "com.amazonaws.gameliftstreams#LocationList", "traits": { - "smithy.api#documentation": "

A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from. Amazon GameLift Streams selects the location with the next available capacity to start a single stream session in. If this value is empty, Amazon GameLift Streams attempts to start a stream session in the primary location.

This value is A set of location names. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

" + "smithy.api#documentation": "

A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from. For example, us-east-1. Amazon GameLift Streams selects the location with the next available capacity to start a single stream session in. If this value is empty, Amazon GameLift Streams attempts to start a stream session in the primary location.

For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

" } }, "ConnectionTimeoutSeconds": { "target": "com.amazonaws.gameliftstreams#ConnectionTimeoutSeconds", "traits": { - "smithy.api#documentation": "

Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect to the stream session. This time span starts when the stream session reaches ACTIVE status. If no client connects before the timeout, Amazon GameLift Streams stops the stream session with status of TERMINATED. Default value is 120.

" + "smithy.api#documentation": "

Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. Applies to both connection and reconnection scenarios. This time span starts when the stream session reaches ACTIVE state. If no client connects before the timeout, Amazon GameLift Streams terminates the stream session. Default value is 120.

" } }, "SessionLengthSeconds": { "target": "com.amazonaws.gameliftstreams#SessionLengthSeconds", "traits": { - "smithy.api#documentation": "

The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session regardless of any existing client connections. Default value is 43200.

" + "smithy.api#documentation": "

The maximum duration of a session. Amazon GameLift Streams will automatically terminate a session after this amount of time has elapsed, regardless of any existing client connections. Default value is 43200 (12 hours).

" } }, "AdditionalLaunchArgs": { @@ -3673,7 +3577,7 @@ "Status": { "target": "com.amazonaws.gameliftstreams#StreamSessionStatus", "traits": { - "smithy.api#documentation": "

The current status of the stream session. A stream session can host clients when in ACTIVE status.

" + "smithy.api#documentation": "

The current status of the stream session. A stream session is ready for a client to connect when in ACTIVE status.

  • ACTIVATING: The stream session is starting and preparing to stream.

  • ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE state to establish a connection. If no client connects within this timeframe, the session automatically terminates.

  • CONNECTED: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified by SessionLengthSeconds in StartStreamSession is exceeded.

  • ERROR: The stream session failed to activate.

  • PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_CLIENT_RECONNECTION state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates.

  • RECONNECTING: A client has initiated a reconnect to a session that was in PENDING_CLIENT_RECONNECTION state.

  • TERMINATING: The stream session is ending.

  • TERMINATED: The stream session has ended.

" } }, "StatusReason": { @@ -3691,7 +3595,7 @@ "Location": { "target": "com.amazonaws.gameliftstreams#LocationName", "traits": { - "smithy.api#documentation": "

The location where Amazon GameLift Streams is streaming your application from.

A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

" + "smithy.api#documentation": "

The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

" } }, "SignalRequest": { @@ -3709,13 +3613,13 @@ "ConnectionTimeoutSeconds": { "target": "com.amazonaws.gameliftstreams#ConnectionTimeoutSeconds", "traits": { - "smithy.api#documentation": "

The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session regardless of any existing client connections.

" + "smithy.api#documentation": "

The length of time that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. This time span starts when the stream session reaches ACTIVE or PENDING_CLIENT_RECONNECTION state. If no client connects (or reconnects) before the timeout, Amazon GameLift Streams terminates the stream session.

" } }, "SessionLengthSeconds": { "target": "com.amazonaws.gameliftstreams#SessionLengthSeconds", "traits": { - "smithy.api#documentation": "

The length of time that Amazon GameLift Streams keeps the game session open.

" + "smithy.api#documentation": "

The maximum duration of a session. Amazon GameLift Streams will automatically terminate a session after this amount of time has elapsed, regardless of any existing client connections.

" } }, "AdditionalLaunchArgs": { @@ -3757,7 +3661,7 @@ "ApplicationArn": { "target": "com.amazonaws.gameliftstreams#Arn", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.

" + "smithy.api#documentation": "

The application streaming in this session.

This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.

" } }, "ExportFilesMetadata": { @@ -4138,7 +4042,7 @@ "Status": { "target": "com.amazonaws.gameliftstreams#StreamSessionStatus", "traits": { - "smithy.api#documentation": "

The current status of the stream session resource. Possible statuses include the following:

  • ACTIVATING: The stream session is starting and preparing to stream.

  • ACTIVE: The stream session is ready to accept client connections.

  • CONNECTED: The stream session has a connected client.

  • PENDING_CLIENT_RECONNECTION: A client has recently disconnected, and the stream session is waiting for the client to reconnect. After a short time, if the client doesn't reconnect, the stream session status transitions to TERMINATED.

  • TERMINATING: The stream session is ending.

  • TERMINATED: The stream session has ended.

  • ERROR: The stream session failed to activate.

" + "smithy.api#documentation": "

The current status of the stream session resource.

  • ACTIVATING: The stream session is starting and preparing to stream.

  • ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE state to establish a connection. If no client connects within this timeframe, the session automatically terminates.

  • CONNECTED: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified by SessionLengthSeconds in StartStreamSession is exceeded.

  • ERROR: The stream session failed to activate.

  • PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_CLIENT_RECONNECTION state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates.

  • RECONNECTING: A client has initiated a reconnect to a session that was in PENDING_CLIENT_RECONNECTION state.

  • TERMINATING: The stream session is ending.

  • TERMINATED: The stream session has ended.

" } }, "Protocol": { @@ -4174,12 +4078,12 @@ "Location": { "target": "com.amazonaws.gameliftstreams#LocationName", "traits": { - "smithy.api#documentation": "

The location where Amazon GameLift Streams is hosting the stream session.

A location's name. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

" + "smithy.api#documentation": "

The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

" } } }, "traits": { - "smithy.api#documentation": "

Describes a Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession.

" + "smithy.api#documentation": "

Describes an Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession.

" } }, "com.amazonaws.gameliftstreams#StreamSessionSummaryList": { @@ -4564,7 +4468,7 @@ "target": "com.amazonaws.gameliftstreams#RuntimeEnvironment", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "

Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

A runtime environment can be one of the following:

  • For Linux applications

    • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

  • For Windows applications

    • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

    • Proton 8.0-5 (Type=PROTON, Version=20241007)

    • Proton 8.0-2c (Type=PROTON, Version=20230704)

" + "smithy.api#documentation": "

Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

A runtime environment can be one of the following:

  • For Linux applications

    • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

  • For Windows applications

    • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

    • Proton 9.0-2 (Type=PROTON, Version=20250516)

    • Proton 8.0-5 (Type=PROTON, Version=20241007)

    • Proton 8.0-2c (Type=PROTON, Version=20230704)

" } }, "ExecutablePath": { @@ -4679,7 +4583,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to update a StreamGroup" }, - "smithy.api#documentation": "

Updates the configuration settings for an Amazon GameLift Streams stream group resource. You can change the description, the set of locations, and the requested capacity of a stream group per location. If you want to change the stream class, create a new stream group.

Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand:

  • Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session.

  • On-demand: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).

To update a stream group, specify the stream group's Amazon Resource Name (ARN) and provide the new values. If the request is successful, Amazon GameLift Streams returns the complete updated metadata for the stream group.

", + "smithy.api#documentation": "

Updates the configuration settings for an Amazon GameLift Streams stream group resource. You can change the description, the set of locations, and the requested capacity of a stream group per location. If you want to change the stream class, create a new stream group.

Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand:

  • Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 when creating a stream group or adding a location.

  • On-demand: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location.

To update a stream group, specify the stream group's Amazon Resource Name (ARN) and provide the new values. If the request is successful, Amazon GameLift Streams returns the complete updated metadata for the stream group.

", "smithy.api#http": { "code": 200, "method": "PATCH", @@ -4711,6 +4615,13 @@ "traits": { "smithy.api#documentation": "

A descriptive label for the stream group.

" } + }, + "DefaultApplicationIdentifier": { + "target": "com.amazonaws.gameliftstreams#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Amazon GameLift Streams application that you want to set as the default application in a stream group. The application that you specify must be in READY status. The default application is pre-cached on always-on compute resources, reducing stream startup times. Other applications are automatically cached as needed.

Note that this parameter only sets the default application in a stream group. To associate a new application to an existing stream group, you must use AssociateApplications.

When you switch default applications in a stream group, it can take up to a few hours for the new default application to be pre-cached.

This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.

", + "smithy.api#notProperty": {} + } } }, "traits": { @@ -4745,7 +4656,7 @@ "target": "com.amazonaws.gameliftstreams#LocationStates", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

This value is set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

  • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

  • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

  • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

  • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

" + "smithy.api#documentation": "

This value is set of locations, including their name, current status, and capacities.

A location can be in one of the following states:

  • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

  • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

  • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

  • REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.

" } }, "StreamClass": { @@ -4772,7 +4683,7 @@ "target": "com.amazonaws.gameliftstreams#StreamGroupStatusReason", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

  • internalError: The request can't process right now bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.

  • noAvailableInstances: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

" + "smithy.api#documentation": "

A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

  • internalError: The request can't process right now because of an issue with the server. Try again later.

  • noAvailableInstances: Amazon GameLift Streams does not currently have enough available on-demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

" } }, "LastUpdatedAt": { diff --git a/codegen/sdk/aws-models/geo-maps.json b/codegen/sdk/aws-models/geo-maps.json index 7340e8b9143..2be30a77f6b 100644 --- a/codegen/sdk/aws-models/geo-maps.json +++ b/codegen/sdk/aws-models/geo-maps.json @@ -13,7 +13,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request was denied because of insufficient access or permissions. Check with an\n administrator to verify your permissions.

", + "smithy.api#documentation": "

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -51,7 +51,8 @@ "smithy.api#length": { "min": 1, "max": 7000 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.geomaps#CountryCode": { @@ -61,7 +62,8 @@ "min": 2, "max": 3 }, - "smithy.api#pattern": "^([A-Z]{2}|[A-Z]{3})$" + "smithy.api#pattern": "^([A-Z]{2}|[A-Z]{3})$", + "smithy.api#sensitive": {} } }, "com.amazonaws.geomaps#DistanceMeters": { @@ -71,7 +73,8 @@ "smithy.api#range": { "min": 0, "max": 4294967295 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.geomaps#GeoJsonOverlay": { @@ -80,7 +83,8 @@ "smithy.api#length": { "min": 1, "max": 7000 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.geomaps#GetGlyphs": { @@ -92,7 +96,7 @@ "target": "com.amazonaws.geomaps#GetGlyphsResponse" }, "traits": { - "smithy.api#documentation": "

\n GetGlyphs returns the map's glyphs.

", + "smithy.api#documentation": "

GetGlyphs returns the map's glyphs.

", "smithy.api#http": { "uri": "/glyphs/{FontStack}/{FontUnicodeRange}", "method": "GET" @@ -122,7 +126,7 @@ "FontStack": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Name of the FontStack to retrieve.

\n

Example: Amazon Ember Bold,Noto Sans Bold.

\n

The supported font stacks are as follows:

\n
    \n
  • \n

    Amazon Ember Bold

    \n
  • \n
  • \n

    Amazon Ember Bold Italic

    \n
  • \n
  • \n

    Amazon Ember Bold,Noto Sans Bold

    \n
  • \n
  • \n

    Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold

    \n
  • \n
  • \n

    Amazon Ember Condensed RC BdItalic

    \n
  • \n
  • \n

    Amazon Ember Condensed RC Bold

    \n
  • \n
  • \n

    Amazon Ember Condensed RC Bold Italic

    \n
  • \n
  • \n

    Amazon Ember Condensed RC Bold,Noto Sans Bold

    \n
  • \n
  • \n

    Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed\n Bold

    \n
  • \n
  • \n

    Amazon Ember Condensed RC Light

    \n
  • \n
  • \n

    Amazon Ember Condensed RC Light Italic

    \n
  • \n
  • \n

    Amazon Ember Condensed RC LtItalic

    \n
  • \n
  • \n

    Amazon Ember Condensed RC Regular

    \n
  • \n
  • \n

    Amazon Ember Condensed RC Regular Italic

    \n
  • \n
  • \n

    Amazon Ember Condensed RC Regular,Noto Sans Regular

    \n
  • \n
  • \n

    Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed\n Regular

    \n
  • \n
  • \n

    Amazon Ember Condensed RC RgItalic

    \n
  • \n
  • \n

    Amazon Ember Condensed RC ThItalic

    \n
  • \n
  • \n

    Amazon Ember Condensed RC Thin

    \n
  • \n
  • \n

    Amazon Ember Condensed RC Thin Italic

    \n
  • \n
  • \n

    Amazon Ember Heavy

    \n
  • \n
  • \n

    Amazon Ember Heavy Italic

    \n
  • \n
  • \n

    Amazon Ember Light

    \n
  • \n
  • \n

    Amazon Ember Light Italic

    \n
  • \n
  • \n

    Amazon Ember Medium

    \n
  • \n
  • \n

    Amazon Ember Medium Italic

    \n
  • \n
  • \n

    Amazon Ember Medium,Noto Sans Medium

    \n
  • \n
  • \n

    Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium

    \n
  • \n
  • \n

    Amazon Ember Regular

    \n
  • \n
  • \n

    Amazon Ember Regular Italic

    \n
  • \n
  • \n

    Amazon Ember Regular Italic,Noto Sans Italic

    \n
  • \n
  • \n

    Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular

    \n
  • \n
  • \n

    Amazon Ember Regular,Noto Sans Regular

    \n
  • \n
  • \n

    Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular

    \n
  • \n
  • \n

    Amazon Ember Thin

    \n
  • \n
  • \n

    Amazon Ember Thin Italic

    \n
  • \n
  • \n

    AmazonEmberCdRC_Bd

    \n
  • \n
  • \n

    AmazonEmberCdRC_BdIt

    \n
  • \n
  • \n

    AmazonEmberCdRC_Lt

    \n
  • \n
  • \n

    AmazonEmberCdRC_LtIt

    \n
  • \n
  • \n

    AmazonEmberCdRC_Rg

    \n
  • \n
  • \n

    AmazonEmberCdRC_RgIt

    \n
  • \n
  • \n

    AmazonEmberCdRC_Th

    \n
  • \n
  • \n

    AmazonEmberCdRC_ThIt

    \n
  • \n
  • \n

    AmazonEmber_Bd

    \n
  • \n
  • \n

    AmazonEmber_BdIt

    \n
  • \n
  • \n

    AmazonEmber_He

    \n
  • \n
  • \n

    AmazonEmber_HeIt

    \n
  • \n
  • \n

    AmazonEmber_Lt

    \n
  • \n
  • \n

    AmazonEmber_LtIt

    \n
  • \n
  • \n

    AmazonEmber_Md

    \n
  • \n
  • \n

    AmazonEmber_MdIt

    \n
  • \n
  • \n

    AmazonEmber_Rg

    \n
  • \n
  • \n

    AmazonEmber_RgIt

    \n
  • \n
  • \n

    AmazonEmber_Th

    \n
  • \n
  • \n

    AmazonEmber_ThIt

    \n
  • \n
  • \n

    Noto Sans Black

    \n
  • \n
  • \n

    Noto Sans Black Italic

    \n
  • \n
  • \n

    Noto Sans Bold

    \n
  • \n
  • \n

    Noto Sans Bold Italic

    \n
  • \n
  • \n

    Noto Sans Extra Bold

    \n
  • \n
  • \n

    Noto Sans Extra Bold Italic

    \n
  • \n
  • \n

    Noto Sans Extra Light

    \n
  • \n
  • \n

    Noto Sans Extra Light Italic

    \n
  • \n
  • \n

    Noto Sans Italic

    \n
  • \n
  • \n

    Noto Sans Light

    \n
  • \n
  • \n

    Noto Sans Light Italic

    \n
  • \n
  • \n

    Noto Sans Medium

    \n
  • \n
  • \n

    Noto Sans Medium Italic

    \n
  • \n
  • \n

    Noto Sans Regular

    \n
  • \n
  • \n

    Noto Sans Semi Bold

    \n
  • \n
  • \n

    Noto Sans Semi Bold Italic

    \n
  • \n
  • \n

    Noto Sans Thin

    \n
  • \n
  • \n

    Noto Sans Thin Italic

    \n
  • \n
  • \n

    NotoSans-Bold

    \n
  • \n
  • \n

    NotoSans-Italic

    \n
  • \n
  • \n

    NotoSans-Medium

    \n
  • \n
  • \n

    NotoSans-Regular

    \n
  • \n
  • \n

    Open Sans Regular,Arial Unicode MS Regular

    \n
  • \n
", + "smithy.api#documentation": "

Name of the FontStack to retrieve.

Example: Amazon Ember Bold,Noto Sans Bold.

The supported font stacks are as follows:

  • Amazon Ember Bold

  • Amazon Ember Bold Italic

  • Amazon Ember Bold,Noto Sans Bold

  • Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold

  • Amazon Ember Condensed RC BdItalic

  • Amazon Ember Condensed RC Bold

  • Amazon Ember Condensed RC Bold Italic

  • Amazon Ember Condensed RC Bold,Noto Sans Bold

  • Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold

  • Amazon Ember Condensed RC Light

  • Amazon Ember Condensed RC Light Italic

  • Amazon Ember Condensed RC LtItalic

  • Amazon Ember Condensed RC Regular

  • Amazon Ember Condensed RC Regular Italic

  • Amazon Ember Condensed RC Regular,Noto Sans Regular

  • Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular

  • Amazon Ember Condensed RC RgItalic

  • Amazon Ember Condensed RC ThItalic

  • Amazon Ember Condensed RC Thin

  • Amazon Ember Condensed RC Thin Italic

  • Amazon Ember Heavy

  • Amazon Ember Heavy Italic

  • Amazon Ember Light

  • Amazon Ember Light Italic

  • Amazon Ember Medium

  • Amazon Ember Medium Italic

  • Amazon Ember Medium,Noto Sans Medium

  • Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium

  • Amazon Ember Regular

  • Amazon Ember Regular Italic

  • Amazon Ember Regular Italic,Noto Sans Italic

  • Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular

  • Amazon Ember Regular,Noto Sans Regular

  • Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular

  • Amazon Ember Thin

  • Amazon Ember Thin Italic

  • AmazonEmberCdRC_Bd

  • AmazonEmberCdRC_BdIt

  • AmazonEmberCdRC_Lt

  • AmazonEmberCdRC_LtIt

  • AmazonEmberCdRC_Rg

  • AmazonEmberCdRC_RgIt

  • AmazonEmberCdRC_Th

  • AmazonEmberCdRC_ThIt

  • AmazonEmber_Bd

  • AmazonEmber_BdIt

  • AmazonEmber_He

  • AmazonEmber_HeIt

  • AmazonEmber_Lt

  • AmazonEmber_LtIt

  • AmazonEmber_Md

  • AmazonEmber_MdIt

  • AmazonEmber_Rg

  • AmazonEmber_RgIt

  • AmazonEmber_Th

  • AmazonEmber_ThIt

  • Noto Sans Black

  • Noto Sans Black Italic

  • Noto Sans Bold

  • Noto Sans Bold Italic

  • Noto Sans Extra Bold

  • Noto Sans Extra Bold Italic

  • Noto Sans Extra Light

  • Noto Sans Extra Light Italic

  • Noto Sans Italic

  • Noto Sans Light

  • Noto Sans Light Italic

  • Noto Sans Medium

  • Noto Sans Medium Italic

  • Noto Sans Regular

  • Noto Sans Semi Bold

  • Noto Sans Semi Bold Italic

  • Noto Sans Thin

  • Noto Sans Thin Italic

  • NotoSans-Bold

  • NotoSans-Italic

  • NotoSans-Medium

  • NotoSans-Regular

  • Open Sans Regular,Arial Unicode MS Regular

", "smithy.api#httpLabel": {}, "smithy.api#length": { "max": 1000 @@ -133,7 +137,7 @@ "FontUnicodeRange": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A Unicode range of characters to download glyphs for. This must be aligned to multiples\n of 256.

\n

Example: 0-255.pdf\n

", + "smithy.api#documentation": "

A Unicode range of characters to download glyphs for. This must be aligned to multiples of 256.

Example: 0-255.pdf

", "smithy.api#httpLabel": {}, "smithy.api#pattern": "^[0-9]+-[0-9]+\\.pbf$", "smithy.api#required": {} @@ -157,7 +161,7 @@ "ContentType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Header that represents the format of the response. The response returns the following as\n the HTTP body.

", + "smithy.api#documentation": "

Header that represents the format of the response. The response returns the following as the HTTP body.

", "smithy.api#httpHeader": "Content-Type" } }, @@ -189,7 +193,7 @@ "target": "com.amazonaws.geomaps#GetSpritesResponse" }, "traits": { - "smithy.api#documentation": "

\n GetSprites returns the map's sprites.

", + "smithy.api#documentation": "

GetSprites returns the map's sprites.

", "smithy.api#http": { "uri": "/styles/{Style}/{ColorScheme}/{Variant}/sprites/{FileName}", "method": "GET" @@ -221,7 +225,7 @@ "FileName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\n Sprites API: The name of the sprite file to retrieve, following pattern\n sprites(@2x)?\\.(png|json).

\n

Example: sprites.png\n

", + "smithy.api#documentation": "

Sprites API: The name of the sprite file to retrieve, following pattern sprites(@2x)?\\.(png|json).

Example: sprites.png

", "smithy.api#httpLabel": {}, "smithy.api#pattern": "^sprites(@2x)?\\.(png|json)$", "smithy.api#required": {} @@ -238,7 +242,7 @@ "ColorScheme": { "target": "com.amazonaws.geomaps#ColorScheme", "traits": { - "smithy.api#documentation": "

Sets color tone for map such as dark and light for specific map styles. It applies to\n only vector map styles such as Standard and Monochrome.

\n

Example: Light\n

\n

Default value: Light\n

\n \n

Valid values for ColorScheme are case sensitive.

\n
", + "smithy.api#documentation": "

Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.

Example: Light

Default value: Light

Valid values for ColorScheme are case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -246,7 +250,7 @@ "Variant": { "target": "com.amazonaws.geomaps#Variant", "traits": { - "smithy.api#documentation": "

Optimizes map styles for specific use case or industry. You can choose allowed variant\n only with Standard map style.

\n

Example: Default\n

\n \n

Valid values for Variant are case sensitive.

\n
", + "smithy.api#documentation": "

Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.

Example: Default

Valid values for Variant are case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -262,14 +266,14 @@ "Blob": { "target": "smithy.api#Blob", "traits": { - "smithy.api#documentation": "

The body of the sprite sheet or JSON offset file (image/png or application/json,\n depending on input).

", + "smithy.api#documentation": "

The body of the sprite sheet or JSON offset file (image/png or application/json, depending on input).

", "smithy.api#httpPayload": {} } }, "ContentType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Header that represents the format of the response. The response returns the following as\n the HTTP body.

", + "smithy.api#documentation": "

Header that represents the format of the response. The response returns the following as the HTTP body.

", "smithy.api#httpHeader": "Content-Type" } }, @@ -316,7 +320,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

\n GetStaticMap provides high-quality static map images with customizable\n options. You can modify the map's appearance and overlay additional information. It's an\n ideal solution for applications requiring tailored static map snapshots.

", + "smithy.api#documentation": "

GetStaticMap provides high-quality static map images with customizable options. You can modify the map's appearance and overlay additional information. It's an ideal solution for applications requiring tailored static map snapshots.

", "smithy.api#http": { "uri": "/static/{FileName}", "method": "GET" @@ -350,54 +354,54 @@ "BoundingBox": { "target": "com.amazonaws.geomaps#PositionListString", "traits": { - "smithy.api#documentation": "

Takes in two pairs of coordinates, [Lon, Lat], denoting south-westerly and\n north-easterly edges of the image. The underlying area becomes the view of the image.

\n

Example: -123.17075,49.26959,-123.08125,49.31429

", + "smithy.api#documentation": "

Takes in two pairs of coordinates, [Lon, Lat], denoting south-westerly and north-easterly edges of the image. The underlying area becomes the view of the image.

Example: -123.17075,49.26959,-123.08125,49.31429

", "smithy.api#httpQuery": "bounding-box" } }, "BoundedPositions": { "target": "com.amazonaws.geomaps#PositionListString", "traits": { - "smithy.api#documentation": "

Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate separated by\n a comma. The API will generate an image to encompass all of the provided coordinates.

\n \n

Cannot be used with Zoom and or Radius\n

\n
\n

Example: 97.170451,78.039098,99.045536,27.176178

", + "smithy.api#documentation": "

Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate separated by a comma. The API will generate an image to encompass all of the provided coordinates.

Cannot be used with Zoom and or Radius

Example: 97.170451,78.039098,99.045536,27.176178

", "smithy.api#httpQuery": "bounded-positions" } }, "Center": { "target": "com.amazonaws.geomaps#PositionString", "traits": { - "smithy.api#documentation": "

Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image.\n This parameter requires that either zoom or radius is set.

\n \n

Cannot be used with Zoom and or Radius\n

\n
\n

Example: 49.295,-123.108

", + "smithy.api#documentation": "

Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image. This parameter requires that either zoom or radius is set.

Cannot be used with Zoom and or Radius

Example: 49.295,-123.108

", "smithy.api#httpQuery": "center" } }, "ColorScheme": { "target": "com.amazonaws.geomaps#ColorScheme", "traits": { - "smithy.api#documentation": "

Sets color tone for map, such as dark and light for specific map styles. It only applies to vector map styles, such as Standard.

\n

Example: Light\n

\n

Default value: Light\n

\n \n

Valid values for ColorScheme are case sensitive.

\n
", + "smithy.api#documentation": "

Sets color tone for map, such as dark and light for specific map styles. It only applies to vector map styles, such as Standard.

Example: Light

Default value: Light

Valid values for ColorScheme are case sensitive.

", "smithy.api#httpQuery": "color-scheme" } }, "CompactOverlay": { "target": "com.amazonaws.geomaps#CompactOverlay", "traits": { - "smithy.api#documentation": "

Takes in a string to draw geometries on the image. The input is a comma separated format\n as follows format: [Lon, Lat]\n

\n

Example:\n line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog\n Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B\n

\n \n

Currently it supports the following geometry types: point, line and polygon. It does\n not support multiPoint , multiLine and multiPolgyon.

\n
", + "smithy.api#documentation": "

Takes in a string to draw geometries on the image. The input is a comma separated format as follows format: [Lon, Lat]

Example: line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B

Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.

", "smithy.api#httpQuery": "compact-overlay" } }, "CropLabels": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

It is a flag that takes in true or false. It prevents the labels that are on the edge of\n the image from being cut or obscured.

", + "smithy.api#documentation": "

It is a flag that takes in true or false. It prevents the labels that are on the edge of the image from being cut or obscured.

", "smithy.api#httpQuery": "crop-labels" } }, "GeoJsonOverlay": { "target": "com.amazonaws.geomaps#GeoJsonOverlay", "traits": { - "smithy.api#documentation": "

Takes in a string to draw geometries on the image. The input is a valid GeoJSON\n collection object.

\n

Example: {\"type\":\"FeatureCollection\",\"features\":\n [{\"type\":\"Feature\",\"geometry\":{\"type\":\"MultiPoint\",\"coordinates\":\n [[-90.076345,51.504107],[-0.074451,51.506892]]},\"properties\":\n {\"color\":\"#00DD00\"}}]}\n

", + "smithy.api#documentation": "

Takes in a string to draw geometries on the image. The input is a valid GeoJSON collection object.

Example: {\"type\":\"FeatureCollection\",\"features\": [{\"type\":\"Feature\",\"geometry\":{\"type\":\"MultiPoint\",\"coordinates\": [[-90.076345,51.504107],[-0.074451,51.506892]]},\"properties\": {\"color\":\"#00DD00\"}}]}

", "smithy.api#httpQuery": "geojson-overlay" } }, "Height": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.geomaps#SensitiveInteger", "traits": { "smithy.api#documentation": "

Specifies the height of the map image.

", "smithy.api#httpQuery": "height", @@ -411,35 +415,35 @@ "Key": { "target": "com.amazonaws.geomaps#ApiKey", "traits": { - "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.

", + "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", "smithy.api#httpQuery": "key" } }, "LabelSize": { "target": "com.amazonaws.geomaps#LabelSize", "traits": { - "smithy.api#documentation": "

Overrides the label size auto-calculated by FileName. Takes in one of the\n values - Small or Large.

", + "smithy.api#documentation": "

Overrides the label size auto-calculated by FileName. Takes in one of the values - Small or Large.

", "smithy.api#httpQuery": "label-size" } }, "Language": { "target": "com.amazonaws.geomaps#LanguageTag", "traits": { - "smithy.api#documentation": "

Specifies the language on the map labels using the BCP 47 language tag, limited to ISO\n 639-1 two-letter language codes. If the specified language data isn't available for the map\n image, the labels will default to the regional primary language.

\n

Supported codes:

\n
    \n
  • \n

    \n ar\n

    \n
  • \n
  • \n

    \n as\n

    \n
  • \n
  • \n

    \n az\n

    \n
  • \n
  • \n

    \n be\n

    \n
  • \n
  • \n

    \n bg\n

    \n
  • \n
  • \n

    \n bn\n

    \n
  • \n
  • \n

    \n bs\n

    \n
  • \n
  • \n

    \n ca\n

    \n
  • \n
  • \n

    \n cs\n

    \n
  • \n
  • \n

    \n cy\n

    \n
  • \n
  • \n

    \n da\n

    \n
  • \n
  • \n

    \n de\n

    \n
  • \n
  • \n

    \n el\n

    \n
  • \n
  • \n

    \n en\n

    \n
  • \n
  • \n

    \n es\n

    \n
  • \n
  • \n

    \n et\n

    \n
  • \n
  • \n

    \n eu\n

    \n
  • \n
  • \n

    \n fi\n

    \n
  • \n
  • \n

    \n fo\n

    \n
  • \n
  • \n

    \n fr\n

    \n
  • \n
  • \n

    \n ga\n

    \n
  • \n
  • \n

    \n gl\n

    \n
  • \n
  • \n

    \n gn\n

    \n
  • \n
  • \n

    \n gu\n

    \n
  • \n
  • \n

    \n he\n

    \n
  • \n
  • \n

    \n hi\n

    \n
  • \n
  • \n

    \n hr\n

    \n
  • \n
  • \n

    \n hu\n

    \n
  • \n
  • \n

    \n hy\n

    \n
  • \n
  • \n

    \n id\n

    \n
  • \n
  • \n

    \n is\n

    \n
  • \n
  • \n

    \n it\n

    \n
  • \n
  • \n

    \n ja\n

    \n
  • \n
  • \n

    \n ka\n

    \n
  • \n
  • \n

    \n kk\n

    \n
  • \n
  • \n

    \n km\n

    \n
  • \n
  • \n

    \n kn\n

    \n
  • \n
  • \n

    \n ko\n

    \n
  • \n
  • \n

    \n ky\n

    \n
  • \n
  • \n

    \n lt\n

    \n
  • \n
  • \n

    \n lv\n

    \n
  • \n
  • \n

    \n mk\n

    \n
  • \n
  • \n

    \n ml\n

    \n
  • \n
  • \n

    \n mr\n

    \n
  • \n
  • \n

    \n ms\n

    \n
  • \n
  • \n

    \n mt\n

    \n
  • \n
  • \n

    \n my\n

    \n
  • \n
  • \n

    \n nl\n

    \n
  • \n
  • \n

    \n no\n

    \n
  • \n
  • \n

    \n or\n

    \n
  • \n
  • \n

    \n pa\n

    \n
  • \n
  • \n

    \n pl\n

    \n
  • \n
  • \n

    \n pt\n

    \n
  • \n
  • \n

    \n ro\n

    \n
  • \n
  • \n

    \n ru\n

    \n
  • \n
  • \n

    \n sk\n

    \n
  • \n
  • \n

    \n sl\n

    \n
  • \n
  • \n

    \n sq\n

    \n
  • \n
  • \n

    \n sr\n

    \n
  • \n
  • \n

    \n sv\n

    \n
  • \n
  • \n

    \n ta\n

    \n
  • \n
  • \n

    \n te\n

    \n
  • \n
  • \n

    \n th\n

    \n
  • \n
  • \n

    \n tr\n

    \n
  • \n
  • \n

    \n uk\n

    \n
  • \n
  • \n

    \n uz\n

    \n
  • \n
  • \n

    \n vi\n

    \n
  • \n
  • \n

    \n zh\n

    \n
  • \n
", + "smithy.api#documentation": "

Specifies the language on the map labels using the BCP 47 language tag, limited to ISO 639-1 two-letter language codes. If the specified language data isn't available for the map image, the labels will default to the regional primary language.

Supported codes:

  • ar

  • as

  • az

  • be

  • bg

  • bn

  • bs

  • ca

  • cs

  • cy

  • da

  • de

  • el

  • en

  • es

  • et

  • eu

  • fi

  • fo

  • fr

  • ga

  • gl

  • gn

  • gu

  • he

  • hi

  • hr

  • hu

  • hy

  • id

  • is

  • it

  • ja

  • ka

  • kk

  • km

  • kn

  • ko

  • ky

  • lt

  • lv

  • mk

  • ml

  • mr

  • ms

  • mt

  • my

  • nl

  • no

  • or

  • pa

  • pl

  • pt

  • ro

  • ru

  • sk

  • sl

  • sq

  • sr

  • sv

  • ta

  • te

  • th

  • tr

  • uk

  • uz

  • vi

  • zh

", "smithy.api#httpQuery": "lang" } }, "Padding": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.geomaps#SensitiveInteger", "traits": { - "smithy.api#documentation": "

Applies additional space (in pixels) around overlay feature to prevent them from being\n cut or obscured.

\n \n

Value for max and min is determined by:

\n

Min: 1\n

\n

Max: min(height, width)/4\n

\n
\n

Example: 100\n

", + "smithy.api#documentation": "

Applies additional space (in pixels) around overlay feature to prevent them from being cut or obscured.

Value for max and min is determined by:

Min: 1

Max: min(height, width)/4

Example: 100

", "smithy.api#httpQuery": "padding" } }, "PoliticalView": { "target": "com.amazonaws.geomaps#CountryCode", "traits": { - "smithy.api#documentation": "

Specifies the political view, using ISO 3166-2 or ISO 3166-3 country code format.

\n

The following political views are currently supported:

\n
    \n
  • \n

    \n ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra\n Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich\n Islands

    \n
  • \n
  • \n

    \n EGY: Egypt's view on Bir Tawil

    \n
  • \n
  • \n

    \n IND: India's view on Gilgit-Baltistan

    \n
  • \n
  • \n

    \n KEN: Kenya's view on the Ilemi Triangle

    \n
  • \n
  • \n

    \n MAR: Morocco's view on Western Sahara

    \n
  • \n
  • \n

    \n RUS: Russia's view on Crimea

    \n
  • \n
  • \n

    \n SDN: Sudan's view on the Halaib Triangle

    \n
  • \n
  • \n

    \n SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands

    \n
  • \n
  • \n

    \n SUR: Suriname's view on the Courantyne Headwaters and Lawa\n Headwaters

    \n
  • \n
  • \n

    \n SYR: Syria's view on the Golan Heights

    \n
  • \n
  • \n

    \n TUR: Turkey's view on Cyprus and Northern Cyprus

    \n
  • \n
  • \n

    \n TZA: Tanzania's view on Lake Malawi

    \n
  • \n
  • \n

    \n URY: Uruguay's view on Rincon de Artigas

    \n
  • \n
  • \n

    \n VNM: Vietnam's view on the Paracel Islands and Spratly Islands

    \n
  • \n
", + "smithy.api#documentation": "

Specifies the political view, using ISO 3166-2 or ISO 3166-3 country code format.

The following political views are currently supported:

  • ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands

  • EGY: Egypt's view on Bir Tawil

  • IND: India's view on Gilgit-Baltistan

  • KEN: Kenya's view on the Ilemi Triangle

  • MAR: Morocco's view on Western Sahara

  • RUS: Russia's view on Crimea

  • SDN: Sudan's view on the Halaib Triangle

  • SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands

  • SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters

  • SYR: Syria's view on the Golan Heights

  • TUR: Turkey's view on Cyprus and Northern Cyprus

  • TZA: Tanzania's view on Lake Malawi

  • URY: Uruguay's view on Rincon de Artigas

  • VNM: Vietnam's view on the Paracel Islands and Spratly Islands

", "smithy.api#httpQuery": "political-view" } }, @@ -454,14 +458,14 @@ "target": "com.amazonaws.geomaps#DistanceMeters", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Used with center parameter, it specifies the zoom of the image where you can control it\n on a granular level. Takes in any value >= 1.

\n

Example: 1500\n

\n \n

Cannot be used with Zoom.

\n
\n

\n Unit: Meters\n

\n

", + "smithy.api#documentation": "

Used with center parameter, it specifies the zoom of the image where you can control it on a granular level. Takes in any value >= 1.

Example: 1500

Cannot be used with Zoom.

Unit: Meters

", "smithy.api#httpQuery": "radius" } }, "FileName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The map scaling parameter to size the image, icons, and labels. It follows the pattern\n of ^map(@2x)?$.

\n

Example: map, map@2x\n

", + "smithy.api#documentation": "

The map scaling parameter to size the image, icons, and labels. It follows the pattern of ^map(@2x)?$.

Example: map, map@2x

", "smithy.api#httpLabel": {}, "smithy.api#pattern": "^map(@2x)?$", "smithy.api#required": {} @@ -470,19 +474,19 @@ "ScaleBarUnit": { "target": "com.amazonaws.geomaps#ScaleBarUnit", "traits": { - "smithy.api#documentation": "

Displays a scale on the bottom right of the map image with the unit specified in the\n input.

\n

Example: KilometersMiles, Miles, Kilometers, MilesKilometers\n

", + "smithy.api#documentation": "

Displays a scale on the bottom right of the map image with the unit specified in the input.

Example: KilometersMiles, Miles, Kilometers, MilesKilometers

", "smithy.api#httpQuery": "scale-unit" } }, "Style": { "target": "com.amazonaws.geomaps#StaticMapStyle", "traits": { - "smithy.api#documentation": "

\n Style specifies the desired map style.

", + "smithy.api#documentation": "

Style specifies the desired map style.

", "smithy.api#httpQuery": "style" } }, "Width": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.geomaps#SensitiveInteger", "traits": { "smithy.api#documentation": "

Specifies the width of the map image.

", "smithy.api#httpQuery": "width", @@ -494,10 +498,10 @@ } }, "Zoom": { - "target": "smithy.api#Float", + "target": "com.amazonaws.geomaps#SensitiveFloat", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Specifies the zoom level of the map image.

\n \n

Cannot be used with Radius.

\n
", + "smithy.api#documentation": "

Specifies the zoom level of the map image.

Cannot be used with Radius.

", "smithy.api#httpQuery": "zoom", "smithy.api#range": { "min": 0, @@ -516,14 +520,14 @@ "Blob": { "target": "smithy.api#Blob", "traits": { - "smithy.api#documentation": "

The blob represents a map image as a jpeg for the GetStaticMap\n API.

", + "smithy.api#documentation": "

The blob represents a map image as a jpeg for the GetStaticMap API.

", "smithy.api#httpPayload": {} } }, "ContentType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Header that represents the format of the response. The response returns the following as\n the HTTP body.

", + "smithy.api#documentation": "

Header that represents the format of the response. The response returns the following as the HTTP body.

", "smithy.api#httpHeader": "Content-Type" } }, @@ -563,7 +567,7 @@ "target": "com.amazonaws.geomaps#GetStyleDescriptorResponse" }, "traits": { - "smithy.api#documentation": "

\n GetStyleDescriptor returns information about the style.

", + "smithy.api#documentation": "

GetStyleDescriptor returns information about the style.

", "smithy.api#http": { "uri": "/styles/{Style}/descriptor", "method": "GET" @@ -600,21 +604,21 @@ "ColorScheme": { "target": "com.amazonaws.geomaps#ColorScheme", "traits": { - "smithy.api#documentation": "

Sets color tone for map such as dark and light for specific map styles. It applies to\n only vector map styles such as Standard and Monochrome.

\n

Example: Light\n

\n

Default value: Light\n

\n \n

Valid values for ColorScheme are case sensitive.

\n
", + "smithy.api#documentation": "

Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.

Example: Light

Default value: Light

Valid values for ColorScheme are case sensitive.

", "smithy.api#httpQuery": "color-scheme" } }, "PoliticalView": { "target": "com.amazonaws.geomaps#CountryCode", "traits": { - "smithy.api#documentation": "

Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.

\n

The following political views are currently supported:

\n
    \n
  • \n

    \n ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra\n Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich\n Islands

    \n
  • \n
  • \n

    \n EGY: Egypt's view on Bir Tawil

    \n
  • \n
  • \n

    \n IND: India's view on Gilgit-Baltistan

    \n
  • \n
  • \n

    \n KEN: Kenya's view on the Ilemi Triangle

    \n
  • \n
  • \n

    \n MAR: Morocco's view on Western Sahara

    \n
  • \n
  • \n

    \n RUS: Russia's view on Crimea

    \n
  • \n
  • \n

    \n SDN: Sudan's view on the Halaib Triangle

    \n
  • \n
  • \n

    \n SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands

    \n
  • \n
  • \n

    \n SUR: Suriname's view on the Courantyne Headwaters and Lawa\n Headwaters

    \n
  • \n
  • \n

    \n SYR: Syria's view on the Golan Heights

    \n
  • \n
  • \n

    \n TUR: Turkey's view on Cyprus and Northern Cyprus

    \n
  • \n
  • \n

    \n TZA: Tanzania's view on Lake Malawi

    \n
  • \n
  • \n

    \n URY: Uruguay's view on Rincon de Artigas

    \n
  • \n
  • \n

    \n VNM: Vietnam's view on the Paracel Islands and Spratly Islands

    \n
  • \n
", + "smithy.api#documentation": "

Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.

The following political views are currently supported:

  • ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands

  • EGY: Egypt's view on Bir Tawil

  • IND: India's view on Gilgit-Baltistan

  • KEN: Kenya's view on the Ilemi Triangle

  • MAR: Morocco's view on Western Sahara

  • RUS: Russia's view on Crimea

  • SDN: Sudan's view on the Halaib Triangle

  • SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands

  • SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters

  • SYR: Syria's view on the Golan Heights

  • TUR: Turkey's view on Cyprus and Northern Cyprus

  • TZA: Tanzania's view on Lake Malawi

  • URY: Uruguay's view on Rincon de Artigas

  • VNM: Vietnam's view on the Paracel Islands and Spratly Islands

", "smithy.api#httpQuery": "political-view" } }, "Key": { "target": "com.amazonaws.geomaps#ApiKey", "traits": { - "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.

", + "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", "smithy.api#httpQuery": "key" } } @@ -629,14 +633,14 @@ "Blob": { "target": "smithy.api#Blob", "traits": { - "smithy.api#documentation": "

This Blob contains the body of the style descriptor which is in application/json\n format.

", + "smithy.api#documentation": "

This Blob contains the body of the style descriptor which is in application/json format.

", "smithy.api#httpPayload": {} } }, "ContentType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Header that represents the format of the response. The response returns the following as\n the HTTP body.

", + "smithy.api#documentation": "

Header that represents the format of the response. The response returns the following as the HTTP body.

", "smithy.api#httpHeader": "Content-Type" } }, @@ -674,6 +678,9 @@ { "target": "com.amazonaws.geomaps#InternalServerException" }, + { + "target": "com.amazonaws.geomaps#ResourceNotFoundException" + }, { "target": "com.amazonaws.geomaps#ThrottlingException" }, @@ -683,7 +690,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

\n GetTile returns a tile. Map tiles are used by clients to render a map.\n they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom)\n level.

", + "smithy.api#documentation": "

GetTile returns a tile. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.

", "smithy.api#http": { "uri": "/tiles/{Tileset}/{Z}/{X}/{Y}", "method": "GET" @@ -715,13 +722,13 @@ "Tileset": { "target": "com.amazonaws.geomaps#Tileset", "traits": { - "smithy.api#documentation": "

Specifies the desired tile set.

\n

Valid Values: raster.satellite | vector.basemap\n

", + "smithy.api#documentation": "

Specifies the desired tile set.

Valid Values: raster.satellite | vector.basemap

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Z": { - "target": "smithy.api#String", + "target": "com.amazonaws.geomaps#SensitiveString", "traits": { "smithy.api#documentation": "

The zoom value for the map tile.

", "smithy.api#httpLabel": {}, @@ -730,7 +737,7 @@ } }, "X": { - "target": "smithy.api#String", + "target": "com.amazonaws.geomaps#SensitiveString", "traits": { "smithy.api#documentation": "

The X axis value for the map tile. Must be between 0 and 19.

", "smithy.api#httpLabel": {}, @@ -739,7 +746,7 @@ } }, "Y": { - "target": "smithy.api#String", + "target": "com.amazonaws.geomaps#SensitiveString", "traits": { "smithy.api#documentation": "

The Y axis value for the map tile.

", "smithy.api#httpLabel": {}, @@ -750,7 +757,7 @@ "Key": { "target": "com.amazonaws.geomaps#ApiKey", "traits": { - "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.

", + "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", "smithy.api#httpQuery": "key" } } @@ -765,14 +772,14 @@ "Blob": { "target": "smithy.api#Blob", "traits": { - "smithy.api#documentation": "

The blob represents a vector tile in mvt or a raster tile in an image\n format.

", + "smithy.api#documentation": "

The blob represents a vector tile in mvt or a raster tile in an image format.

", "smithy.api#httpPayload": {} } }, "ContentType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Header that represents the format of the response. The response returns the following as\n the HTTP body.

", + "smithy.api#documentation": "

Header that represents the format of the response. The response returns the following as the HTTP body.

", "smithy.api#httpHeader": "Content-Type" } }, @@ -815,7 +822,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception or\n failure.

", + "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception or failure.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} @@ -962,7 +969,7 @@ "x-cache" ] }, - "smithy.api#documentation": "

Integrate high-quality base map data into your applications using MapLibre. Capabilities include:

\n
    \n
  • \n

    Access to comprehensive base map data, allowing you to tailor the map display to\n your specific needs.

    \n
  • \n
  • \n

    Multiple pre-designed map styles suited for various application types, such as\n navigation, logistics, or data visualization.

    \n
  • \n
  • \n

    Generation of static map images for scenarios where interactive maps aren't\n suitable, such as:

    \n
      \n
    • \n

      Embedding in emails or documents

      \n
    • \n
    • \n

      Displaying in low-bandwidth environments

      \n
    • \n
    • \n

      Creating printable maps

      \n
    • \n
    • \n

      Enhancing application performance by reducing client-side rendering

      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

Integrate high-quality base map data into your applications using MapLibre. Capabilities include:

  • Access to comprehensive base map data, allowing you to tailor the map display to your specific needs.

  • Multiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization.

  • Generation of static map images for scenarios where interactive maps aren't suitable, such as:

    • Embedding in emails or documents

    • Displaying in low-bandwidth environments

    • Creating printable maps

    • Enhancing application performance by reducing client-side rendering

", "smithy.api#title": "Amazon Location Service Maps V2", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1843,17 +1850,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1867,17 +1863,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1891,17 +1876,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1915,17 +1889,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1939,17 +1902,6 @@ "UseDualStack": false } }, - { - "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": { @@ -1963,17 +1915,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1988,49 +1929,53 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://geo-maps-fips.us-isof-south-1.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://geo-maps-fips.us-isof-south-1.csp.hci.ic.gov" + "url": "https://geo-maps.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://geo-maps-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://geo-maps.us-isof-south-1.csp.hci.ic.gov" + "url": "https://geo-maps.eusc-de-east-1.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } @@ -2052,7 +1997,8 @@ "smithy.api#length": { "min": 7 }, - "smithy.api#pattern": "^(-?\\d{1,3}(\\.\\d{1,14})?,-?\\d{1,2}(\\.\\d{1,14})?)(,(-?\\d{1,3}(\\.\\d{1,14})?,-?\\d{1,2}(\\.\\d{1,14})?))*$" + "smithy.api#pattern": "^(-?\\d{1,3}(\\.\\d{1,14})?,-?\\d{1,2}(\\.\\d{1,14})?)(,(-?\\d{1,3}(\\.\\d{1,14})?,-?\\d{1,2}(\\.\\d{1,14})?))*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.geomaps#PositionString": { @@ -2062,7 +2008,8 @@ "min": 3, "max": 36 }, - "smithy.api#pattern": "^-?\\d{1,3}(\\.\\d{1,14})?,-?\\d{1,2}(\\.\\d{1,14})?$" + "smithy.api#pattern": "^-?\\d{1,3}(\\.\\d{1,14})?,-?\\d{1,2}(\\.\\d{1,14})?$", + "smithy.api#sensitive": {} } }, "com.amazonaws.geomaps#ProviderResource": { @@ -2085,6 +2032,23 @@ } ] }, + "com.amazonaws.geomaps#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Exception thrown when the associated resource could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.geomaps#ScaleBarUnit": { "type": "string", "traits": { @@ -2108,6 +2072,24 @@ ] } }, + "com.amazonaws.geomaps#SensitiveFloat": { + "type": "float", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.geomaps#SensitiveInteger": { + "type": "integer", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.geomaps#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.geomaps#StaticMapStyle": { "type": "string", "traits": { @@ -2205,7 +2187,7 @@ } }, "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by the Amazon Location\n service.

" + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by the Amazon Location service.

" } }, "com.amazonaws.geomaps#ValidationExceptionFieldList": { diff --git a/codegen/sdk/aws-models/geo-places.json b/codegen/sdk/aws-models/geo-places.json index 14806bcab87..4e0751610e4 100644 --- a/codegen/sdk/aws-models/geo-places.json +++ b/codegen/sdk/aws-models/geo-places.json @@ -3736,17 +3736,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3760,17 +3749,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3784,17 +3762,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3808,17 +3775,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3832,17 +3788,6 @@ "UseDualStack": false } }, - { - "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": { @@ -3856,17 +3801,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3881,49 +3815,53 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://geo-places-fips.us-isof-south-1.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://geo-places-fips.us-isof-south-1.csp.hci.ic.gov" + "url": "https://geo-places.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://geo-places-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://geo-places.us-isof-south-1.csp.hci.ic.gov" + "url": "https://geo-places.eusc-de-east-1.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } diff --git a/codegen/sdk/aws-models/geo-routes.json b/codegen/sdk/aws-models/geo-routes.json index 54445b7382f..79a93431947 100644 --- a/codegen/sdk/aws-models/geo-routes.json +++ b/codegen/sdk/aws-models/geo-routes.json @@ -76,7 +76,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Use the CalculateIsolines action to find service areas that can be reached\n in a given threshold of time, distance.

", + "smithy.api#documentation": "

Use the CalculateIsolines action to find service areas that can be reached in a given threshold of time, distance.

", "smithy.api#http": { "uri": "/isolines", "method": "POST" @@ -119,17 +119,17 @@ "ArrivalTime": { "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", "traits": { - "smithy.api#documentation": "

Time of arrival at the destination.

\n

Time format: YYYY-MM-DDThh:mm:ss.sssZ |\n YYYY-MM-DDThh:mm:ss.sss+hh:mm\n

\n

Examples:

\n

\n 2020-04-22T17:57:24Z\n

\n

\n 2020-04-22T17:57:24+02:00\n

" + "smithy.api#documentation": "

Time of arrival at the destination.

Time format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" } }, "Avoid": { "target": "com.amazonaws.georoutes#IsolineAvoidanceOptions", "traits": { - "smithy.api#documentation": "

Features that are avoided while calculating a route. Avoidance is on a best-case basis.\n If an avoidance can't be satisfied for a particular case, it violates the avoidance and the\n returned response produces a notice for the violation.

" + "smithy.api#documentation": "

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

" } }, "DepartNow": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Uses the current time as the time of departure.

" } @@ -137,13 +137,13 @@ "DepartureTime": { "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", "traits": { - "smithy.api#documentation": "

Time of departure from thr origin.

\n

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n

\n

Examples:

\n

\n 2020-04-22T17:57:24Z\n

\n

\n 2020-04-22T17:57:24+02:00\n

" + "smithy.api#documentation": "

Time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" } }, "Destination": { "target": "com.amazonaws.georoutes#Position", "traits": { - "smithy.api#documentation": "

The final position for the route. In the World Geodetic System (WGS 84) format:\n [longitude, latitude].

" + "smithy.api#documentation": "

The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].

" } }, "DestinationOptions": { @@ -155,7 +155,7 @@ "IsolineGeometryFormat": { "target": "com.amazonaws.georoutes#GeometryFormat", "traits": { - "smithy.api#documentation": "

The format of the returned IsolineGeometry.

\n

Default Value:FlexiblePolyline\n

" + "smithy.api#documentation": "

The format of the returned IsolineGeometry.

Default Value:FlexiblePolyline

" } }, "IsolineGranularity": { @@ -167,20 +167,20 @@ "Key": { "target": "com.amazonaws.georoutes#ApiKey", "traits": { - "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.

", + "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", "smithy.api#httpQuery": "key" } }, "OptimizeIsolineFor": { "target": "com.amazonaws.georoutes#IsolineOptimizationObjective", "traits": { - "smithy.api#documentation": "

Specifies the optimization criteria for when calculating an isoline. AccurateCalculation\n generates an isoline of higher granularity that is more precise. FastCalculation generates\n an isoline faster by reducing the granularity, and in turn the quality of the isoline.\n BalancedCalculation generates an isoline by balancing between quality and performance.

\n

Default Value: BalancedCalculation\n

" + "smithy.api#documentation": "

Specifies the optimization criteria for when calculating an isoline. AccurateCalculation generates an isoline of higher granularity that is more precise. FastCalculation generates an isoline faster by reducing the granularity, and in turn the quality of the isoline. BalancedCalculation generates an isoline by balancing between quality and performance.

Default Value: BalancedCalculation

" } }, "OptimizeRoutingFor": { "target": "com.amazonaws.georoutes#RoutingObjective", "traits": { - "smithy.api#documentation": "

Specifies the optimization criteria for calculating a route.

\n

Default Value: FastestRoute\n

" + "smithy.api#documentation": "

Specifies the optimization criteria for calculating a route.

Default Value: FastestRoute

" } }, "Origin": { @@ -198,7 +198,7 @@ "Thresholds": { "target": "com.amazonaws.georoutes#IsolineThresholds", "traits": { - "smithy.api#documentation": "

Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type\n can be requested.

\n

You incur a calculation charge for each threshold. Using a large amount of thresholds in a\n request can lead you to incur unexpected charges. See\n \n Amazon Location's pricing page for more information.

", + "smithy.api#documentation": "

Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type can be requested.

You incur a calculation charge for each threshold. Using a large amount of thresholds in a request can lead you to incur unexpected charges. See Amazon Location's pricing page for more information.

", "smithy.api#required": {} } }, @@ -211,7 +211,7 @@ "TravelMode": { "target": "com.amazonaws.georoutes#IsolineTravelMode", "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 \n

The mode Scooter also applies to motorcycles, set to\n Scooter when wanted to calculate options for motorcycles.

\n
\n

Default Value: Car\n

" + "smithy.api#documentation": "

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

The mode Scooter also applies to motorcycles, set to Scooter when wanted to calculate options for motorcycles.

Default Value: Car

" } }, "TravelModeOptions": { @@ -231,19 +231,19 @@ "ArrivalTime": { "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", "traits": { - "smithy.api#documentation": "

Time of arrival at the destination. This parameter is returned only if the Destination\n parameters was provided in the request.

\n

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n

\n

Examples:

\n

\n 2020-04-22T17:57:24Z\n

\n

\n 2020-04-22T17:57:24+02:00\n

" + "smithy.api#documentation": "

Time of arrival at the destination. This parameter is returned only if the Destination parameters was provided in the request.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" } }, "DepartureTime": { "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", "traits": { - "smithy.api#documentation": "

Time of departure from thr origin.

\n

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n

\n

Examples:

\n

\n 2020-04-22T17:57:24Z\n

\n

\n 2020-04-22T17:57:24+02:00\n

" + "smithy.api#documentation": "

Time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" } }, "IsolineGeometryFormat": { "target": "com.amazonaws.georoutes#GeometryFormat", "traits": { - "smithy.api#documentation": "

The format of the returned IsolineGeometry.

\n

Default Value:FlexiblePolyline\n

", + "smithy.api#documentation": "

The format of the returned IsolineGeometry.

Default Value:FlexiblePolyline

", "smithy.api#required": {} } }, @@ -303,7 +303,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Use CalculateRouteMatrix to compute results for all pairs of Origins to\n Destinations. Each row corresponds to one entry in Origins. Each entry in the row\n corresponds to the route from that entry in Origins to an entry in Destinations\n positions.

", + "smithy.api#documentation": "

Use CalculateRouteMatrix to compute results for all pairs of Origins to Destinations. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destinations positions.

", "smithy.api#http": { "uri": "/route-matrix", "method": "POST" @@ -356,11 +356,11 @@ "Avoid": { "target": "com.amazonaws.georoutes#RouteMatrixAvoidanceOptions", "traits": { - "smithy.api#documentation": "

Features that are avoided while calculating a route. Avoidance is on a best-case basis.\n If an avoidance can't be satisfied for a particular case, it violates the avoidance and the\n returned response produces a notice for the violation.

" + "smithy.api#documentation": "

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

" } }, "DepartNow": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Uses the current time as the time of departure.

" } @@ -368,13 +368,13 @@ "DepartureTime": { "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", "traits": { - "smithy.api#documentation": "

Time of departure from thr origin.

\n

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n

\n

Examples:

\n

\n 2020-04-22T17:57:24Z\n

\n

\n 2020-04-22T17:57:24+02:00\n

" + "smithy.api#documentation": "

Time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" } }, "Destinations": { "target": "com.amazonaws.georoutes#RouteMatrixDestinationList", "traits": { - "smithy.api#documentation": "

List of destinations for the route.

\n \n

Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. See\n \n Amazon Location's pricing page for more information.

\n
", + "smithy.api#documentation": "

List of destinations for the route.

Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. See Amazon Location's pricing page for more information.

", "smithy.api#length": { "min": 1 }, @@ -390,20 +390,20 @@ "Key": { "target": "com.amazonaws.georoutes#ApiKey", "traits": { - "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.

", + "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", "smithy.api#httpQuery": "key" } }, "OptimizeRoutingFor": { "target": "com.amazonaws.georoutes#RoutingObjective", "traits": { - "smithy.api#documentation": "

Specifies the optimization criteria for calculating a route.

\n

Default Value: FastestRoute\n

" + "smithy.api#documentation": "

Specifies the optimization criteria for calculating a route.

Default Value: FastestRoute

" } }, "Origins": { "target": "com.amazonaws.georoutes#RouteMatrixOriginList", "traits": { - "smithy.api#documentation": "

The position in longitude and latitude for the origin.

\n \n

Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a\n request can lead you to incur unexpected charges. See\n \n Amazon Location's pricing page for more information.

\n
", + "smithy.api#documentation": "

The position in longitude and latitude for the origin.

Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. See Amazon Location's pricing page for more information.

", "smithy.api#length": { "min": 1 }, @@ -413,7 +413,7 @@ "RoutingBoundary": { "target": "com.amazonaws.georoutes#RouteMatrixBoundary", "traits": { - "smithy.api#documentation": "

Boundary within which the matrix is to be calculated. All data, origins and destinations\n outside the boundary are considered invalid.

\n \n

When request routing boundary was set as AutoCircle, the response routing boundary\n will return Circle derived from the AutoCircle settings.

\n
", + "smithy.api#documentation": "

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

", "smithy.api#required": {} } }, @@ -426,7 +426,7 @@ "TravelMode": { "target": "com.amazonaws.georoutes#RouteMatrixTravelMode", "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

Default Value: Car\n

" + "smithy.api#documentation": "

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

" } }, "TravelModeOptions": { @@ -446,7 +446,7 @@ "ErrorCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The count of error results in the route matrix. If this number is 0, all routes were\n calculated successfully.

", + "smithy.api#documentation": "

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

", "smithy.api#range": { "min": 0 }, @@ -464,14 +464,14 @@ "RouteMatrix": { "target": "com.amazonaws.georoutes#RouteMatrix", "traits": { - "smithy.api#documentation": "

The calculated route matrix containing the results for all pairs of Origins to\n Destination positions. Each row corresponds to one entry in Origins. Each entry in the row\n corresponds to the route from that entry in Origins to an entry in Destination\n positions.

", + "smithy.api#documentation": "

The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions.

", "smithy.api#required": {} } }, "RoutingBoundary": { "target": "com.amazonaws.georoutes#RouteMatrixBoundary", "traits": { - "smithy.api#documentation": "

Boundary within which the matrix is to be calculated. All data, origins and destinations\n outside the boundary are considered invalid.

\n \n

When request routing boundary was set as AutoCircle, the response routing boundary\n will return Circle derived from the AutoCircle settings.

\n
", + "smithy.api#documentation": "

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

", "smithy.api#required": {} } } @@ -504,7 +504,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

\n CalculateRoutes computes routes given the following required parameters:\n Origin and Destination.

", + "smithy.api#documentation": "

CalculateRoutes computes routes given the following required parameters: Origin and Destination.

", "smithy.api#http": { "uri": "/routes", "method": "POST" @@ -546,17 +546,17 @@ "ArrivalTime": { "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", "traits": { - "smithy.api#documentation": "

Time of arrival at the destination.

\n

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n

\n

Examples:

\n

\n 2020-04-22T17:57:24Z\n

\n

\n 2020-04-22T17:57:24+02:00\n

" + "smithy.api#documentation": "

Time of arrival at the destination.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" } }, "Avoid": { "target": "com.amazonaws.georoutes#RouteAvoidanceOptions", "traits": { - "smithy.api#documentation": "

Features that are avoided while calculating a route. Avoidance is on a best-case basis.\n If an avoidance can't be satisfied for a particular case, it violates the avoidance and the\n returned response produces a notice for the violation.

" + "smithy.api#documentation": "

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

" } }, "DepartNow": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Uses the current time as the time of departure.

" } @@ -564,13 +564,13 @@ "DepartureTime": { "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", "traits": { - "smithy.api#documentation": "

Time of departure from thr origin.

\n

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n

\n

Examples:

\n

\n 2020-04-22T17:57:24Z\n

\n

\n 2020-04-22T17:57:24+02:00\n

" + "smithy.api#documentation": "

Time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" } }, "Destination": { "target": "com.amazonaws.georoutes#Position", "traits": { - "smithy.api#documentation": "

The final position for the route. In the World Geodetic System (WGS 84) format:\n [longitude, latitude].

", + "smithy.api#documentation": "

The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].

", "smithy.api#required": {} } }, @@ -601,14 +601,14 @@ "Key": { "target": "com.amazonaws.georoutes#ApiKey", "traits": { - "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.

", + "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", "smithy.api#httpQuery": "key" } }, "Languages": { "target": "com.amazonaws.georoutes#LanguageTagList", "traits": { - "smithy.api#documentation": "

List of languages for instructions within steps in the response.

\n \n

Instructions in the requested language are returned only if they are\n available.

\n
", + "smithy.api#documentation": "

List of languages for instructions within steps in the response.

Instructions in the requested language are returned only if they are available.

", "smithy.api#length": { "max": 10 } @@ -617,19 +617,19 @@ "LegAdditionalFeatures": { "target": "com.amazonaws.georoutes#RouteLegAdditionalFeatureList", "traits": { - "smithy.api#documentation": "

A list of optional additional parameters such as timezone that can be requested for each\n result.

\n
    \n
  • \n

    \n Elevation: Retrieves the elevation information for each\n location.

    \n
  • \n
  • \n

    \n Incidents: Provides information on traffic incidents along the\n route.

    \n
  • \n
  • \n

    \n PassThroughWaypoints: Indicates waypoints that are passed through\n without stopping.

    \n
  • \n
  • \n

    \n Summary: Returns a summary of the route, including distance and\n duration.

    \n
  • \n
  • \n

    \n Tolls: Supplies toll cost information along the route.

    \n
  • \n
  • \n

    \n TravelStepInstructions: Provides step-by-step instructions for travel\n along the route.

    \n
  • \n
  • \n

    \n TruckRoadTypes: Returns information about road types suitable for\n trucks.

    \n
  • \n
  • \n

    \n TypicalDuration: Gives typical travel duration based on historical\n data.

    \n
  • \n
  • \n

    \n Zones: Specifies the time zone information for each waypoint.

    \n
  • \n
" + "smithy.api#documentation": "

A list of optional additional parameters such as timezone that can be requested for each result.

  • Elevation: Retrieves the elevation information for each location.

  • Incidents: Provides information on traffic incidents along the route.

  • PassThroughWaypoints: Indicates waypoints that are passed through without stopping.

  • Summary: Returns a summary of the route, including distance and duration.

  • Tolls: Supplies toll cost information along the route.

  • TravelStepInstructions: Provides step-by-step instructions for travel along the route.

  • TruckRoadTypes: Returns information about road types suitable for trucks.

  • TypicalDuration: Gives typical travel duration based on historical data.

  • Zones: Specifies the time zone information for each waypoint.

" } }, "LegGeometryFormat": { "target": "com.amazonaws.georoutes#GeometryFormat", "traits": { - "smithy.api#documentation": "

Specifies the format of the geometry returned for each leg of the route. You can choose\n between two different geometry encoding formats.

\n

\n FlexiblePolyline: A compact and precise encoding format for the leg\n geometry. For more information on the format, see the GitHub repository for \n FlexiblePolyline\n .

\n

\n Simple: A less compact encoding, which is easier to decode but may be less\n precise and result in larger payloads.

" + "smithy.api#documentation": "

Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.

FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for FlexiblePolyline .

Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.

" } }, "MaxAlternatives": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Maximum number of alternative routes to be provided in the response, if\n available.

", + "smithy.api#documentation": "

Maximum number of alternative routes to be provided in the response, if available.

", "smithy.api#range": { "min": 0, "max": 5 @@ -639,7 +639,7 @@ "OptimizeRoutingFor": { "target": "com.amazonaws.georoutes#RoutingObjective", "traits": { - "smithy.api#documentation": "

Specifies the optimization criteria for calculating a route.

\n

Default Value: FastestRoute\n

" + "smithy.api#documentation": "

Specifies the optimization criteria for calculating a route.

Default Value: FastestRoute

" } }, "Origin": { @@ -658,7 +658,7 @@ "SpanAdditionalFeatures": { "target": "com.amazonaws.georoutes#RouteSpanAdditionalFeatureList", "traits": { - "smithy.api#documentation": "

A list of optional features such as SpeedLimit that can be requested for a Span. A span\n is a section of a Leg for which the requested features have the same values.

" + "smithy.api#documentation": "

A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.

" } }, "Tolls": { @@ -676,7 +676,7 @@ "TravelMode": { "target": "com.amazonaws.georoutes#RouteTravelMode", "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

Default Value: Car\n

" + "smithy.api#documentation": "

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

" } }, "TravelModeOptions": { @@ -688,7 +688,7 @@ "TravelStepType": { "target": "com.amazonaws.georoutes#RouteTravelStepType", "traits": { - "smithy.api#documentation": "

Type of step returned by the response. Default provides basic steps intended for web\n based applications. TurnByTurn provides detailed instructions with more granularity\n intended for a turn based navigation system.

" + "smithy.api#documentation": "

Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system.

" } }, "Waypoints": { @@ -715,7 +715,7 @@ "Notices": { "target": "com.amazonaws.georoutes#RouteResponseNoticeList", "traits": { - "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during\n route calculation.

", + "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during route calculation.

", "smithy.api#required": {} } }, @@ -745,20 +745,20 @@ "Center": { "target": "com.amazonaws.georoutes#Position", "traits": { - "smithy.api#documentation": "

Center of the Circle defined in longitude and latitude coordinates.

\n

Example: [-123.1174, 49.2847] represents the position with longitude\n -123.1174 and latitude 49.2847.

", + "smithy.api#documentation": "

Center of the Circle defined in longitude and latitude coordinates.

Example: [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

", "smithy.api#required": {} } }, "Radius": { - "target": "smithy.api#Double", + "target": "com.amazonaws.georoutes#SensitiveDouble", "traits": { - "smithy.api#documentation": "

Radius of the Circle.

\n

\n Unit: meters\n

", + "smithy.api#documentation": "

Radius of the Circle.

Unit: meters

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Geometry defined as a circle. When request routing boundary was set as\n AutoCircle, the response routing boundary will return Circle\n derived from the AutoCircle settings.

", + "smithy.api#documentation": "

Geometry defined as a circle. When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

", "smithy.api#sensitive": {} } }, @@ -776,7 +776,7 @@ "LineString": { "target": "com.amazonaws.georoutes#LineString", "traits": { - "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map.

\n \n

LineString and Polyline are mutually exclusive properties.

\n
", + "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map.

LineString and Polyline are mutually exclusive properties.

", "smithy.api#required": {} } }, @@ -789,7 +789,7 @@ } }, "traits": { - "smithy.api#documentation": "

Geometry defined as a corridor - a LineString with a radius that defines the width of\n the corridor.

", + "smithy.api#documentation": "

Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.

", "smithy.api#sensitive": {} } }, @@ -800,7 +800,8 @@ "min": 2, "max": 3 }, - "smithy.api#pattern": "^([A-Z]{2}|[A-Z]{3})$" + "smithy.api#pattern": "^([A-Z]{2}|[A-Z]{3})$", + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#CountryCode3": { @@ -810,7 +811,8 @@ "min": 3, "max": 3 }, - "smithy.api#pattern": "^[A-Z]{3}$" + "smithy.api#pattern": "^[A-Z]{3}$", + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#CountryCodeList": { @@ -868,7 +870,8 @@ "name": "SUNDAY", "value": "Sunday" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#DimensionCentimeters": { @@ -878,7 +881,8 @@ "smithy.api#range": { "min": 0, "max": 4294967295 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#DistanceMeters": { @@ -888,7 +892,8 @@ "smithy.api#range": { "min": 0, "max": 4294967295 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#DistanceThresholdList": { @@ -916,7 +921,8 @@ "smithy.api#range": { "min": 0, "max": 4294967295 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#GeometryFormat": { @@ -941,7 +947,8 @@ "smithy.api#range": { "min": 0.0, "max": 360.0 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#IndexList": { @@ -962,7 +969,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception or\n failure.

", + "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception or failure.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} @@ -974,7 +981,7 @@ "Connections": { "target": "com.amazonaws.georoutes#IsolineConnectionList", "traits": { - "smithy.api#documentation": "

Isolines may contain multiple components, if these components are connected by ferry\n links. These components are returned as separate polygons while the ferry links are\n returned as connections.

", + "smithy.api#documentation": "

Isolines may contain multiple components, if these components are connected by ferry links. These components are returned as separate polygons while the ferry links are returned as connections.

", "smithy.api#required": {} } }, @@ -1008,15 +1015,15 @@ "type": "structure", "members": { "Hot": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { - "smithy.api#documentation": "

Allow Hot (High Occupancy Toll) lanes while calculating an isoline.

\n

Default value: false\n

" + "smithy.api#documentation": "

Allow Hot (High Occupancy Toll) lanes while calculating an isoline.

Default value: false

" } }, "Hov": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { - "smithy.api#documentation": "

Allow Hov (High Occupancy vehicle) lanes while calculating an isoline.

\n

Default value: false\n

" + "smithy.api#documentation": "

Allow Hov (High Occupancy vehicle) lanes while calculating an isoline.

Default value: false

" } } }, @@ -1030,7 +1037,7 @@ "Except": { "target": "com.amazonaws.georoutes#IsolineAvoidanceAreaGeometryList", "traits": { - "smithy.api#documentation": "

Exceptions to the provided avoidance geometry, to be included while calculating an\n isoline.

" + "smithy.api#documentation": "

Exceptions to the provided avoidance geometry, to be included while calculating an isoline.

" } }, "Geometry": { @@ -1051,19 +1058,19 @@ "BoundingBox": { "target": "com.amazonaws.georoutes#BoundingBox", "traits": { - "smithy.api#documentation": "

Geometry defined as a bounding box. The first pair represents the X and Y coordinates\n (longitude and latitude,) of the southwest corner of the bounding box; the second pair\n represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" + "smithy.api#documentation": "

Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" } }, "Corridor": { "target": "com.amazonaws.georoutes#Corridor", "traits": { - "smithy.api#documentation": "

Geometry defined as a corridor - a LineString with a radius that defines the width of\n the corridor.

" + "smithy.api#documentation": "

Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.

" } }, "Polygon": { "target": "com.amazonaws.georoutes#LinearRings", "traits": { - "smithy.api#documentation": "

A list of Polygon will be excluded for calculating isolines, the list can only contain 1\n polygon.

", + "smithy.api#documentation": "

A list of Polygon will be excluded for calculating isolines, the list can only contain 1 polygon.

", "smithy.api#length": { "min": 1, "max": 1 @@ -1073,13 +1080,13 @@ "PolylineCorridor": { "target": "com.amazonaws.georoutes#PolylineCorridor", "traits": { - "smithy.api#documentation": "

Geometry defined as an encoded corridor – a polyline with a radius that defines the\n width of the corridor. For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

" + "smithy.api#documentation": "

Geometry defined as an encoded corridor – a polyline with a radius that defines the width of the corridor. For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

" } }, "PolylinePolygon": { "target": "com.amazonaws.georoutes#PolylineRingList", "traits": { - "smithy.api#documentation": "

A list of PolylinePolygon's that are excluded for calculating isolines, the list can\n only contain 1 polygon. For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

", + "smithy.api#documentation": "

A list of PolylinePolygon's that are excluded for calculating isolines, the list can only contain 1 polygon. For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

", "smithy.api#length": { "min": 1, "max": 1 @@ -1113,43 +1120,43 @@ } }, "CarShuttleTrains": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid car-shuttle-trains while calculating an isoline.

" } }, "ControlledAccessHighways": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid controlled access highways while calculating an isoline.

" } }, "DirtRoads": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid dirt roads while calculating an isoline.

" } }, "Ferries": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid ferries while calculating an isoline.

" } }, "SeasonalClosure": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid roads that have seasonal closure while calculating an isoline.

" } }, "TollRoads": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoids roads where the specified toll transponders are the only mode of payment.

" } }, "TollTransponders": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoids roads where the specified toll transponders are the only mode of payment.

" } @@ -1157,17 +1164,17 @@ "TruckRoadTypes": { "target": "com.amazonaws.georoutes#TruckRoadTypeList", "traits": { - "smithy.api#documentation": "

Truck road type identifiers. BK1 through BK4 apply only to\n Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

\n \n

There are currently no other supported values as of 26th April 2024.

\n
" + "smithy.api#documentation": "

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

" } }, "Tunnels": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid tunnels while calculating an isoline.

" } }, "UTurns": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid U-turns for calculation on highways and motorways.

" } @@ -1180,7 +1187,7 @@ } }, "traits": { - "smithy.api#documentation": "

Features that are avoided while calculating isolines. Avoidance is on a best-case basis.\n If an avoidance can't be satisfied for a particular case, it violates the avoidance and the\n returned response produces a notice for the violation.

" + "smithy.api#documentation": "

Features that are avoided while calculating isolines. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

" } }, "com.amazonaws.georoutes#IsolineAvoidanceZoneCategory": { @@ -1228,7 +1235,7 @@ "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Maximum speed.

\n

\n Unit: KilometersPerHour\n

", + "smithy.api#documentation": "

Maximum speed.

Unit: KilometersPerHour

", "smithy.api#range": { "min": 3.6, "max": 252.0 @@ -1236,10 +1243,10 @@ } }, "Occupancy": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The number of occupants in the vehicle.

\n

Default Value: 1\n

", + "smithy.api#documentation": "

The number of occupants in the vehicle.

Default Value: 1

", "smithy.api#range": { "min": 1 } @@ -1256,7 +1263,7 @@ "FromPolygonIndex": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Index of the polygon corresponding to the \"from\" component of the connection.\n The polygon is available from Isoline[].Geometries.

", + "smithy.api#documentation": "

Index of the polygon corresponding to the \"from\" component of the connection. The polygon is available from Isoline[].Geometries.

", "smithy.api#range": { "min": 0 }, @@ -1273,7 +1280,7 @@ "ToPolygonIndex": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Index of the polygon corresponding to the \"to\" component of the connection.\n The polygon is available from Isoline[].Geometries.

", + "smithy.api#documentation": "

Index of the polygon corresponding to the \"to\" component of the connection. The polygon is available from Isoline[].Geometries.

", "smithy.api#range": { "min": 0 }, @@ -1282,7 +1289,7 @@ } }, "traits": { - "smithy.api#documentation": "

Isolines may contain multiple components, if these components are connected by ferry\n links. These components are returned as separate polygons while the ferry links are\n returned as connections.

" + "smithy.api#documentation": "

Isolines may contain multiple components, if these components are connected by ferry links. These components are returned as separate polygons while the ferry links are returned as connections.

" } }, "com.amazonaws.georoutes#IsolineConnectionGeometry": { @@ -1291,13 +1298,13 @@ "LineString": { "target": "com.amazonaws.georoutes#LineString", "traits": { - "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map.

\n \n

LineString and Polyline are mutually exclusive properties.

\n
" + "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map.

LineString and Polyline are mutually exclusive properties.

" } }, "Polyline": { "target": "com.amazonaws.georoutes#Polyline", "traits": { - "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map in a lossy compression\n format.

\n \n

LineString and Polyline are mutually exclusive properties.

\n
" + "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map in a lossy compression format.

LineString and Polyline are mutually exclusive properties.

" } } }, @@ -1318,7 +1325,7 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Avoids actions for the provided distance. This is typically to consider for users in\n moving vehicles who may not have sufficient time to make an action at an origin or a\n destination.

" + "smithy.api#documentation": "

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

" } }, "Heading": { @@ -1361,7 +1368,8 @@ "name": "PLUGIN_HYBRID", "value": "PluginHybrid" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#IsolineGranularityOptions": { @@ -1381,7 +1389,7 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Maximum resolution of the returned isoline.

\n

\n Unit: meters\n

" + "smithy.api#documentation": "

Maximum resolution of the returned isoline.

Unit: meters

" } } }, @@ -1437,7 +1445,8 @@ "name": "RADIOACTIVE", "value": "Radioactive" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#IsolineHazardousCargoTypeList": { @@ -1477,20 +1486,20 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint\n will be snapped to the highway/bridge/tunnel/sliproad.

\n

\n Unit: meters\n

" + "smithy.api#documentation": "

If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.

Unit: meters

" } }, "Radius": { "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Considers all roads within the provided radius to match the provided destination to. The\n roads that are considered are determined by the provided Strategy.

\n

\n Unit: Meters\n

" + "smithy.api#documentation": "

Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

Unit: Meters

" } }, "Strategy": { "target": "com.amazonaws.georoutes#MatchingStrategy", "traits": { - "smithy.api#documentation": "

Strategy that defines matching of the position onto the road network. MatchAny considers\n all roads possible, whereas MatchMostSignificantRoad matches to the most significant\n road.

" + "smithy.api#documentation": "

Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

" } } }, @@ -1524,7 +1533,7 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Avoids actions for the provided distance. This is typically to consider for users in\n moving vehicles who may not have sufficient time to make an action at an origin or a\n destination.

" + "smithy.api#documentation": "

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

" } }, "Heading": { @@ -1570,7 +1579,7 @@ "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Maximum speed specified.

\n

\n Unit: KilometersPerHour\n

", + "smithy.api#documentation": "

Maximum speed specified.

Unit: KilometersPerHour

", "smithy.api#range": { "min": 3.6, "max": 252.0 @@ -1578,10 +1587,10 @@ } }, "Occupancy": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The number of occupants in the vehicle.

\n

Default Value: 1\n

", + "smithy.api#documentation": "

The number of occupants in the vehicle.

Default Value: 1

", "smithy.api#range": { "min": 1 } @@ -1589,7 +1598,7 @@ } }, "traits": { - "smithy.api#documentation": "

Travel mode options when the provided travel mode is Scooter\n

" + "smithy.api#documentation": "

Travel mode options when the provided travel mode is Scooter

" } }, "com.amazonaws.georoutes#IsolineShapeGeometry": { @@ -1598,13 +1607,13 @@ "Polygon": { "target": "com.amazonaws.georoutes#LinearRings", "traits": { - "smithy.api#documentation": "

A list of Isoline Polygons, for each isoline polygon, it contains polygons of the first\n linear ring (the outer ring) and from 2nd item to the last item (the inner rings).

" + "smithy.api#documentation": "

A list of Isoline Polygons, for each isoline polygon, it contains polygons of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings).

" } }, "PolylinePolygon": { "target": "com.amazonaws.georoutes#PolylineRingList", "traits": { - "smithy.api#documentation": "

A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains\n PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last\n item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

" + "smithy.api#documentation": "

A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

" } } }, @@ -1631,7 +1640,7 @@ "UseWith": { "target": "com.amazonaws.georoutes#SideOfStreetMatchingStrategy", "traits": { - "smithy.api#documentation": "

Strategy that defines when the side of street position should be used. AnyStreet will\n always use the provided position.

\n

Default Value: DividedStreetOnly\n

" + "smithy.api#documentation": "

Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.

Default Value: DividedStreetOnly

" } } }, @@ -1656,7 +1665,7 @@ } }, "traits": { - "smithy.api#documentation": "

Threshold to be used for the isoline calculation. Up to 5 thresholds per provided type\n can be requested.

" + "smithy.api#documentation": "

Threshold to be used for the isoline calculation. Up to 5 thresholds per provided type can be requested.

" } }, "com.amazonaws.georoutes#IsolineTrafficOptions": { @@ -1666,13 +1675,13 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration for which flow traffic is considered valid. For this period, the flow traffic\n is used over historical traffic data. Flow traffic refers to congestion, which changes very\n quickly. Duration in seconds for which flow traffic event would be considered valid. While\n flow traffic event is valid it will be used over the historical traffic data.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.

Unit: seconds

" } }, "Usage": { "target": "com.amazonaws.georoutes#TrafficUsage", "traits": { - "smithy.api#documentation": "

Determines if traffic should be used or ignored while calculating the route.

\n

Default Value: UseTrafficData\n

" + "smithy.api#documentation": "

Determines if traffic should be used or ignored while calculating the route.

Default Value: UseTrafficData

" } } }, @@ -1684,7 +1693,7 @@ "type": "structure", "members": { "AxleCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Total number of axles of the vehicle.

", @@ -1694,10 +1703,10 @@ } }, "TrailerCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Number of trailers attached to the vehicle.

\n

Default Value: 0\n

", + "smithy.api#documentation": "

Number of trailers attached to the vehicle.

Default Value: 0

", "smithy.api#range": { "min": 1, "max": 255 @@ -1744,7 +1753,7 @@ "Scooter": { "target": "com.amazonaws.georoutes#IsolineScooterOptions", "traits": { - "smithy.api#documentation": "

Travel mode options when the provided travel mode is Scooter\n

\n \n

When travel mode is set to Scooter, then the avoidance option\n ControlledAccessHighways defaults to true.

\n
" + "smithy.api#documentation": "

Travel mode options when the provided travel mode is Scooter

When travel mode is set to Scooter, then the avoidance option ControlledAccessHighways defaults to true.

" } }, "Truck": { @@ -1762,7 +1771,7 @@ "type": "structure", "members": { "AxleCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Total number of axles of the vehicle.

", @@ -1782,7 +1791,7 @@ "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Gross weight of the vehicle including trailers, and goods at capacity.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Gross weight of the vehicle including trailers, and goods at capacity.

Unit: Kilograms

" } }, "HazardousCargos": { @@ -1795,7 +1804,7 @@ "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Height of the vehicle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Height of the vehicle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 5000 @@ -1806,7 +1815,7 @@ "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Height of the vehicle above its first axle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Height of the vehicle above its first axle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 5000 @@ -1817,14 +1826,14 @@ "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Kingpin to rear axle length of the vehicle.

\n

\n Unit: centimeters\n

" + "smithy.api#documentation": "

Kingpin to rear axle length of the vehicle.

Unit: centimeters

" } }, "Length": { "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Length of the vehicle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Length of the vehicle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 30000 @@ -1841,7 +1850,7 @@ "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Maximum speed specified.

\n

\n Unit: KilometersPerHour\n

", + "smithy.api#documentation": "

Maximum speed specified.

Unit: KilometersPerHour

", "smithy.api#range": { "min": 3.6, "max": 252.0 @@ -1849,10 +1858,10 @@ } }, "Occupancy": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The number of occupants in the vehicle.

\n

Default Value: 1\n

", + "smithy.api#documentation": "

The number of occupants in the vehicle.

Default Value: 1

", "smithy.api#range": { "min": 1 } @@ -1862,11 +1871,11 @@ "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Payload capacity of the vehicle and trailers attached.

\n

\n Unit: kilograms\n

" + "smithy.api#documentation": "

Payload capacity of the vehicle and trailers attached.

Unit: kilograms

" } }, "TireCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Number of tires on the vehicle.

", @@ -1891,27 +1900,27 @@ "TunnelRestrictionCode": { "target": "com.amazonaws.georoutes#TunnelRestrictionCode", "traits": { - "smithy.api#documentation": "

The tunnel restriction code.

\n

Tunnel categories in this list indicate the restrictions which apply to certain tunnels\n in Great Britain. They relate to the types of dangerous goods that can be transported\n through them.

\n
    \n
  • \n

    \n Tunnel Category B\n

    \n
      \n
    • \n

      \n Risk Level: Limited risk

      \n
    • \n
    • \n

      \n Restrictions: Few restrictions

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category C\n

    \n
      \n
    • \n

      \n Risk Level: Medium risk

      \n
    • \n
    • \n

      \n Restrictions: Some restrictions

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category D\n

    \n
      \n
    • \n

      \n Risk Level: High risk

      \n
    • \n
    • \n

      \n Restrictions: Many restrictions occur

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category E\n

    \n
      \n
    • \n

      \n Risk Level: Very high risk

      \n
    • \n
    • \n

      \n Restrictions: Restricted tunnel

      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

  • Tunnel Category B

    • Risk Level: Limited risk

    • Restrictions: Few restrictions

  • Tunnel Category C

    • Risk Level: Medium risk

    • Restrictions: Some restrictions

  • Tunnel Category D

    • Risk Level: High risk

    • Restrictions: Many restrictions occur

  • Tunnel Category E

    • Risk Level: Very high risk

    • Restrictions: Restricted tunnel

" } }, "WeightPerAxle": { "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Heaviest weight per axle irrespective of the axle type or the axle group. Meant for\n usage in countries where the differences in axle types or axle groups are not\n distinguished.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.

Unit: Kilograms

" } }, "WeightPerAxleGroup": { "target": "com.amazonaws.georoutes#WeightPerAxleGroup", "traits": { - "smithy.api#documentation": "

Specifies the total weight for the specified axle group. Meant for usage in countries\n that have different regulations based on the axle group type.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.

Unit: Kilograms

" } }, "Width": { "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Width of the vehicle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Width of the vehicle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 5000 @@ -1957,7 +1966,8 @@ } }, "traits": { - "smithy.api#documentation": "

The vehicle license plate.

" + "smithy.api#documentation": "

The vehicle license plate.

", + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#IsolineZoneCategory": { @@ -2039,11 +2049,11 @@ "Language": { "target": "com.amazonaws.georoutes#LanguageTag", "traits": { - "smithy.api#documentation": "

A list of BCP 47 compliant language codes for the results to be rendered in. The request\n uses the regional default as the fallback if the requested language can't be\n provided.

" + "smithy.api#documentation": "

A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can't be provided.

" } }, "Value": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

The value of the localized string.

", "smithy.api#required": {} @@ -2114,7 +2124,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

\n OptimizeWaypoints calculates the optimal order to travel between a set of\n waypoints to minimize either the travel time or the distance travelled during the journey,\n based on road network restrictions and the traffic pattern data.

", + "smithy.api#documentation": "

OptimizeWaypoints calculates the optimal order to travel between a set of waypoints to minimize either the travel time or the distance travelled during the journey, based on road network restrictions and the traffic pattern data.

", "smithy.api#http": { "uri": "/optimize-waypoints", "method": "POST" @@ -2150,25 +2160,25 @@ "Avoid": { "target": "com.amazonaws.georoutes#WaypointOptimizationAvoidanceOptions", "traits": { - "smithy.api#documentation": "

Features that are avoided. Avoidance is on a best-case basis. If an avoidance can't be\n satisfied for a particular case, this setting is ignored.

" + "smithy.api#documentation": "

Features that are avoided. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, this setting is ignored.

" } }, "Clustering": { "target": "com.amazonaws.georoutes#WaypointOptimizationClusteringOptions", "traits": { - "smithy.api#documentation": "

Clustering allows you to specify how nearby waypoints can be clustered to improve the\n optimized sequence.

" + "smithy.api#documentation": "

Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence.

" } }, "DepartureTime": { "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", "traits": { - "smithy.api#documentation": "

Departure time from the waypoint.

\n

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n

\n

Examples:

\n

\n 2020-04-22T17:57:24Z\n

\n

\n 2020-04-22T17:57:24+02:00\n

" + "smithy.api#documentation": "

Departure time from the waypoint.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" } }, "Destination": { "target": "com.amazonaws.georoutes#Position", "traits": { - "smithy.api#documentation": "

The final position for the route in the World Geodetic System (WGS 84) format:\n [longitude, latitude].

" + "smithy.api#documentation": "

The final position for the route in the World Geodetic System (WGS 84) format: [longitude, latitude].

" } }, "DestinationOptions": { @@ -2192,14 +2202,14 @@ "Key": { "target": "com.amazonaws.georoutes#ApiKey", "traits": { - "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.

", + "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", "smithy.api#httpQuery": "key" } }, "OptimizeSequencingFor": { "target": "com.amazonaws.georoutes#WaypointOptimizationSequencingObjective", "traits": { - "smithy.api#documentation": "

Specifies the optimization criteria for the calculated sequence.

\n

Default Value: FastestRoute.

" + "smithy.api#documentation": "

Specifies the optimization criteria for the calculated sequence.

Default Value: FastestRoute.

" } }, "Origin": { @@ -2224,7 +2234,7 @@ "TravelMode": { "target": "com.amazonaws.georoutes#WaypointOptimizationTravelMode", "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

Default Value: Car\n

" + "smithy.api#documentation": "

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

" } }, "TravelModeOptions": { @@ -2250,7 +2260,7 @@ "Connections": { "target": "com.amazonaws.georoutes#WaypointOptimizationConnectionList", "traits": { - "smithy.api#documentation": "

Details about the connection from one waypoint to the next, within the optimized\n sequence.

", + "smithy.api#documentation": "

Details about the connection from one waypoint to the next, within the optimized sequence.

", "smithy.api#required": {} } }, @@ -2266,14 +2276,14 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Overall duration to travel the whole sequence.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Overall duration to travel the whole sequence.

Unit: seconds

", "smithy.api#required": {} } }, "ImpedingWaypoints": { "target": "com.amazonaws.georoutes#WaypointOptimizationImpedingWaypointList", "traits": { - "smithy.api#documentation": "

Returns waypoints that caused the optimization problem to fail, and the constraints that\n were unsatisfied leading to the failure.

", + "smithy.api#documentation": "

Returns waypoints that caused the optimization problem to fail, and the constraints that were unsatisfied leading to the failure.

", "smithy.api#required": {} } }, @@ -2322,20 +2332,20 @@ "Polyline": { "target": "com.amazonaws.georoutes#Polyline", "traits": { - "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map in a lossy compression\n format.

\n \n

LineString and Polyline are mutually exclusive properties.

\n
", + "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map in a lossy compression format.

LineString and Polyline are mutually exclusive properties.

", "smithy.api#required": {} } }, "Radius": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Considers all roads within the provided radius to match the provided destination to. The\n roads that are considered are determined by the provided Strategy.

\n

\n Unit: Meters\n

", + "smithy.api#documentation": "

Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

Unit: Meters

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Geometry defined as an encoded corridor - an encoded polyline with a radius that defines\n the width of the corridor.

", + "smithy.api#documentation": "

Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.

", "smithy.api#sensitive": {} } }, @@ -2462,7 +2472,8 @@ "name": "RADIOACTIVE", "value": "Radioactive" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RoadSnapHazardousCargoTypeList": { @@ -2488,7 +2499,7 @@ } }, "Title": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

The notice title.

", "smithy.api#required": {} @@ -2503,7 +2514,7 @@ } }, "traits": { - "smithy.api#documentation": "

Notices provide information around factors that may have influenced snapping in a manner\n atypical to the standard use cases.

" + "smithy.api#documentation": "

Notices provide information around factors that may have influenced snapping in a manner atypical to the standard use cases.

" } }, "com.amazonaws.georoutes#RoadSnapNoticeCode": { @@ -2538,7 +2549,8 @@ "name": "TRACE_POINTS_SPEED_IGNORED", "value": "TracePointsSpeedIgnored" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RoadSnapNoticeList": { @@ -2553,13 +2565,13 @@ "LineString": { "target": "com.amazonaws.georoutes#LineString", "traits": { - "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map.

\n \n

LineString and Polyline are mutually exclusive properties.

\n
" + "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map.

LineString and Polyline are mutually exclusive properties.

" } }, "Polyline": { "target": "com.amazonaws.georoutes#Polyline", "traits": { - "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map in a lossy compression\n format.

\n \n

LineString and Polyline are mutually exclusive properties.

\n
" + "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map in a lossy compression format.

LineString and Polyline are mutually exclusive properties.

" } } }, @@ -2571,7 +2583,7 @@ "type": "structure", "members": { "Confidence": { - "target": "smithy.api#Double", + "target": "com.amazonaws.georoutes#SensitiveDouble", "traits": { "smithy.api#documentation": "

Confidence value for the correctness of this point match.

", "smithy.api#range": { @@ -2591,7 +2603,7 @@ "SnappedPosition": { "target": "com.amazonaws.georoutes#Position", "traits": { - "smithy.api#documentation": "

Snapped position of the TracePoint provided within the request, at the same index.\n

", + "smithy.api#documentation": "

Snapped position of the TracePoint provided within the request, at the same index.

", "smithy.api#required": {} } } @@ -2627,7 +2639,7 @@ "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Speed at the specified trace point .

\n

\n Unit: KilometersPerHour\n

" + "smithy.api#documentation": "

Speed at the specified trace point .

Unit: KilometersPerHour

" } }, "Timestamp": { @@ -2650,7 +2662,8 @@ "smithy.api#length": { "min": 1, "max": 1000 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RoadSnapTracePointList": { @@ -2663,9 +2676,9 @@ "type": "structure", "members": { "TrailerCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { - "smithy.api#documentation": "

Number of trailers attached to the vehicle.

\n

Default Value: 0\n

", + "smithy.api#documentation": "

Number of trailers attached to the vehicle.

Default Value: 0

", "smithy.api#range": { "min": 0, "max": 255 @@ -2721,7 +2734,7 @@ "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Gross weight of the vehicle including trailers, and goods at capacity.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Gross weight of the vehicle including trailers, and goods at capacity.

Unit: Kilograms

" } }, "HazardousCargos": { @@ -2734,7 +2747,7 @@ "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Height of the vehicle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Height of the vehicle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 5000 @@ -2745,7 +2758,7 @@ "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Length of the vehicle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Length of the vehicle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 30000 @@ -2761,7 +2774,7 @@ "TunnelRestrictionCode": { "target": "com.amazonaws.georoutes#TunnelRestrictionCode", "traits": { - "smithy.api#documentation": "

The tunnel restriction code.

\n

Tunnel categories in this list indicate the restrictions which apply to certain tunnels\n in Great Britain. They relate to the types of dangerous goods that can be transported\n through them.

\n
    \n
  • \n

    \n Tunnel Category B\n

    \n
      \n
    • \n

      \n Risk Level: Limited risk

      \n
    • \n
    • \n

      \n Restrictions: Few restrictions

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category C\n

    \n
      \n
    • \n

      \n Risk Level: Medium risk

      \n
    • \n
    • \n

      \n Restrictions: Some restrictions

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category D\n

    \n
      \n
    • \n

      \n Risk Level: High risk

      \n
    • \n
    • \n

      \n Restrictions: Many restrictions occur

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category E\n

    \n
      \n
    • \n

      \n Risk Level: Very high risk

      \n
    • \n
    • \n

      \n Restrictions: Restricted tunnel

      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

  • Tunnel Category B

    • Risk Level: Limited risk

    • Restrictions: Few restrictions

  • Tunnel Category C

    • Risk Level: Medium risk

    • Restrictions: Some restrictions

  • Tunnel Category D

    • Risk Level: High risk

    • Restrictions: Many restrictions occur

  • Tunnel Category E

    • Risk Level: Very high risk

    • Restrictions: Restricted tunnel

" } }, "Width": { @@ -2796,14 +2809,14 @@ "Legs": { "target": "com.amazonaws.georoutes#RouteLegList", "traits": { - "smithy.api#documentation": "

A leg is a section of a route from one waypoint to the next. A leg could be of type\n Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single\n route. For example, a car employing the use of a Ferry will contain Vehicle legs\n corresponding to journey on land, and Ferry legs corresponding to the journey via\n Ferry.

", + "smithy.api#documentation": "

A leg is a section of a route from one waypoint to the next. A leg could be of type Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single route. For example, a car employing the use of a Ferry will contain Vehicle legs corresponding to journey on land, and Ferry legs corresponding to the journey via Ferry.

", "smithy.api#required": {} } }, "MajorRoadLabels": { "target": "com.amazonaws.georoutes#RouteMajorRoadLabelList", "traits": { - "smithy.api#documentation": "

Important labels including names and route numbers that differentiate the current route\n from the alternatives presented.

", + "smithy.api#documentation": "

Important labels including names and route numbers that differentiate the current route from the alternatives presented.

", "smithy.api#length": { "min": 0, "max": 2 @@ -2826,15 +2839,15 @@ "type": "structure", "members": { "Hot": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { - "smithy.api#documentation": "

Allow Hot (High Occupancy Toll) lanes while calculating the route.

\n

Default value: false\n

" + "smithy.api#documentation": "

Allow Hot (High Occupancy Toll) lanes while calculating the route.

Default value: false

" } }, "Hov": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { - "smithy.api#documentation": "

Allow Hov (High Occupancy vehicle) lanes while calculating the route.

\n

Default value: false\n

" + "smithy.api#documentation": "

Allow Hov (High Occupancy vehicle) lanes while calculating the route.

Default value: false

" } } }, @@ -2848,7 +2861,7 @@ "Except": { "target": "com.amazonaws.georoutes#RouteAvoidanceAreaGeometryList", "traits": { - "smithy.api#documentation": "

Exceptions to the provided avoidance geometry, to be included while calculating the\n route.

" + "smithy.api#documentation": "

Exceptions to the provided avoidance geometry, to be included while calculating the route.

" } }, "Geometry": { @@ -2868,13 +2881,13 @@ "Corridor": { "target": "com.amazonaws.georoutes#Corridor", "traits": { - "smithy.api#documentation": "

Geometry defined as a corridor - a LineString with a radius that defines the width of\n the corridor.

" + "smithy.api#documentation": "

Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.

" } }, "BoundingBox": { "target": "com.amazonaws.georoutes#BoundingBox", "traits": { - "smithy.api#documentation": "

Geometry defined as a bounding box. The first pair represents the X and Y coordinates\n (longitude and latitude,) of the southwest corner of the bounding box; the second pair\n represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" + "smithy.api#documentation": "

Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" } }, "Polygon": { @@ -2890,13 +2903,13 @@ "PolylineCorridor": { "target": "com.amazonaws.georoutes#PolylineCorridor", "traits": { - "smithy.api#documentation": "

Geometry defined as an encoded corridor - an encoded polyline with a radius that defines\n the width of the corridor.

" + "smithy.api#documentation": "

Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.

" } }, "PolylinePolygon": { "target": "com.amazonaws.georoutes#PolylineRingList", "traits": { - "smithy.api#documentation": "

A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains\n PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last\n item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

", + "smithy.api#documentation": "

A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

", "smithy.api#length": { "min": 1, "max": 1 @@ -2930,43 +2943,43 @@ } }, "CarShuttleTrains": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid car-shuttle-trains while calculating the route.

" } }, "ControlledAccessHighways": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid controlled access highways while calculating the route.

" } }, "DirtRoads": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid dirt roads while calculating the route.

" } }, "Ferries": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid ferries while calculating the route.

" } }, "SeasonalClosure": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid roads that have seasonal closure while calculating the route.

" } }, "TollRoads": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoids roads where the specified toll transponders are the only mode of payment.

" } }, "TollTransponders": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoids roads where the specified toll transponders are the only mode of payment.

" } @@ -2974,17 +2987,17 @@ "TruckRoadTypes": { "target": "com.amazonaws.georoutes#TruckRoadTypeList", "traits": { - "smithy.api#documentation": "

Truck road type identifiers. BK1 through BK4 apply only to\n Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

\n \n

There are currently no other supported values as of 26th April 2024.

\n
" + "smithy.api#documentation": "

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

" } }, "Tunnels": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid tunnels while calculating the route.

" } }, "UTurns": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid U-turns for calculation on highways and motorways.

" } @@ -2997,7 +3010,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies options for areas to avoid when calculating the route. This is a best-effort\n avoidance setting, meaning the router will try to honor the avoidance preferences but may\n still include restricted areas if no feasible alternative route exists. If avoidance\n options are not followed, the response will indicate that the avoidance criteria were\n violated.

" + "smithy.api#documentation": "

Specifies options for areas to avoid when calculating the route. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.

" } }, "com.amazonaws.georoutes#RouteAvoidanceZoneCategory": { @@ -3045,7 +3058,7 @@ "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Maximum speed specified.

\n

\n Unit: KilometersPerHour\n

", + "smithy.api#documentation": "

Maximum speed specified.

Unit: KilometersPerHour

", "smithy.api#range": { "min": 3.6, "max": 252.0 @@ -3053,10 +3066,10 @@ } }, "Occupancy": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The number of occupants in the vehicle.

\n

Default Value: 1\n

", + "smithy.api#documentation": "

The number of occupants in the vehicle.

Default Value: 1

", "smithy.api#range": { "min": 1 } @@ -3123,14 +3136,14 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Avoids actions for the provided distance. This is typically to consider for users in\n moving vehicles who may not have sufficient time to make an action at an origin or a\n destination.

", + "smithy.api#documentation": "

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

", "smithy.api#range": { "max": 2000 } } }, "AvoidUTurns": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid U-turns for calculation on highways and motorways.

" } @@ -3158,7 +3171,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the stop.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Duration of the stop.

Unit: seconds

" } } }, @@ -3186,7 +3199,8 @@ "name": "WEST", "value": "West" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteDriverOptions": { @@ -3210,7 +3224,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Maximum allowed driving time before stopping to rest.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Maximum allowed driving time before stopping to rest.

Unit: seconds

", "smithy.api#required": {} } }, @@ -3218,13 +3232,13 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Resting time before the driver can continue driving.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Resting time before the driver can continue driving.

Unit: seconds

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Interval of the driver work-rest schedule. Stops are added to fulfil the provided rest\n schedule.

" + "smithy.api#documentation": "

Interval of the driver work-rest schedule. Stops are added to fulfil the provided rest schedule.

" } }, "com.amazonaws.georoutes#RouteDriverScheduleIntervalList": { @@ -3237,21 +3251,21 @@ "type": "structure", "members": { "Co2EmissionClass": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

The CO 2 emission classes.

" } }, "Type": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { - "smithy.api#documentation": "

Type of the emission.

\n

\n Valid values: Euro1, Euro2, Euro3, Euro4, Euro5,\n Euro6, EuroEev\n

", + "smithy.api#documentation": "

Type of the emission.

Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Type of the emission.

\n

\n Valid values: Euro1, Euro2, Euro3, Euro4, Euro5,\n Euro6, EuroEev\n

" + "smithy.api#documentation": "

Type of the emission.

Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev

" } }, "com.amazonaws.georoutes#RouteEngineType": { @@ -3270,7 +3284,8 @@ "name": "PLUGIN_HYBRID", "value": "PluginHybrid" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteEnterHighwayStepDetails": { @@ -3313,13 +3328,13 @@ "Countries": { "target": "com.amazonaws.georoutes#CountryCodeList", "traits": { - "smithy.api#documentation": "

List of countries to be avoided defined by two-letter or three-letter country\n codes.

", + "smithy.api#documentation": "

List of countries to be avoided defined by two-letter or three-letter country codes.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Specifies strict exclusion options for the route calculation. This setting mandates that\n the router will avoid any routes that include the specified options, rather than merely\n attempting to minimize them.

" + "smithy.api#documentation": "

Specifies strict exclusion options for the route calculation. This setting mandates that the router will avoid any routes that include the specified options, rather than merely attempting to minimize them.

" } }, "com.amazonaws.georoutes#RouteExitStepDetails": { @@ -3333,7 +3348,7 @@ } }, "RelativeExit": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Exit to be taken.

", @@ -3374,14 +3389,14 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the step.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Duration of the step.

Unit: seconds

", "smithy.api#required": {} } }, "Instruction": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { - "smithy.api#documentation": "

Brief description of the step in the requested language.

\n \n

Only available when the TravelStepType is Default.

\n
" + "smithy.api#documentation": "

Brief description of the step in the requested language.

Only available when the TravelStepType is Default.

" } }, "Type": { @@ -3410,7 +3425,8 @@ "name": "DEBOARD", "value": "Deboard" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteFerryArrival": { @@ -3441,14 +3457,14 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the step.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Duration of the step.

Unit: seconds

", "smithy.api#required": {} } }, "Instruction": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { - "smithy.api#documentation": "

Brief description of the step in the requested language.

\n \n

Only available when the TravelStepType is Default.

\n
" + "smithy.api#documentation": "

Brief description of the step in the requested language.

Only available when the TravelStepType is Default.

" } }, "Type": { @@ -3477,7 +3493,8 @@ "name": "BOARD", "value": "Board" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteFerryDeparture": { @@ -3535,19 +3552,19 @@ "Notices": { "target": "com.amazonaws.georoutes#RouteFerryNoticeList", "traits": { - "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during\n route calculation.

", + "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during route calculation.

", "smithy.api#required": {} } }, "PassThroughWaypoints": { "target": "com.amazonaws.georoutes#RoutePassThroughWaypointList", "traits": { - "smithy.api#documentation": "

Waypoints that were passed through during the leg. This includes the waypoints that were\n configured with the PassThrough option.

", + "smithy.api#documentation": "

Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.

", "smithy.api#required": {} } }, "RouteName": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

Route name of the ferry line.

" } @@ -3574,7 +3591,7 @@ } }, "traits": { - "smithy.api#documentation": "

FerryLegDetails is populated when the Leg type is Ferry, and provides additional\n information that is specific

" + "smithy.api#documentation": "

FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific

" } }, "com.amazonaws.georoutes#RouteFerryNotice": { @@ -3590,12 +3607,12 @@ "Impact": { "target": "com.amazonaws.georoutes#RouteNoticeImpact", "traits": { - "smithy.api#documentation": "

Impact corresponding to the issue. While Low impact notices can be safely ignored, High\n impact notices must be evaluated further to determine the impact.

" + "smithy.api#documentation": "

Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.

" } } }, "traits": { - "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during\n route calculation.

" + "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during route calculation.

" } }, "com.amazonaws.georoutes#RouteFerryNoticeCode": { @@ -3625,6 +3642,10 @@ { "name": "SEASONAL_CLOSURE", "value": "SeasonalClosure" + }, + { + "name": "POTENTIAL_VIOLATED_VEHICLE_RESTRICTION_USAGE", + "value": "PotentialViolatedVehicleRestrictionUsage" } ] } @@ -3650,7 +3671,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the step.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Duration of the step.

Unit: seconds

", "smithy.api#required": {} } } @@ -3663,7 +3684,7 @@ "type": "structure", "members": { "Name": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

The name of the place.

" } @@ -3682,7 +3703,7 @@ } }, "WaypointIndex": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#documentation": "

Index of the waypoint in the request.

", "smithy.api#range": { @@ -3708,14 +3729,14 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Distance of the computed span. This feature doesn't split a span, but is always computed\n on a span split by other properties.

\n

\n Unit: meters\n

" + "smithy.api#documentation": "

Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

Unit: meters

" } }, "Duration": { "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the computed span. This feature doesn't split a span, but is always computed\n on a span split by other properties.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

Unit: seconds

" } }, "GeometryOffset": { @@ -3734,9 +3755,9 @@ } }, "Region": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { - "smithy.api#documentation": "

2-3 letter Region code corresponding to the Span. This is either a province or a\n state.

", + "smithy.api#documentation": "

2-3 letter Region code corresponding to the Span. This is either a province or a state.

", "smithy.api#length": { "min": 0, "max": 3 @@ -3760,18 +3781,18 @@ "Overview": { "target": "com.amazonaws.georoutes#RouteFerryOverviewSummary", "traits": { - "smithy.api#documentation": "

Summarized details for the leg including before travel, travel and after travel\n steps.

" + "smithy.api#documentation": "

Summarized details for the leg including before travel, travel and after travel steps.

" } }, "TravelOnly": { "target": "com.amazonaws.georoutes#RouteFerryTravelOnlySummary", "traits": { - "smithy.api#documentation": "

Summarized details for the leg including travel steps only. The Distance for the travel\n only portion of the journey is in meters

" + "smithy.api#documentation": "

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters

" } } }, "traits": { - "smithy.api#documentation": "

Summarized details for the leg including travel steps only. The Distance for the travel\n only portion of the journey is the same as the Distance within the Overview summary.

" + "smithy.api#documentation": "

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is the same as the Distance within the Overview summary.

" } }, "com.amazonaws.georoutes#RouteFerryTravelOnlySummary": { @@ -3781,13 +3802,13 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Total duration in free flowing traffic, which is the best case or shortest duration\n possible to cover the leg.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.

Unit: seconds

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Summarized details for the leg including travel steps only. The Distance for the travel\n only portion of the journey is the same as the Distance within the Overview summary.

" + "smithy.api#documentation": "

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is the same as the Distance within the Overview summary.

" } }, "com.amazonaws.georoutes#RouteFerryTravelStep": { @@ -3804,7 +3825,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the step.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Duration of the step.

Unit: seconds

", "smithy.api#required": {} } }, @@ -3818,9 +3839,9 @@ } }, "Instruction": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { - "smithy.api#documentation": "

Brief description of the step in the requested language.

\n \n

Only available when the TravelStepType is Default.

\n
" + "smithy.api#documentation": "

Brief description of the step in the requested language.

Only available when the TravelStepType is Default.

" } }, "Type": { @@ -3857,7 +3878,8 @@ "name": "ARRIVE", "value": "Arrive" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteHazardousCargoType": { @@ -3908,7 +3930,8 @@ "name": "RADIOACTIVE", "value": "Radioactive" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteHazardousCargoTypeList": { @@ -3963,7 +3986,7 @@ "FerryLegDetails": { "target": "com.amazonaws.georoutes#RouteFerryLegDetails", "traits": { - "smithy.api#documentation": "

FerryLegDetails is populated when the Leg type is Ferry, and provides additional\n information that is specific

" + "smithy.api#documentation": "

FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific

" } }, "Geometry": { @@ -3988,7 +4011,7 @@ "TravelMode": { "target": "com.amazonaws.georoutes#RouteLegTravelMode", "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

Default Value: Car\n

", + "smithy.api#documentation": "

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

", "smithy.api#required": {} } }, @@ -4007,7 +4030,7 @@ } }, "traits": { - "smithy.api#documentation": "

A leg is a section of a route from one waypoint to the next. A leg could be of type\n Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single\n route. For example, a car employing the use of a Ferry will contain Vehicle legs\n corresponding to journey on land, and Ferry legs corresponding to the journey via\n Ferry.

" + "smithy.api#documentation": "

A leg is a section of a route from one waypoint to the next. A leg could be of type Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single route. For example, a car employing the use of a Ferry will contain Vehicle legs corresponding to journey on land, and Ferry legs corresponding to the journey via Ferry.

" } }, "com.amazonaws.georoutes#RouteLegAdditionalFeature": { @@ -4050,7 +4073,8 @@ "name": "ZONES", "value": "Zones" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteLegAdditionalFeatureList": { @@ -4071,13 +4095,13 @@ "LineString": { "target": "com.amazonaws.georoutes#LineString", "traits": { - "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map.

\n \n

LineString and Polyline are mutually exclusive properties.

\n
" + "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map.

LineString and Polyline are mutually exclusive properties.

" } }, "Polyline": { "target": "com.amazonaws.georoutes#Polyline", "traits": { - "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map in a lossy compression\n format.

\n \n

LineString and Polyline are mutually exclusive properties.

\n
" + "smithy.api#documentation": "

An ordered list of positions used to plot a route on a map in a lossy compression format.

LineString and Polyline are mutually exclusive properties.

" } } }, @@ -4119,7 +4143,8 @@ "name": "CAR_SHUTTLE_TRAIN", "value": "CarShuttleTrain" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteLegType": { @@ -4138,7 +4163,8 @@ "name": "VEHICLE", "value": "Vehicle" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteList": { @@ -4164,7 +4190,7 @@ } }, "traits": { - "smithy.api#documentation": "

Important labels including names and route numbers that differentiate the current route\n from the alternatives presented.

" + "smithy.api#documentation": "

Important labels including names and route numbers that differentiate the current route from the alternatives presented.

" } }, "com.amazonaws.georoutes#RouteMajorRoadLabelList": { @@ -4189,20 +4215,20 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint\n will be snapped to the highway/bridge/tunnel/sliproad.

\n

\n Unit: meters\n

" + "smithy.api#documentation": "

If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.

Unit: meters

" } }, "Radius": { "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Considers all roads within the provided radius to match the provided destination to. The\n roads that are considered are determined by the provided Strategy.

\n

\n Unit: Meters\n

" + "smithy.api#documentation": "

Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

Unit: Meters

" } }, "Strategy": { "target": "com.amazonaws.georoutes#MatchingStrategy", "traits": { - "smithy.api#documentation": "

Strategy that defines matching of the position onto the road network. MatchAny considers\n all roads possible, whereas MatchMostSignificantRoad matches to the most significant\n road.

" + "smithy.api#documentation": "

Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

" } } }, @@ -4220,20 +4246,21 @@ "type": "structure", "members": { "Hot": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { - "smithy.api#documentation": "

Allow Hot (High Occupancy Toll) lanes while calculating the route.

\n

Default value: false\n

" + "smithy.api#documentation": "

Allow Hot (High Occupancy Toll) lanes while calculating the route.

Default value: false

" } }, "Hov": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { - "smithy.api#documentation": "

Allow Hov (High Occupancy vehicle) lanes while calculating the route.

\n

Default value: false\n

" + "smithy.api#documentation": "

Allow Hov (High Occupancy vehicle) lanes while calculating the route.

Default value: false

" } } }, "traits": { - "smithy.api#documentation": "

Allow Options related to the route matrix.

" + "smithy.api#documentation": "

Allow Options related to the route matrix.

", + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteMatrixAutoCircle": { @@ -4287,7 +4314,7 @@ "BoundingBox": { "target": "com.amazonaws.georoutes#BoundingBox", "traits": { - "smithy.api#documentation": "

Geometry defined as a bounding box. The first pair represents the X and Y coordinates\n (longitude and latitude,) of the southwest corner of the bounding box; the second pair\n represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" + "smithy.api#documentation": "

Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" } }, "Polygon": { @@ -4303,7 +4330,7 @@ "PolylinePolygon": { "target": "com.amazonaws.georoutes#PolylineRingList", "traits": { - "smithy.api#documentation": "

A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains\n PolylinePolygon of the first linear ring (the outer ring) and from second item to the last\n item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

", + "smithy.api#documentation": "

A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from second item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

", "smithy.api#length": { "min": 1, "max": 1 @@ -4334,37 +4361,37 @@ } }, "CarShuttleTrains": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid car-shuttle-trains while calculating the route.

" } }, "ControlledAccessHighways": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid controlled access highways while calculating the route.

" } }, "DirtRoads": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid dirt roads while calculating the route.

" } }, "Ferries": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid ferries while calculating the route.

" } }, "TollRoads": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoids roads where the specified toll transponders are the only mode of payment.

" } }, "TollTransponders": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoids roads where the specified toll transponders are the only mode of payment.

" } @@ -4372,17 +4399,17 @@ "TruckRoadTypes": { "target": "com.amazonaws.georoutes#TruckRoadTypeList", "traits": { - "smithy.api#documentation": "

Truck road type identifiers. BK1 through BK4 apply only to\n Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

\n \n

There are currently no other supported values as of 26th April 2024.

\n
" + "smithy.api#documentation": "

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

" } }, "Tunnels": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid tunnels while calculating the route.

" } }, "UTurns": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid U-turns for calculation on highways and motorways.

" } @@ -4395,7 +4422,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies options for areas to avoid when calculating the route. This is a best-effort\n avoidance setting, meaning the router will try to honor the avoidance preferences but may\n still include restricted areas if no feasible alternative route exists. If avoidance\n options are not followed, the response will indicate that the avoidance criteria were\n violated.

" + "smithy.api#documentation": "

Specifies options for areas to avoid when calculating the route. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.

" } }, "com.amazonaws.georoutes#RouteMatrixAvoidanceZoneCategory": { @@ -4434,14 +4461,14 @@ } }, "Unbounded": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { - "smithy.api#documentation": "

No restrictions in terms of a routing boundary, and is typically used for longer\n routes.

" + "smithy.api#documentation": "

No restrictions in terms of a routing boundary, and is typically used for longer routes.

" } } }, "traits": { - "smithy.api#documentation": "

Boundary within which the matrix is to be calculated. All data, origins and destinations\n outside the boundary are considered invalid.

" + "smithy.api#documentation": "

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

" } }, "com.amazonaws.georoutes#RouteMatrixBoundaryGeometry": { @@ -4456,13 +4483,13 @@ "Circle": { "target": "com.amazonaws.georoutes#Circle", "traits": { - "smithy.api#documentation": "

Geometry defined as a circle. When request routing boundary was set as\n AutoCircle, the response routing boundary will return Circle\n derived from the AutoCircle settings.

" + "smithy.api#documentation": "

Geometry defined as a circle. When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

" } }, "BoundingBox": { "target": "com.amazonaws.georoutes#BoundingBox", "traits": { - "smithy.api#documentation": "

Geometry defined as a bounding box. The first pair represents the X and Y coordinates\n (longitude and latitude,) of the southwest corner of the bounding box; the second pair\n represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" + "smithy.api#documentation": "

Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" } }, "Polygon": { @@ -4493,7 +4520,7 @@ "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Maximum speed

\n

\n Unit: KilometersPerHour\n

", + "smithy.api#documentation": "

Maximum speed

Unit: KilometersPerHour

", "smithy.api#range": { "min": 3.6, "max": 252.0 @@ -4501,10 +4528,10 @@ } }, "Occupancy": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The number of occupants in the vehicle.

\n

Default Value: 1\n

", + "smithy.api#documentation": "

The number of occupants in the vehicle.

Default Value: 1

", "smithy.api#range": { "min": 1 } @@ -4549,7 +4576,7 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Avoids actions for the provided distance. This is typically to consider for users in\n moving vehicles who may not have sufficient time to make an action at an origin or a\n destination.

", + "smithy.api#documentation": "

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

", "smithy.api#range": { "min": 0 } @@ -4594,7 +4621,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The expected duration of travel for the route.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

The expected duration of travel for the route.

Unit: seconds

", "smithy.api#required": {} } }, @@ -4606,7 +4633,7 @@ } }, "traits": { - "smithy.api#documentation": "

The calculated route matrix containing the results for all pairs of Origins to\n Destination positions. Each row corresponds to one entry in Origins. Each entry in the row\n corresponds to the route from that entry in Origins to an entry in Destination\n positions.

" + "smithy.api#documentation": "

The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions.

" } }, "com.amazonaws.georoutes#RouteMatrixErrorCode": { @@ -4658,13 +4685,13 @@ "Countries": { "target": "com.amazonaws.georoutes#CountryCodeList", "traits": { - "smithy.api#documentation": "

List of countries to be avoided defined by two-letter or three-letter country\n codes.

", + "smithy.api#documentation": "

List of countries to be avoided defined by two-letter or three-letter country codes.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Specifies strict exclusion options for the route calculation. This setting mandates that\n the router will avoid any routes that include the specified options, rather than merely\n attempting to minimize them.

" + "smithy.api#documentation": "

Specifies strict exclusion options for the route calculation. This setting mandates that the router will avoid any routes that include the specified options, rather than merely attempting to minimize them.

" } }, "com.amazonaws.georoutes#RouteMatrixHazardousCargoType": { @@ -4715,7 +4742,8 @@ "name": "RADIOACTIVE", "value": "Radioactive" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteMatrixHazardousCargoTypeList": { @@ -4743,7 +4771,7 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint\n will be snapped to the highway/bridge/tunnel/sliproad.

\n

\n Unit: meters\n

", + "smithy.api#documentation": "

If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.

Unit: meters

", "smithy.api#range": { "min": 0 } @@ -4753,13 +4781,13 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Considers all roads within the provided radius to match the provided destination to. The\n roads that are considered are determined by the provided Strategy.

\n

\n Unit: Meters\n

" + "smithy.api#documentation": "

Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

Unit: Meters

" } }, "Strategy": { "target": "com.amazonaws.georoutes#MatchingStrategy", "traits": { - "smithy.api#documentation": "

Strategy that defines matching of the position onto the road network. MatchAny considers\n all roads possible, whereas MatchMostSignificantRoad matches to the most significant\n road.

" + "smithy.api#documentation": "

Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

" } } }, @@ -4801,7 +4829,7 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Avoids actions for the provided distance. This is typically to consider for users in\n moving vehicles who may not have sufficient time to make an action at an origin or a\n destination.

", + "smithy.api#documentation": "

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

", "smithy.api#range": { "min": 0 } @@ -4850,7 +4878,7 @@ "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Maximum speed.

\n

\n Unit: KilometersPerHour\n

", + "smithy.api#documentation": "

Maximum speed.

Unit: KilometersPerHour

", "smithy.api#range": { "min": 3.6, "max": 252.0 @@ -4858,10 +4886,10 @@ } }, "Occupancy": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The number of occupants in the vehicle.

\n

Default Value: 1\n

", + "smithy.api#documentation": "

The number of occupants in the vehicle.

Default Value: 1

", "smithy.api#range": { "min": 1 } @@ -4869,7 +4897,7 @@ } }, "traits": { - "smithy.api#documentation": "

Travel mode options when the provided travel mode is Scooter\n

" + "smithy.api#documentation": "

Travel mode options when the provided travel mode is Scooter

" } }, "com.amazonaws.georoutes#RouteMatrixSideOfStreetOptions": { @@ -4885,7 +4913,7 @@ "UseWith": { "target": "com.amazonaws.georoutes#SideOfStreetMatchingStrategy", "traits": { - "smithy.api#documentation": "

Strategy that defines when the side of street position should be used. AnyStreet will\n always use the provided position.

\n

Default Value: DividedStreetOnly\n

" + "smithy.api#documentation": "

Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.

Default Value: DividedStreetOnly

" } } }, @@ -4900,13 +4928,13 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration for which flow traffic is considered valid. For this period, the flow traffic\n is used over historical traffic data. Flow traffic refers to congestion, which changes very\n quickly. Duration in seconds for which flow traffic event would be considered valid. While\n flow traffic event is valid it will be used over the historical traffic data.

" + "smithy.api#documentation": "

Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.

" } }, "Usage": { "target": "com.amazonaws.georoutes#TrafficUsage", "traits": { - "smithy.api#documentation": "

Determines if traffic should be used or ignored while calculating the route.

\n

Default Value: UseTrafficData\n

" + "smithy.api#documentation": "

Determines if traffic should be used or ignored while calculating the route.

Default Value: UseTrafficData

" } } }, @@ -4918,9 +4946,9 @@ "type": "structure", "members": { "TrailerCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { - "smithy.api#documentation": "

Number of trailers attached to the vehicle.

\n

Default Value: 0\n

", + "smithy.api#documentation": "

Number of trailers attached to the vehicle.

Default Value: 0

", "smithy.api#range": { "min": 0, "max": 255 @@ -4967,7 +4995,7 @@ "Scooter": { "target": "com.amazonaws.georoutes#RouteMatrixScooterOptions", "traits": { - "smithy.api#documentation": "

Travel mode options when the provided travel mode is Scooter\n

\n \n

When travel mode is set to Scooter, then the avoidance option\n ControlledAccessHighways defaults to true.

\n
" + "smithy.api#documentation": "

Travel mode options when the provided travel mode is Scooter

When travel mode is set to Scooter, then the avoidance option ControlledAccessHighways defaults to true.

" } }, "Truck": { @@ -4985,7 +5013,7 @@ "type": "structure", "members": { "AxleCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Total number of axles of the vehicle.

", @@ -4999,7 +5027,7 @@ "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Gross weight of the vehicle including trailers, and goods at capacity.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Gross weight of the vehicle including trailers, and goods at capacity.

Unit: Kilograms

" } }, "HazardousCargos": { @@ -5012,7 +5040,7 @@ "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Height of the vehicle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Height of the vehicle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 5000 @@ -5023,14 +5051,14 @@ "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Kingpin to rear axle length of the vehicle

\n

\n Unit: centimeters\n

" + "smithy.api#documentation": "

Kingpin to rear axle length of the vehicle

Unit: centimeters

" } }, "Length": { "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Length of the vehicle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Length of the vehicle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 30000 @@ -5047,7 +5075,7 @@ "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Maximum speed

\n

\n Unit: KilometersPerHour\n

", + "smithy.api#documentation": "

Maximum speed

Unit: KilometersPerHour

", "smithy.api#range": { "min": 3.6, "max": 252.0 @@ -5055,10 +5083,10 @@ } }, "Occupancy": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The number of occupants in the vehicle.

\n

Default Value: 1\n

", + "smithy.api#documentation": "

The number of occupants in the vehicle.

Default Value: 1

", "smithy.api#range": { "min": 1 } @@ -5068,7 +5096,7 @@ "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Payload capacity of the vehicle and trailers attached.

\n

\n Unit: kilograms\n

" + "smithy.api#documentation": "

Payload capacity of the vehicle and trailers attached.

Unit: kilograms

" } }, "Trailer": { @@ -5086,27 +5114,27 @@ "TunnelRestrictionCode": { "target": "com.amazonaws.georoutes#TunnelRestrictionCode", "traits": { - "smithy.api#documentation": "

The tunnel restriction code.

\n

Tunnel categories in this list indicate the restrictions which apply to certain tunnels\n in Great Britain. They relate to the types of dangerous goods that can be transported\n through them.

\n
    \n
  • \n

    \n Tunnel Category B\n

    \n
      \n
    • \n

      \n Risk Level: Limited risk

      \n
    • \n
    • \n

      \n Restrictions: Few restrictions

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category C\n

    \n
      \n
    • \n

      \n Risk Level: Medium risk

      \n
    • \n
    • \n

      \n Restrictions: Some restrictions

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category D\n

    \n
      \n
    • \n

      \n Risk Level: High risk

      \n
    • \n
    • \n

      \n Restrictions: Many restrictions occur

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category E\n

    \n
      \n
    • \n

      \n Risk Level: Very high risk

      \n
    • \n
    • \n

      \n Restrictions: Restricted tunnel

      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

  • Tunnel Category B

    • Risk Level: Limited risk

    • Restrictions: Few restrictions

  • Tunnel Category C

    • Risk Level: Medium risk

    • Restrictions: Some restrictions

  • Tunnel Category D

    • Risk Level: High risk

    • Restrictions: Many restrictions occur

  • Tunnel Category E

    • Risk Level: Very high risk

    • Restrictions: Restricted tunnel

" } }, "WeightPerAxle": { "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Heaviest weight per axle irrespective of the axle type or the axle group. Meant for\n usage in countries where the differences in axle types or axle groups are not\n distinguished.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.

Unit: Kilograms

" } }, "WeightPerAxleGroup": { "target": "com.amazonaws.georoutes#WeightPerAxleGroup", "traits": { - "smithy.api#documentation": "

Specifies the total weight for the specified axle group. Meant for usage in countries\n that have different regulations based on the axle group type.

" + "smithy.api#documentation": "

Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.

" } }, "Width": { "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Width of the vehicle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Width of the vehicle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 5000 @@ -5134,7 +5162,8 @@ "name": "TRACTOR", "value": "Tractor" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteMatrixVehicleLicensePlate": { @@ -5152,7 +5181,8 @@ } }, "traits": { - "smithy.api#documentation": "

The vehicle License Plate.

" + "smithy.api#documentation": "

The vehicle License Plate.

", + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteMatrixZoneCategory": { @@ -5171,7 +5201,8 @@ "name": "VIGNETTE", "value": "Vignette" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteNoticeDetailRange": { @@ -5231,7 +5262,7 @@ } }, "Value": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

The route number.

", "smithy.api#required": {} @@ -5255,14 +5286,14 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Avoids actions for the provided distance. This is typically to consider for users in\n moving vehicles who may not have sufficient time to make an action at an origin or a\n destination.

", + "smithy.api#documentation": "

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

", "smithy.api#range": { "max": 2000 } } }, "AvoidUTurns": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid U-turns for calculation on highways and motorways.

" } @@ -5308,7 +5339,7 @@ } }, "WaypointIndex": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#documentation": "

Index of the waypoint in the request.

", "smithy.api#range": { @@ -5342,7 +5373,7 @@ } }, "traits": { - "smithy.api#documentation": "

If the waypoint should be treated as a stop. If yes, the route is split up into\n different legs around the stop.

" + "smithy.api#documentation": "

If the waypoint should be treated as a stop. If yes, the route is split up into different legs around the stop.

" } }, "com.amazonaws.georoutes#RoutePassThroughWaypointList": { @@ -5369,7 +5400,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details corresponding to the arrival for a leg.

\n

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n

\n

Examples:

\n

\n 2020-04-22T17:57:24Z\n

\n

\n 2020-04-22T17:57:24+02:00\n

" + "smithy.api#documentation": "

Details corresponding to the arrival for a leg.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" } }, "com.amazonaws.georoutes#RoutePedestrianDeparture": { @@ -5390,7 +5421,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details corresponding to the departure for a leg.

\n

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n

\n

Examples:

\n

\n 2020-04-22T17:57:24Z\n

\n

\n 2020-04-22T17:57:24+02:00\n

" + "smithy.api#documentation": "

Details corresponding to the departure for a leg.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" } }, "com.amazonaws.georoutes#RoutePedestrianLegDetails": { @@ -5413,14 +5444,14 @@ "Notices": { "target": "com.amazonaws.georoutes#RoutePedestrianNoticeList", "traits": { - "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during\n route calculation.

", + "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during route calculation.

", "smithy.api#required": {} } }, "PassThroughWaypoints": { "target": "com.amazonaws.georoutes#RoutePassThroughWaypointList", "traits": { - "smithy.api#documentation": "

Waypoints that were passed through during the leg. This includes the waypoints that were\n configured with the PassThrough option.

", + "smithy.api#documentation": "

Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.

", "smithy.api#required": {} } }, @@ -5462,12 +5493,12 @@ "Impact": { "target": "com.amazonaws.georoutes#RouteNoticeImpact", "traits": { - "smithy.api#documentation": "

Impact corresponding to the issue. While Low impact notices can be safely ignored, High\n impact notices must be evaluated further to determine the impact.

" + "smithy.api#documentation": "

Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.

" } } }, "traits": { - "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during\n route calculation.

" + "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during route calculation.

" } }, "com.amazonaws.georoutes#RoutePedestrianNoticeCode": { @@ -5550,7 +5581,7 @@ "type": "structure", "members": { "Name": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

The name of the place.

" } @@ -5575,7 +5606,7 @@ } }, "WaypointIndex": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#documentation": "

Index of the waypoint in the request.

", "smithy.api#range": { @@ -5595,7 +5626,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the computed span without traffic congestion.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Duration of the computed span without traffic congestion.

Unit: seconds

" } }, "Country": { @@ -5608,24 +5639,24 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Distance of the computed span. This feature doesn't split a span, but is always computed\n on a span split by other properties.

" + "smithy.api#documentation": "

Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

" } }, "Duration": { "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the computed span. This feature doesn't split a span, but is always computed\n on a span split by other properties.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

Unit: seconds

" } }, "DynamicSpeed": { "target": "com.amazonaws.georoutes#RouteSpanDynamicSpeedDetails", "traits": { - "smithy.api#documentation": "

Dynamic speed details corresponding to the span.

\n

\n Unit: KilometersPerHour\n

" + "smithy.api#documentation": "

Dynamic speed details corresponding to the span.

Unit: KilometersPerHour

" } }, "FunctionalClassification": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#documentation": "

Functional classification of the road segment corresponding to the span.

", "smithy.api#range": { @@ -5646,7 +5677,7 @@ "Incidents": { "target": "com.amazonaws.georoutes#IndexList", "traits": { - "smithy.api#documentation": "

Incidents corresponding to the span. These index into the Incidents in the parent\n Leg.

" + "smithy.api#documentation": "

Incidents corresponding to the span. These index into the Incidents in the parent Leg.

" } }, "Names": { @@ -5662,9 +5693,9 @@ } }, "Region": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { - "smithy.api#documentation": "

2-3 letter Region code corresponding to the Span. This is either a province or a\n state.

", + "smithy.api#documentation": "

2-3 letter Region code corresponding to the Span. This is either a province or a state.

", "smithy.api#length": { "min": 0, "max": 3 @@ -5686,14 +5717,14 @@ "SpeedLimit": { "target": "com.amazonaws.georoutes#RouteSpanSpeedLimitDetails", "traits": { - "smithy.api#documentation": "

Speed limit details corresponding to the span.

\n

\n Unit: KilometersPerHour\n

" + "smithy.api#documentation": "

Speed limit details corresponding to the span.

Unit: KilometersPerHour

" } }, "TypicalDuration": { "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the computed span under typical traffic congestion.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Duration of the computed span under typical traffic congestion.

Unit: seconds

" } } }, @@ -5713,18 +5744,18 @@ "Overview": { "target": "com.amazonaws.georoutes#RoutePedestrianOverviewSummary", "traits": { - "smithy.api#documentation": "

Summarized details for the leg including before travel, travel and after travel\n steps.

" + "smithy.api#documentation": "

Summarized details for the leg including before travel, travel and after travel steps.

" } }, "TravelOnly": { "target": "com.amazonaws.georoutes#RoutePedestrianTravelOnlySummary", "traits": { - "smithy.api#documentation": "

Summarized details for the leg including travel steps only. The Distance for the travel\n only portion of the journey is in meters

" + "smithy.api#documentation": "

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters

" } } }, "traits": { - "smithy.api#documentation": "

Summarized details for the leg including before travel, travel and after travel\n steps.

" + "smithy.api#documentation": "

Summarized details for the leg including before travel, travel and after travel steps.

" } }, "com.amazonaws.georoutes#RoutePedestrianTravelOnlySummary": { @@ -5734,7 +5765,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the step.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Duration of the step.

Unit: seconds

", "smithy.api#required": {} } } @@ -5769,7 +5800,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the step.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Duration of the step.

Unit: seconds

", "smithy.api#required": {} } }, @@ -5789,9 +5820,9 @@ } }, "Instruction": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { - "smithy.api#documentation": "

Brief description of the step in the requested language.

\n \n

Only available when the TravelStepType is Default.

\n
" + "smithy.api#documentation": "

Brief description of the step in the requested language.

Only available when the TravelStepType is Default.

" } }, "KeepStepDetails": { @@ -5827,7 +5858,7 @@ "Signpost": { "target": "com.amazonaws.georoutes#RouteSignpost", "traits": { - "smithy.api#documentation": "

Sign post information of the action, applicable only for TurnByTurn steps. See\n RouteSignpost for details of sub-attributes.

" + "smithy.api#documentation": "

Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.

" } }, "TurnStepDetails": { @@ -5902,7 +5933,8 @@ "name": "U_TURN", "value": "UTurn" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteRampStepDetails": { @@ -5952,12 +5984,12 @@ "Impact": { "target": "com.amazonaws.georoutes#RouteNoticeImpact", "traits": { - "smithy.api#documentation": "

Impact corresponding to the issue. While Low impact notices can be safely ignored, High\n impact notices must be evaluated further to determine the impact.

" + "smithy.api#documentation": "

Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.

" } } }, "traits": { - "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during\n route calculation.

" + "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during route calculation.

" } }, "com.amazonaws.georoutes#RouteResponseNoticeCode": { @@ -6036,7 +6068,8 @@ "name": "URBAN", "value": "Urban" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteRoundaboutEnterStepDetails": { @@ -6084,7 +6117,7 @@ } }, "RelativeExit": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Exit to be taken.

", @@ -6165,7 +6198,7 @@ "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Maximum speed

\n

\n Unit: KilometersPerHour\n

", + "smithy.api#documentation": "

Maximum speed

Unit: KilometersPerHour

", "smithy.api#range": { "min": 3.6, "max": 252.0 @@ -6173,10 +6206,10 @@ } }, "Occupancy": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The number of occupants in the vehicle.

\n

Default Value: 1\n

", + "smithy.api#documentation": "

The number of occupants in the vehicle.

Default Value: 1

", "smithy.api#range": { "min": 1 } @@ -6184,7 +6217,7 @@ } }, "traits": { - "smithy.api#documentation": "

Travel mode options when the provided travel mode is Scooter\n

" + "smithy.api#documentation": "

Travel mode options when the provided travel mode is Scooter

" } }, "com.amazonaws.georoutes#RouteSideOfStreet": { @@ -6199,7 +6232,8 @@ "name": "RIGHT", "value": "Right" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteSideOfStreetOptions": { @@ -6215,7 +6249,7 @@ "UseWith": { "target": "com.amazonaws.georoutes#SideOfStreetMatchingStrategy", "traits": { - "smithy.api#documentation": "

Strategy that defines when the side of street position should be used.

\n

Default Value: DividedStreetOnly\n

" + "smithy.api#documentation": "

Strategy that defines when the side of street position should be used.

Default Value: DividedStreetOnly

" } } }, @@ -6235,7 +6269,7 @@ } }, "traits": { - "smithy.api#documentation": "

Sign post information of the action, applicable only for TurnByTurn steps. See\n RouteSignpost for details of sub-attributes.

" + "smithy.api#documentation": "

Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.

" } }, "com.amazonaws.georoutes#RouteSignpostLabel": { @@ -6395,7 +6429,8 @@ "name": "TOLL_ROAD", "value": "TollRoad" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteSpanCarAccessAttributeList": { @@ -6417,26 +6452,26 @@ "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Estimated speed while traversing the span without traffic congestion.

\n

\n Unit: KilometersPerHour\n

" + "smithy.api#documentation": "

Estimated speed while traversing the span without traffic congestion.

Unit: KilometersPerHour

" } }, "TurnDuration": { "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Estimated time to turn from this span into the next.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Estimated time to turn from this span into the next.

Unit: seconds

" } }, "TypicalSpeed": { "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Estimated speed while traversing the span under typical traffic congestion.

\n

\n Unit: KilometersPerHour\n

" + "smithy.api#documentation": "

Estimated speed while traversing the span under typical traffic congestion.

Unit: KilometersPerHour

" } } }, "traits": { - "smithy.api#documentation": "

Details about the dynamic speed.

\n

\n Unit: KilometersPerHour\n

" + "smithy.api#documentation": "

Details about the dynamic speed.

Unit: KilometersPerHour

" } }, "com.amazonaws.georoutes#RouteSpanGateAttribute": { @@ -6455,7 +6490,8 @@ "name": "PERMISSION_REQUIRED", "value": "PermissionRequired" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteSpanPedestrianAccessAttribute": { @@ -6486,7 +6522,8 @@ "name": "TOLL_ROAD", "value": "TollRoad" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteSpanPedestrianAccessAttributeList": { @@ -6513,7 +6550,8 @@ "name": "UNPROTECTED", "value": "Unprotected" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteSpanRoadAttribute": { @@ -6568,7 +6606,8 @@ "name": "UNDER_CONSTRUCTION", "value": "UnderConstruction" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteSpanRoadAttributeList": { @@ -6599,7 +6638,8 @@ "name": "TOLL_ROAD", "value": "TollRoad" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteSpanScooterAccessAttributeList": { @@ -6621,18 +6661,18 @@ "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Maximum speed.

\n

\n Unit: KilometersPerHour\n

" + "smithy.api#documentation": "

Maximum speed.

Unit: KilometersPerHour

" } }, "Unlimited": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

If the span doesn't have a speed limit like the Autobahn.

" } } }, "traits": { - "smithy.api#documentation": "

Details about the speed limit corresponding to the span.

\n

\n Unit: KilometersPerHour\n

" + "smithy.api#documentation": "

Details about the speed limit corresponding to the span.

Unit: KilometersPerHour

" } }, "com.amazonaws.georoutes#RouteSpanTruckAccessAttribute": { @@ -6651,7 +6691,8 @@ "name": "TOLL_ROAD", "value": "TollRoad" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteSpanTruckAccessAttributeList": { @@ -6682,7 +6723,8 @@ "name": "STRAIGHT", "value": "Straight" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteSummary": { @@ -6699,7 +6741,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the route.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Duration of the route.

Unit: seconds

" } }, "Tolls": { @@ -6710,7 +6752,7 @@ } }, "traits": { - "smithy.api#documentation": "

Summarized details for the leg including travel steps only. The Distance for the travel\n only portion of the journey is the same as the Distance within the Overview summary.

" + "smithy.api#documentation": "

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is the same as the Distance within the Overview summary.

" } }, "com.amazonaws.georoutes#RouteToll": { @@ -6745,7 +6787,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides details about toll information along a route, including the payment sites,\n applicable toll rates, toll systems, and the country associated with the toll\n collection.

" + "smithy.api#documentation": "

Provides details about toll information along a route, including the payment sites, applicable toll rates, toll systems, and the country associated with the toll collection.

" } }, "com.amazonaws.georoutes#RouteTollList": { @@ -6758,27 +6800,27 @@ "type": "structure", "members": { "AllTransponders": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { - "smithy.api#documentation": "

Specifies if the user has valid transponder with access to all toll systems. This\n impacts toll calculation, and if true the price with transponders is used.

" + "smithy.api#documentation": "

Specifies if the user has valid transponder with access to all toll systems. This impacts toll calculation, and if true the price with transponders is used.

" } }, "AllVignettes": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { - "smithy.api#documentation": "

Specifies if the user has valid vignettes with access for all toll roads. If a user has\n a vignette for a toll road, then toll cost for that road is omitted since no further\n payment is necessary.

" + "smithy.api#documentation": "

Specifies if the user has valid vignettes with access for all toll roads. If a user has a vignette for a toll road, then toll cost for that road is omitted since no further payment is necessary.

" } }, "Currency": { "target": "com.amazonaws.georoutes#CurrencyCode", "traits": { - "smithy.api#documentation": "

Currency code corresponding to the price. This is the same as Currency specified in the\n request.

" + "smithy.api#documentation": "

Currency code corresponding to the price. This is the same as Currency specified in the request.

" } }, "EmissionType": { "target": "com.amazonaws.georoutes#RouteEmissionType", "traits": { - "smithy.api#documentation": "

Emission type of the vehicle for toll cost calculation.

\n

\n Valid values: Euro1, Euro2, Euro3, Euro4, Euro5,\n Euro6, EuroEev\n

" + "smithy.api#documentation": "

Emission type of the vehicle for toll cost calculation.

Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev

" } }, "VehicleCategory": { @@ -6796,19 +6838,19 @@ "type": "structure", "members": { "IncludesReturnTrip": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

If the pass includes the rate for the return leg of the trip.

" } }, "SeniorPass": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

If the pass is only valid for senior persons.

" } }, "TransferCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#documentation": "

If the toll pass can be transferred, and how many times.

", "smithy.api#range": { @@ -6817,7 +6859,7 @@ } }, "TripCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#documentation": "

Number of trips the pass is valid for.

", "smithy.api#range": { @@ -6847,7 +6889,7 @@ } }, "PeriodCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#documentation": "

Counts for the validity period.

", "smithy.api#range": { @@ -6884,7 +6926,8 @@ "name": "MONTHS", "value": "Months" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteTollPaymentMethod": { @@ -6923,7 +6966,8 @@ "name": "VIDEO_TOLL", "value": "VideoToll" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteTollPaymentMethodList": { @@ -6971,12 +7015,12 @@ "Currency": { "target": "com.amazonaws.georoutes#CurrencyCode", "traits": { - "smithy.api#documentation": "

Currency code corresponding to the price. This is the same as Currency specified in the\n request.

", + "smithy.api#documentation": "

Currency code corresponding to the price. This is the same as Currency specified in the request.

", "smithy.api#required": {} } }, "Estimate": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

If the price is an estimate or an exact value.

", "smithy.api#required": {} @@ -6986,13 +7030,13 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration for which the price corresponds to.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Duration for which the price corresponds to.

Unit: seconds

" } }, "Range": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { - "smithy.api#documentation": "

If the price is a range or an exact value. If any of the toll fares making up the route\n is a range, the overall price is also a range.

", + "smithy.api#documentation": "

If the price is a range or an exact value. If any of the toll fares making up the route is a range, the overall price is also a range.

", "smithy.api#required": {} } }, @@ -7003,7 +7047,7 @@ } }, "Value": { - "target": "smithy.api#Double", + "target": "com.amazonaws.georoutes#SensitiveDouble", "traits": { "smithy.api#documentation": "

Exact price, if not a range.

", "smithy.api#range": { @@ -7023,21 +7067,21 @@ "Currency": { "target": "com.amazonaws.georoutes#CurrencyCode", "traits": { - "smithy.api#documentation": "

Currency code corresponding to the price. This is the same as Currency specified in the\n request.

", + "smithy.api#documentation": "

Currency code corresponding to the price. This is the same as Currency specified in the request.

", "smithy.api#required": {} } }, "Estimate": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

If the price is an estimate or an exact value.

", "smithy.api#required": {} } }, "Range": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { - "smithy.api#documentation": "

If the price is a range or an exact value. If any of the toll fares making up the route\n is a range, the overall price is also a range.

", + "smithy.api#documentation": "

If the price is a range or an exact value. If any of the toll fares making up the route is a range, the overall price is also a range.

", "smithy.api#required": {} } }, @@ -7048,7 +7092,7 @@ } }, "Value": { - "target": "smithy.api#Double", + "target": "com.amazonaws.georoutes#SensitiveDouble", "traits": { "smithy.api#documentation": "

Exact price, if not a range.

", "smithy.api#range": { @@ -7066,7 +7110,7 @@ "type": "structure", "members": { "Min": { - "target": "smithy.api#Double", + "target": "com.amazonaws.georoutes#SensitiveDouble", "traits": { "smithy.api#documentation": "

Minimum price.

", "smithy.api#range": { @@ -7076,7 +7120,7 @@ } }, "Max": { - "target": "smithy.api#Double", + "target": "com.amazonaws.georoutes#SensitiveDouble", "traits": { "smithy.api#documentation": "

Maximum price.

", "smithy.api#range": { @@ -7094,7 +7138,7 @@ "type": "structure", "members": { "ApplicableTimes": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

Time when the rate is valid.

" } @@ -7106,7 +7150,7 @@ } }, "Id": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

The Toll rate Id.

", "smithy.api#required": {} @@ -7120,7 +7164,7 @@ } }, "Name": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

The name of the toll.

", "smithy.api#required": {} @@ -7163,7 +7207,7 @@ "Total": { "target": "com.amazonaws.georoutes#RouteTollPriceSummary", "traits": { - "smithy.api#documentation": "

Total toll summary for the complete route. Total is the only summary available\n today.

" + "smithy.api#documentation": "

Total toll summary for the complete route. Total is the only summary available today.

" } } }, @@ -7175,7 +7219,7 @@ "type": "structure", "members": { "Name": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

The toll system name.

" } @@ -7199,7 +7243,8 @@ "name": "MINIBUS", "value": "Minibus" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteTrafficOptions": { @@ -7209,13 +7254,13 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration for which flow traffic is considered valid. For this period, the flow traffic\n is used over historical traffic data. Flow traffic refers to congestion, which changes very\n quickly. Duration in seconds for which flow traffic event would be considered valid. While\n flow traffic event is valid it will be used over the historical traffic data.

" + "smithy.api#documentation": "

Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.

" } }, "Usage": { "target": "com.amazonaws.georoutes#TrafficUsage", "traits": { - "smithy.api#documentation": "

Determines if traffic should be used or ignored while calculating the route.

\n

Default Value: UseTrafficData\n

" + "smithy.api#documentation": "

Determines if traffic should be used or ignored while calculating the route.

Default Value: UseTrafficData

" } } }, @@ -7227,7 +7272,7 @@ "type": "structure", "members": { "AxleCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Total number of axles of the vehicle.

", @@ -7237,10 +7282,10 @@ } }, "TrailerCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Number of trailers attached to the vehicle.

\n

Default Value: 0\n

", + "smithy.api#documentation": "

Number of trailers attached to the vehicle.

Default Value: 0

", "smithy.api#range": { "min": 1, "max": 255 @@ -7256,7 +7301,7 @@ "type": "structure", "members": { "SystemName": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

Names of the toll system collecting the toll.

" } @@ -7313,7 +7358,7 @@ "Scooter": { "target": "com.amazonaws.georoutes#RouteScooterOptions", "traits": { - "smithy.api#documentation": "

Travel mode options when the provided travel mode is Scooter\n

\n \n

When travel mode is set to Scooter, then the avoidance option\n ControlledAccessHighways defaults to true.

\n
" + "smithy.api#documentation": "

Travel mode options when the provided travel mode is Scooter

When travel mode is set to Scooter, then the avoidance option ControlledAccessHighways defaults to true.

" } }, "Truck": { @@ -7346,7 +7391,7 @@ "type": "structure", "members": { "AxleCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Total number of axles of the vehicle.

", @@ -7366,7 +7411,7 @@ "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Gross weight of the vehicle including trailers, and goods at capacity.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Gross weight of the vehicle including trailers, and goods at capacity.

Unit: Kilograms

" } }, "HazardousCargos": { @@ -7379,7 +7424,7 @@ "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Height of the vehicle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Height of the vehicle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 5000 @@ -7390,7 +7435,7 @@ "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Height of the vehicle above its first axle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Height of the vehicle above its first axle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 5000 @@ -7401,14 +7446,14 @@ "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Kingpin to rear axle length of the vehicle.

\n

\n Unit: centimeters\n

" + "smithy.api#documentation": "

Kingpin to rear axle length of the vehicle.

Unit: centimeters

" } }, "Length": { "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Length of the vehicle.

\n

\n Unit: c\n

", + "smithy.api#documentation": "

Length of the vehicle.

Unit: c

", "smithy.api#range": { "min": 0, "max": 30000 @@ -7425,7 +7470,7 @@ "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Maximum speed

\n

\n Unit: KilometersPerHour\n

", + "smithy.api#documentation": "

Maximum speed

Unit: KilometersPerHour

", "smithy.api#range": { "min": 3.6, "max": 252.0 @@ -7433,10 +7478,10 @@ } }, "Occupancy": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The number of occupants in the vehicle.

\n

Default Value: 1\n

", + "smithy.api#documentation": "

The number of occupants in the vehicle.

Default Value: 1

", "smithy.api#range": { "min": 1 } @@ -7446,11 +7491,11 @@ "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Payload capacity of the vehicle and trailers attached.

\n

\n Unit: kilograms\n

" + "smithy.api#documentation": "

Payload capacity of the vehicle and trailers attached.

Unit: kilograms

" } }, "TireCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Number of tires on the vehicle.

", @@ -7475,7 +7520,7 @@ "TunnelRestrictionCode": { "target": "com.amazonaws.georoutes#TunnelRestrictionCode", "traits": { - "smithy.api#documentation": "

The tunnel restriction code.

\n

Tunnel categories in this list indicate the restrictions which apply to certain tunnels\n in Great Britain. They relate to the types of dangerous goods that can be transported\n through them.

\n
    \n
  • \n

    \n Tunnel Category B\n

    \n
      \n
    • \n

      \n Risk Level: Limited risk

      \n
    • \n
    • \n

      \n Restrictions: Few restrictions

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category C\n

    \n
      \n
    • \n

      \n Risk Level: Medium risk

      \n
    • \n
    • \n

      \n Restrictions: Some restrictions

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category D\n

    \n
      \n
    • \n

      \n Risk Level: High risk

      \n
    • \n
    • \n

      \n Restrictions: Many restrictions occur

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category E\n

    \n
      \n
    • \n

      \n Risk Level: Very high risk

      \n
    • \n
    • \n

      \n Restrictions: Restricted tunnel

      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

  • Tunnel Category B

    • Risk Level: Limited risk

    • Restrictions: Few restrictions

  • Tunnel Category C

    • Risk Level: Medium risk

    • Restrictions: Some restrictions

  • Tunnel Category D

    • Risk Level: High risk

    • Restrictions: Many restrictions occur

  • Tunnel Category E

    • Risk Level: Very high risk

    • Restrictions: Restricted tunnel

", "smithy.api#length": { "max": 20 } @@ -7485,20 +7530,20 @@ "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Heaviest weight per axle irrespective of the axle type or the axle group. Meant for\n usage in countries where the differences in axle types or axle groups are not\n distinguished.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.

Unit: Kilograms

" } }, "WeightPerAxleGroup": { "target": "com.amazonaws.georoutes#WeightPerAxleGroup", "traits": { - "smithy.api#documentation": "

Specifies the total weight for the specified axle group. Meant for usage in countries\n that have different regulations based on the axle group type.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.

Unit: Kilograms

" } }, "Width": { "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Width of the vehicle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Width of the vehicle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 5000 @@ -7526,7 +7571,8 @@ "name": "TRACTOR", "value": "Tractor" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteTurnIntensity": { @@ -7545,7 +7591,8 @@ "name": "TYPICAL", "value": "Typical" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteTurnStepDetails": { @@ -7662,7 +7709,7 @@ "type": "structure", "members": { "Description": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

Brief readable description of the incident.

" } @@ -7676,7 +7723,7 @@ "Severity": { "target": "com.amazonaws.georoutes#RouteVehicleIncidentSeverity", "traits": { - "smithy.api#documentation": "

Severity of the incident Critical - The part of the route the incident affects is\n unusable. Major- Major impact on the leg duration, for example stop and go Minor- Minor\n impact on the leg duration, for example traffic jam Low - Low on duration, for example\n slightly increased traffic

" + "smithy.api#documentation": "

Severity of the incident Critical - The part of the route the incident affects is unusable. Major- Major impact on the leg duration, for example stop and go Minor- Minor impact on the leg duration, for example traffic jam Low - Low on duration, for example slightly increased traffic

" } }, "StartTime": { @@ -7722,7 +7769,8 @@ "name": "LOW", "value": "Low" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteVehicleIncidentType": { @@ -7773,7 +7821,8 @@ "name": "WEATHER", "value": "Weather" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteVehicleLegDetails": { @@ -7803,14 +7852,14 @@ "Notices": { "target": "com.amazonaws.georoutes#RouteVehicleNoticeList", "traits": { - "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during\n route calculation.

", + "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during route calculation.

", "smithy.api#required": {} } }, "PassThroughWaypoints": { "target": "com.amazonaws.georoutes#RoutePassThroughWaypointList", "traits": { - "smithy.api#documentation": "

Waypoints that were passed through during the leg. This includes the waypoints that were\n configured with the PassThrough option.

", + "smithy.api#documentation": "

Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.

", "smithy.api#required": {} } }, @@ -7851,7 +7900,7 @@ "TruckRoadTypes": { "target": "com.amazonaws.georoutes#TruckRoadTypeList", "traits": { - "smithy.api#documentation": "

Truck road type identifiers. BK1 through BK4 apply only to\n Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

\n \n

There are currently no other supported values as of 26th April 2024.

\n
", + "smithy.api#documentation": "

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

", "smithy.api#required": {} } }, @@ -7871,7 +7920,7 @@ "type": "structure", "members": { "LastCharacter": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

The last character of the License Plate.

", "smithy.api#length": { @@ -7882,7 +7931,7 @@ } }, "traits": { - "smithy.api#documentation": "

License plate information of the vehicle. Currently, only the last character is used\n where license plate based controlled access is enforced.

" + "smithy.api#documentation": "

License plate information of the vehicle. Currently, only the last character is used where license plate based controlled access is enforced.

" } }, "com.amazonaws.georoutes#RouteVehicleNotice": { @@ -7905,12 +7954,12 @@ "Impact": { "target": "com.amazonaws.georoutes#RouteNoticeImpact", "traits": { - "smithy.api#documentation": "

Impact corresponding to the issue. While Low impact notices can be safely ignored, High\n impact notices must be evaluated further to determine the impact.

" + "smithy.api#documentation": "

Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.

" } } }, "traits": { - "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during\n route calculation.

" + "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during route calculation.

" } }, "com.amazonaws.georoutes#RouteVehicleNoticeCode": { @@ -8032,7 +8081,7 @@ "type": "structure", "members": { "Title": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

The notice title.

" } @@ -8067,7 +8116,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Total duration in free flowing traffic, which is the best case or shortest duration\n possible to cover the leg.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.

Unit: seconds

" } }, "Distance": { @@ -8082,7 +8131,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the step.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Duration of the step.

Unit: seconds

", "smithy.api#required": {} } }, @@ -8090,7 +8139,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the computed span under typical traffic congestion.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Duration of the computed span under typical traffic congestion.

Unit: seconds

" } } }, @@ -8102,7 +8151,7 @@ "type": "structure", "members": { "Name": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

The name of the place.

" } @@ -8127,7 +8176,7 @@ } }, "WaypointIndex": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#documentation": "

Index of the waypoint in the request.

", "smithy.api#range": { @@ -8147,7 +8196,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the computed span without traffic congestion.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Duration of the computed span without traffic congestion.

Unit: seconds

" } }, "CarAccess": { @@ -8166,24 +8215,24 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Distance of the computed span. This feature doesn't split a span, but is always computed\n on a span split by other properties.

" + "smithy.api#documentation": "

Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

" } }, "Duration": { "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the computed span. This feature doesn't split a span, but is always computed\n on a span split by other properties.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

Unit: seconds

" } }, "DynamicSpeed": { "target": "com.amazonaws.georoutes#RouteSpanDynamicSpeedDetails", "traits": { - "smithy.api#documentation": "

Dynamic speed details corresponding to the span.

\n

\n Unit: KilometersPerHour\n

" + "smithy.api#documentation": "

Dynamic speed details corresponding to the span.

Unit: KilometersPerHour

" } }, "FunctionalClassification": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { "smithy.api#documentation": "

Functional classification of the road segment corresponding to the span.

", "smithy.api#range": { @@ -8195,7 +8244,7 @@ "Gate": { "target": "com.amazonaws.georoutes#RouteSpanGateAttribute", "traits": { - "smithy.api#documentation": "

Attributes corresponding to a gate. The gate is present at the end of the returned\n span.

" + "smithy.api#documentation": "

Attributes corresponding to a gate. The gate is present at the end of the returned span.

" } }, "GeometryOffset": { @@ -8210,7 +8259,7 @@ "Incidents": { "target": "com.amazonaws.georoutes#IndexList", "traits": { - "smithy.api#documentation": "

Incidents corresponding to the span. These index into the Incidents in the parent\n Leg.

" + "smithy.api#documentation": "

Incidents corresponding to the span. These index into the Incidents in the parent Leg.

" } }, "Names": { @@ -8222,19 +8271,19 @@ "Notices": { "target": "com.amazonaws.georoutes#IndexList", "traits": { - "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during\n route calculation.

" + "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during route calculation.

" } }, "RailwayCrossing": { "target": "com.amazonaws.georoutes#RouteSpanRailwayCrossingAttribute", "traits": { - "smithy.api#documentation": "

Attributes corresponding to a railway crossing. The gate is present at the end of the\n returned span.

" + "smithy.api#documentation": "

Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.

" } }, "Region": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { - "smithy.api#documentation": "

2-3 letter Region code corresponding to the Span. This is either a province or a\n state.

", + "smithy.api#documentation": "

2-3 letter Region code corresponding to the Span. This is either a province or a state.

", "smithy.api#length": { "min": 0, "max": 3 @@ -8262,7 +8311,7 @@ "SpeedLimit": { "target": "com.amazonaws.georoutes#RouteSpanSpeedLimitDetails", "traits": { - "smithy.api#documentation": "

Speed limit details corresponding to the span.

\n

\n Unit: KilometersPerHour\n

" + "smithy.api#documentation": "

Speed limit details corresponding to the span.

Unit: KilometersPerHour

" } }, "TollSystems": { @@ -8280,14 +8329,14 @@ "TruckRoadTypes": { "target": "com.amazonaws.georoutes#IndexList", "traits": { - "smithy.api#documentation": "

Truck road type identifiers. BK1 through BK4 apply only to\n Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

\n \n

There are currently no other supported values as of 26th April 2024.

\n
" + "smithy.api#documentation": "

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

" } }, "TypicalDuration": { "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the computed span under typical traffic congestion.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Duration of the computed span under typical traffic congestion.

Unit: seconds

" } }, "Zones": { @@ -8313,13 +8362,13 @@ "Overview": { "target": "com.amazonaws.georoutes#RouteVehicleOverviewSummary", "traits": { - "smithy.api#documentation": "

Summarized details for the leg including before travel, travel and after travel\n steps.

" + "smithy.api#documentation": "

Summarized details for the leg including before travel, travel and after travel steps.

" } }, "TravelOnly": { "target": "com.amazonaws.georoutes#RouteVehicleTravelOnlySummary", "traits": { - "smithy.api#documentation": "

Summarized details for the leg including travel steps only. The Distance for the travel\n only portion of the journey is in meters

" + "smithy.api#documentation": "

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters

" } } }, @@ -8334,14 +8383,14 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Total duration in free flowing traffic, which is the best case or shortest duration\n possible to cover the leg.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.

Unit: seconds

" } }, "Duration": { "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the step.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Duration of the step.

Unit: seconds

", "smithy.api#required": {} } }, @@ -8349,7 +8398,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the computed span under typical traffic congestion.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Duration of the computed span under typical traffic congestion.

Unit: seconds

" } } }, @@ -8389,7 +8438,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the step.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Duration of the step.

Unit: seconds

", "smithy.api#required": {} } }, @@ -8421,9 +8470,9 @@ } }, "Instruction": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { - "smithy.api#documentation": "

Brief description of the step in the requested language.

\n \n

Only available when the TravelStepType is Default.

\n
" + "smithy.api#documentation": "

Brief description of the step in the requested language.

Only available when the TravelStepType is Default.

" } }, "KeepStepDetails": { @@ -8465,7 +8514,7 @@ "Signpost": { "target": "com.amazonaws.georoutes#RouteSignpost", "traits": { - "smithy.api#documentation": "

Sign post information of the action, applicable only for TurnByTurn steps. See\n RouteSignpost for details of sub-attributes.

" + "smithy.api#documentation": "

Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.

" } }, "TurnStepDetails": { @@ -8554,16 +8603,17 @@ "name": "U_TURN", "value": "UTurn" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteViolatedConstraints": { "type": "structure", "members": { "AllHazardsRestricted": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { - "smithy.api#documentation": "

This restriction applies to truck cargo, where the resulting route excludes roads on\n which hazardous materials are prohibited from being transported.

" + "smithy.api#documentation": "

This restriction applies to truck cargo, where the resulting route excludes roads on which hazardous materials are prohibited from being transported.

" } }, "AxleCount": { @@ -8590,7 +8640,7 @@ "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum Kpra length of the vehicle.

\n

\n Unit: centimeters\n

" + "smithy.api#documentation": "

The maximum Kpra length of the vehicle.

Unit: centimeters

" } }, "MaxLength": { @@ -8604,26 +8654,26 @@ "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum load capacity of the vehicle.

\n

\n Unit: kilograms\n

" + "smithy.api#documentation": "

The maximum load capacity of the vehicle.

Unit: kilograms

" } }, "MaxWeight": { "target": "com.amazonaws.georoutes#RouteWeightConstraint", "traits": { - "smithy.api#documentation": "

The maximum weight of the route.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

The maximum weight of the route.

Unit: Kilograms

" } }, "MaxWeightPerAxle": { "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum weight per axle of the vehicle.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

The maximum weight per axle of the vehicle.

Unit: Kilograms

" } }, "MaxWeightPerAxleGroup": { "target": "com.amazonaws.georoutes#WeightPerAxleGroup", "traits": { - "smithy.api#documentation": "

The maximum weight per axle group of the vehicle.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

The maximum weight per axle group of the vehicle.

Unit: Kilograms

" } }, "MaxWidth": { @@ -8636,7 +8686,7 @@ "Occupancy": { "target": "com.amazonaws.georoutes#RouteNoticeDetailRange", "traits": { - "smithy.api#documentation": "

The number of occupants in the vehicle.

\n

Default Value: 1\n

" + "smithy.api#documentation": "

The number of occupants in the vehicle.

Default Value: 1

" } }, "RestrictedTimes": { @@ -8646,7 +8696,7 @@ } }, "TimeDependent": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

The time dependent constraint.

" } @@ -8654,11 +8704,11 @@ "TrailerCount": { "target": "com.amazonaws.georoutes#RouteNoticeDetailRange", "traits": { - "smithy.api#documentation": "

Number of trailers attached to the vehicle.

\n

Default Value: 0\n

" + "smithy.api#documentation": "

Number of trailers attached to the vehicle.

Default Value: 0

" } }, "TravelMode": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Travel mode corresponding to the leg.

" } @@ -8666,7 +8716,7 @@ "TruckRoadType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Truck road type identifiers. BK1 through BK4 apply only to\n Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

\n \n

There are currently no other supported values as of 26th April 2024.

\n
" + "smithy.api#documentation": "

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

" } }, "TruckType": { @@ -8678,7 +8728,7 @@ "TunnelRestrictionCode": { "target": "com.amazonaws.georoutes#TunnelRestrictionCode", "traits": { - "smithy.api#documentation": "

The tunnel restriction code.

\n

Tunnel categories in this list indicate the restrictions which apply to certain tunnels\n in Great Britain. They relate to the types of dangerous goods that can be transported\n through them.

\n
    \n
  • \n

    \n Tunnel Category B\n

    \n
      \n
    • \n

      \n Risk Level: Limited risk

      \n
    • \n
    • \n

      \n Restrictions: Few restrictions

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category C\n

    \n
      \n
    • \n

      \n Risk Level: Medium risk

      \n
    • \n
    • \n

      \n Restrictions: Some restrictions

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category D\n

    \n
      \n
    • \n

      \n Risk Level: High risk

      \n
    • \n
    • \n

      \n Restrictions: Many restrictions occur

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category E\n

    \n
      \n
    • \n

      \n Risk Level: Very high risk

      \n
    • \n
    • \n

      \n Restrictions: Restricted tunnel

      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

  • Tunnel Category B

    • Risk Level: Limited risk

    • Restrictions: Few restrictions

  • Tunnel Category C

    • Risk Level: Medium risk

    • Restrictions: Some restrictions

  • Tunnel Category D

    • Risk Level: High risk

    • Restrictions: Many restrictions occur

  • Tunnel Category E

    • Risk Level: Very high risk

    • Restrictions: Restricted tunnel

" } } }, @@ -8693,14 +8743,14 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Avoids actions for the provided distance. This is typically to consider for users in\n moving vehicles who may not have sufficient time to make an action at an origin or a\n destination.

", + "smithy.api#documentation": "

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

", "smithy.api#range": { "max": 2000 } } }, "AvoidUTurns": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid U-turns for calculation on highways and motorways.

" } @@ -8719,9 +8769,9 @@ } }, "PassThrough": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { - "smithy.api#documentation": "

If the waypoint should not be treated as a stop. If yes, the waypoint is passed through\n and doesn't split the route into different legs.

" + "smithy.api#documentation": "

If the waypoint should not be treated as a stop. If yes, the waypoint is passed through and doesn't split the route into different legs.

" } }, "Position": { @@ -8741,7 +8791,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of the stop.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Duration of the stop.

Unit: seconds

" } } }, @@ -8769,13 +8819,13 @@ "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The constraint value.

\n

\n Unit: Kilograms\n

", + "smithy.api#documentation": "

The constraint value.

Unit: Kilograms

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The weight constraint for the route.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

The weight constraint for the route.

Unit: Kilograms

" } }, "com.amazonaws.georoutes#RouteWeightConstraintType": { @@ -8807,7 +8857,7 @@ } }, "Name": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

The name of the zone.

" } @@ -8833,7 +8883,8 @@ "name": "VIGNETTE", "value": "Vignette" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#RouteZoneList": { @@ -8911,7 +8962,7 @@ "content-type" ] }, - "smithy.api#documentation": "

With the Amazon Location Routes API you can calculate routes and estimate travel time\n based on up-to-date road network and live traffic information.

\n

Calculate optimal travel routes and estimate travel times using up-to-date road network\n and traffic data. Key features include:

\n
    \n
  • \n

    Point-to-point routing with estimated travel time, distance, and turn-by-turn\n directions

    \n
  • \n
  • \n

    Multi-point route optimization to minimize travel time or distance

    \n
  • \n
  • \n

    Route matrices for efficient multi-destination planning

    \n
  • \n
  • \n

    Isoline calculations to determine reachable areas within specified time or\n distance thresholds

    \n
  • \n
  • \n

    Map-matching to align GPS traces with the road network

    \n
  • \n
", + "smithy.api#documentation": "

With the Amazon Location Routes API you can calculate routes and estimate travel time based on up-to-date road network and live traffic information.

Calculate optimal travel routes and estimate travel times using up-to-date road network and traffic data. Key features include:

  • Point-to-point routing with estimated travel time, distance, and turn-by-turn directions

  • Multi-point route optimization to minimize travel time or distance

  • Route matrices for efficient multi-destination planning

  • Isoline calculations to determine reachable areas within specified time or distance thresholds

  • Map-matching to align GPS traces with the road network

", "smithy.api#title": "Amazon Location Service Routes V2", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -9792,17 +9843,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -9816,17 +9856,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -9840,17 +9869,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -9864,17 +9882,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -9888,17 +9895,6 @@ "UseDualStack": false } }, - { - "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": { @@ -9912,17 +9908,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -9937,49 +9922,53 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://geo-routes-fips.us-isof-south-1.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://geo-routes-fips.us-isof-south-1.csp.hci.ic.gov" + "url": "https://geo-routes.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://geo-routes-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://geo-routes.us-isof-south-1.csp.hci.ic.gov" + "url": "https://geo-routes.eusc-de-east-1.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } @@ -10010,6 +9999,24 @@ ] } }, + "com.amazonaws.georoutes#SensitiveBoolean": { + "type": "boolean", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.georoutes#SensitiveDouble": { + "type": "double", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.georoutes#SensitiveInteger": { + "type": "integer", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.georoutes#SensitiveString": { "type": "string", "traits": { @@ -10055,7 +10062,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

\n SnapToRoads matches GPS trace to roads most likely traveled on.

", + "smithy.api#documentation": "

SnapToRoads matches GPS trace to roads most likely traveled on.

", "smithy.api#http": { "uri": "/snap-to-roads", "method": "POST" @@ -10097,21 +10104,21 @@ "Key": { "target": "com.amazonaws.georoutes#ApiKey", "traits": { - "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.

", + "smithy.api#documentation": "

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", "smithy.api#httpQuery": "key" } }, "SnappedGeometryFormat": { "target": "com.amazonaws.georoutes#GeometryFormat", "traits": { - "smithy.api#documentation": "

Chooses what the returned SnappedGeometry format should be.

\n

Default Value: FlexiblePolyline\n

" + "smithy.api#documentation": "

Chooses what the returned SnappedGeometry format should be.

Default Value: FlexiblePolyline

" } }, "SnapRadius": { "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The radius around the provided tracepoint that is considered for snapping.

\n

\n Unit: meters\n

\n

Default value: 300\n

", + "smithy.api#documentation": "

The radius around the provided tracepoint that is considered for snapping.

Unit: meters

Default value: 300

", "smithy.api#range": { "min": 0, "max": 10000 @@ -10132,7 +10139,7 @@ "TravelMode": { "target": "com.amazonaws.georoutes#RoadSnapTravelMode", "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

Default Value: Car\n

" + "smithy.api#documentation": "

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

" } }, "TravelModeOptions": { @@ -10152,7 +10159,7 @@ "Notices": { "target": "com.amazonaws.georoutes#RoadSnapNoticeList", "traits": { - "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during\n route calculation.

", + "smithy.api#documentation": "

Notices are additional information returned that indicate issues that occurred during route calculation.

", "smithy.api#required": {} } }, @@ -10195,7 +10202,8 @@ "smithy.api#default": 0, "smithy.api#range": { "min": 0.0 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#ThrottlingException": { @@ -10219,7 +10227,8 @@ "com.amazonaws.georoutes#TimeOfDay": { "type": "string", "traits": { - "smithy.api#pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](Z|[+-]([0-1]?[0-9]|2[0-3]):[0-5][0-9])$" + "smithy.api#pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](Z|[+-]([0-1]?[0-9]|2[0-3]):[0-5][0-9])$", + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#TimeThresholdList": { @@ -10243,7 +10252,8 @@ "com.amazonaws.georoutes#TimestampWithTimezoneOffset": { "type": "string", "traits": { - "smithy.api#pattern": "^([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])$" + "smithy.api#pattern": "^([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])$", + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#TrafficUsage": { @@ -10267,7 +10277,8 @@ "smithy.api#length": { "min": 1, "max": 3 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#TruckRoadTypeList": { @@ -10289,7 +10300,8 @@ "smithy.api#length": { "min": 1, "max": 1 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#TurnAngle": { @@ -10356,7 +10368,7 @@ } }, "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by the Amazon Location\n service.

" + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by the Amazon Location service.

" } }, "com.amazonaws.georoutes#ValidationExceptionFieldList": { @@ -10482,7 +10494,7 @@ "BoundingBox": { "target": "com.amazonaws.georoutes#BoundingBox", "traits": { - "smithy.api#documentation": "

Geometry defined as a bounding box. The first pair represents the X and Y coordinates\n (longitude and latitude,) of the southwest corner of the bounding box; the second pair\n represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" + "smithy.api#documentation": "

Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" } } }, @@ -10509,50 +10521,50 @@ } }, "CarShuttleTrains": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoidance options for cars-shuttles-trains.

" } }, "ControlledAccessHighways": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid controlled access highways while calculating the route.

" } }, "DirtRoads": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid dirt roads while calculating the route.

" } }, "Ferries": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoidance options for ferries.

" } }, "TollRoads": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoids roads where the specified toll transponders are the only mode of payment.

" } }, "Tunnels": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid tunnels while calculating the route.

" } }, "UTurns": { - "target": "smithy.api#Boolean", + "target": "com.amazonaws.georoutes#SensitiveBoolean", "traits": { "smithy.api#documentation": "

Avoid U-turns for calculation on highways and motorways.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies options for areas to avoid. This is a best-effort avoidance setting, meaning\n the router will try to honor the avoidance preferences but may still include restricted\n areas if no feasible alternative route exists. If avoidance options are not followed, the\n response will indicate that the avoidance criteria were violated.

" + "smithy.api#documentation": "

Specifies options for areas to avoid. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.

" } }, "com.amazonaws.georoutes#WaypointOptimizationClusteringAlgorithm": { @@ -10567,7 +10579,8 @@ "name": "TOPOLOGY_SEGMENT", "value": "TopologySegment" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#WaypointOptimizationClusteringOptions": { @@ -10576,14 +10589,14 @@ "Algorithm": { "target": "com.amazonaws.georoutes#WaypointOptimizationClusteringAlgorithm", "traits": { - "smithy.api#documentation": "

The algorithm to be used. DrivingDistance assigns all the waypoints that\n are within driving distance of each other into a single cluster.\n TopologySegment assigns all the waypoints that are within the same topology\n segment into a single cluster. A Topology segment is a linear stretch of road between two\n junctions.

", + "smithy.api#documentation": "

The algorithm to be used. DrivingDistance assigns all the waypoints that are within driving distance of each other into a single cluster. TopologySegment assigns all the waypoints that are within the same topology segment into a single cluster. A Topology segment is a linear stretch of road between two junctions.

", "smithy.api#required": {} } }, "DrivingDistanceOptions": { "target": "com.amazonaws.georoutes#WaypointOptimizationDrivingDistanceOptions", "traits": { - "smithy.api#documentation": "

Driving distance options to be used when the clustering algorithm is\n DrivingDistance.

" + "smithy.api#documentation": "

Driving distance options to be used when the clustering algorithm is DrivingDistance.

" } } }, @@ -10628,7 +10641,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Total duration.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Total duration.

Unit: seconds

", "smithy.api#required": {} } }, @@ -10636,13 +10649,13 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration of a wait step.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Duration of a wait step.

Unit: seconds

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

This contains information such as distance and duration from one waypoint to the next\n waypoint in the sequence.

" + "smithy.api#documentation": "

This contains information such as distance and duration from one waypoint to the next waypoint in the sequence.

" } }, "com.amazonaws.georoutes#WaypointOptimizationConnectionList": { @@ -10679,7 +10692,8 @@ "name": "SIDE_OF_STREET", "value": "SideOfStreet" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#WaypointOptimizationDestinationOptions": { @@ -10714,7 +10728,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Service time spent at the destination. At an appointment, the service time should be the\n appointment duration.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Service time spent at the destination. At an appointment, the service time should be the appointment duration.

Unit: seconds

" } }, "SideOfStreet": { @@ -10734,19 +10748,19 @@ "RestCycles": { "target": "com.amazonaws.georoutes#WaypointOptimizationRestCycles", "traits": { - "smithy.api#documentation": "

Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken\n after the short work duration. The short cycle can be repeated until you hit the long work\n duration, at which point the long rest duration should be taken before restarting.

" + "smithy.api#documentation": "

Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken after the short work duration. The short cycle can be repeated until you hit the long work duration, at which point the long rest duration should be taken before restarting.

" } }, "RestProfile": { "target": "com.amazonaws.georoutes#WaypointOptimizationRestProfile", "traits": { - "smithy.api#documentation": "

Pre defined rest profiles for a driver schedule. The only currently supported profile is\n EU.

" + "smithy.api#documentation": "

Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.

" } }, "TreatServiceTimeAs": { "target": "com.amazonaws.georoutes#WaypointOptimizationServiceTimeTreatment", "traits": { - "smithy.api#documentation": "

If the service time provided at a waypoint/destination should be considered as rest or\n work. This contributes to the total time breakdown returned within the response.

" + "smithy.api#documentation": "

If the service time provided at a waypoint/destination should be considered as rest or work. This contributes to the total time breakdown returned within the response.

" } } }, @@ -10761,7 +10775,7 @@ "target": "com.amazonaws.georoutes#DistanceMeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

DrivingDistance assigns all the waypoints that are within driving distance of each other\n into a single cluster.

", + "smithy.api#documentation": "

DrivingDistance assigns all the waypoints that are within driving distance of each other into a single cluster.

", "smithy.api#required": {} } } @@ -10776,13 +10790,13 @@ "Countries": { "target": "com.amazonaws.georoutes#CountryCodeList", "traits": { - "smithy.api#documentation": "

List of countries to be avoided defined by two-letter or three-letter country\n codes.

", + "smithy.api#documentation": "

List of countries to be avoided defined by two-letter or three-letter country codes.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Specifies strict exclusion options for the route calculation. This setting mandates that\n the router will avoid any routes that include the specified options, rather than merely\n attempting to minimize them.

" + "smithy.api#documentation": "

Specifies strict exclusion options for the route calculation. This setting mandates that the router will avoid any routes that include the specified options, rather than merely attempting to minimize them.

" } }, "com.amazonaws.georoutes#WaypointOptimizationFailedConstraint": { @@ -10795,7 +10809,7 @@ } }, "Reason": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { "smithy.api#documentation": "

Reason for the failed constraint.

" } @@ -10859,7 +10873,8 @@ "name": "RADIOACTIVE", "value": "Radioactive" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#WaypointOptimizationHazardousCargoTypeList": { @@ -10912,7 +10927,7 @@ "ArrivalTime": { "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", "traits": { - "smithy.api#documentation": "

Estimated time of arrival at the destination.

\n

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n

\n

Examples:

\n

\n 2020-04-22T17:57:24Z\n

\n

\n 2020-04-22T17:57:24+02:00\n

" + "smithy.api#documentation": "

Estimated time of arrival at the destination.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" } }, "ClusterIndex": { @@ -10924,7 +10939,7 @@ "DepartureTime": { "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", "traits": { - "smithy.api#documentation": "

Estimated time of departure from thr origin.

\n

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n

\n

Examples:

\n

\n 2020-04-22T17:57:24Z\n

\n

\n 2020-04-22T17:57:24+02:00\n

", + "smithy.api#documentation": "

Estimated time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

", "smithy.api#required": {} } }, @@ -10974,7 +10989,7 @@ "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Walking speed.

\n

\n Unit: KilometersPerHour\n

", + "smithy.api#documentation": "

Walking speed.

Unit: KilometersPerHour

", "smithy.api#range": { "min": 1.8, "max": 7.2 @@ -10993,7 +11008,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Resting phase of the cycle.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Resting phase of the cycle.

Unit: seconds

", "smithy.api#required": {} } }, @@ -11001,13 +11016,13 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Working phase of the cycle.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Working phase of the cycle.

Unit: seconds

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken\n after the short work duration. The short cycle can be repeated until you hit the long work\n duration, at which point the long rest duration should be taken before restarting.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken after the short work duration. The short cycle can be repeated until you hit the long work duration, at which point the long rest duration should be taken before restarting.

Unit: seconds

" } }, "com.amazonaws.georoutes#WaypointOptimizationRestCycles": { @@ -11036,9 +11051,9 @@ "type": "structure", "members": { "Profile": { - "target": "smithy.api#String", + "target": "com.amazonaws.georoutes#SensitiveString", "traits": { - "smithy.api#documentation": "

Pre defined rest profiles for a driver schedule. The only currently supported profile is\n EU.

", + "smithy.api#documentation": "

Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.

", "smithy.api#length": { "min": 2, "max": 2 @@ -11048,7 +11063,7 @@ } }, "traits": { - "smithy.api#documentation": "

Pre defined rest profiles for a driver schedule. The only currently supported profile is\n EU.

" + "smithy.api#documentation": "

Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.

" } }, "com.amazonaws.georoutes#WaypointOptimizationSequencingObjective": { @@ -11078,7 +11093,8 @@ "name": "WORK", "value": "Work" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#WaypointOptimizationSideOfStreetOptions": { @@ -11094,7 +11110,7 @@ "UseWith": { "target": "com.amazonaws.georoutes#SideOfStreetMatchingStrategy", "traits": { - "smithy.api#documentation": "

Strategy that defines when the side of street position should be used. AnyStreet will\n always use the provided position.

\n

Default Value: DividedStreetOnly\n

" + "smithy.api#documentation": "

Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.

Default Value: DividedStreetOnly

" } } }, @@ -11109,7 +11125,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Resting phase of the cycle.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Resting phase of the cycle.

Unit: seconds

", "smithy.api#required": {} } }, @@ -11117,7 +11133,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Service time spent at the destination. At an appointment, the service time should be the\n appointment duration.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Service time spent at the destination. At an appointment, the service time should be the appointment duration.

Unit: seconds

", "smithy.api#required": {} } }, @@ -11125,7 +11141,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Traveling phase of the cycle.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Traveling phase of the cycle.

Unit: seconds

", "smithy.api#required": {} } }, @@ -11133,7 +11149,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Waiting phase of the cycle.

\n

\n Unit: seconds\n

", + "smithy.api#documentation": "

Waiting phase of the cycle.

Unit: seconds

", "smithy.api#required": {} } } @@ -11148,7 +11164,7 @@ "Usage": { "target": "com.amazonaws.georoutes#TrafficUsage", "traits": { - "smithy.api#documentation": "

Determines if traffic should be used or ignored while calculating the route.

\n

Default Value: UseTrafficData\n

" + "smithy.api#documentation": "

Determines if traffic should be used or ignored while calculating the route.

Default Value: UseTrafficData

" } } }, @@ -11160,9 +11176,9 @@ "type": "structure", "members": { "TrailerCount": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.georoutes#SensitiveInteger", "traits": { - "smithy.api#documentation": "

Number of trailers attached to the vehicle.

\n

Default Value: 0\n

", + "smithy.api#documentation": "

Number of trailers attached to the vehicle.

Default Value: 0

", "smithy.api#range": { "min": 0, "max": 255 @@ -11224,7 +11240,7 @@ "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Gross weight of the vehicle including trailers, and goods at capacity.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Gross weight of the vehicle including trailers, and goods at capacity.

Unit: Kilograms

" } }, "HazardousCargos": { @@ -11237,7 +11253,7 @@ "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Height of the vehicle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Height of the vehicle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 5000 @@ -11248,7 +11264,7 @@ "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Length of the vehicle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Length of the vehicle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 30000 @@ -11270,21 +11286,21 @@ "TunnelRestrictionCode": { "target": "com.amazonaws.georoutes#TunnelRestrictionCode", "traits": { - "smithy.api#documentation": "

The tunnel restriction code.

\n

Tunnel categories in this list indicate the restrictions which apply to certain tunnels\n in Great Britain. They relate to the types of dangerous goods that can be transported\n through them.

\n
    \n
  • \n

    \n Tunnel Category B\n

    \n
      \n
    • \n

      \n Risk Level: Limited risk

      \n
    • \n
    • \n

      \n Restrictions: Few restrictions

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category C\n

    \n
      \n
    • \n

      \n Risk Level: Medium risk

      \n
    • \n
    • \n

      \n Restrictions: Some restrictions

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category D\n

    \n
      \n
    • \n

      \n Risk Level: High risk

      \n
    • \n
    • \n

      \n Restrictions: Many restrictions occur

      \n
    • \n
    \n
  • \n
  • \n

    \n Tunnel Category E\n

    \n
      \n
    • \n

      \n Risk Level: Very high risk

      \n
    • \n
    • \n

      \n Restrictions: Restricted tunnel

      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

  • Tunnel Category B

    • Risk Level: Limited risk

    • Restrictions: Few restrictions

  • Tunnel Category C

    • Risk Level: Medium risk

    • Restrictions: Some restrictions

  • Tunnel Category D

    • Risk Level: High risk

    • Restrictions: Many restrictions occur

  • Tunnel Category E

    • Risk Level: Very high risk

    • Restrictions: Restricted tunnel

" } }, "WeightPerAxle": { "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Heaviest weight per axle irrespective of the axle type or the axle group. Meant for\n usage in countries where the differences in axle types or axle groups are not\n distinguished.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.

Unit: Kilograms

" } }, "Width": { "target": "com.amazonaws.georoutes#DimensionCentimeters", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Width of the vehicle.

\n

\n Unit: centimeters\n

", + "smithy.api#documentation": "

Width of the vehicle.

Unit: centimeters

", "smithy.api#range": { "min": 0, "max": 5000 @@ -11308,7 +11324,8 @@ "name": "TRACTOR", "value": "Tractor" } - ] + ], + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#WaypointOptimizationWaypoint": { @@ -11356,7 +11373,7 @@ "target": "com.amazonaws.georoutes#DurationSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Service time spent at the waypoint. At an appointment, the service time should be the\n appointment duration.

\n

\n Unit: seconds\n

" + "smithy.api#documentation": "

Service time spent at the waypoint. At an appointment, the service time should be the appointment duration.

Unit: seconds

" } }, "SideOfStreet": { @@ -11383,7 +11400,8 @@ "smithy.api#range": { "min": 0, "max": 4294967295 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.georoutes#WeightPerAxleGroup": { @@ -11393,40 +11411,40 @@ "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Weight for single axle group.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Weight for single axle group.

Unit: Kilograms

" } }, "Tandem": { "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Weight for tandem axle group.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Weight for tandem axle group.

Unit: Kilograms

" } }, "Triple": { "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Weight for triple axle group.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Weight for triple axle group.

Unit: Kilograms

" } }, "Quad": { "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Weight for quad axle group.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Weight for quad axle group.

Unit: Kilograms

" } }, "Quint": { "target": "com.amazonaws.georoutes#WeightKilograms", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Weight for quad quint group.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Weight for quad quint group.

Unit: Kilograms

" } } }, "traits": { - "smithy.api#documentation": "

Specifies the total weight for the specified axle group. Meant for usage in countries\n that have different regulations based on the axle group type.

\n

\n Unit: Kilograms\n

" + "smithy.api#documentation": "

Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.

Unit: Kilograms

" } } } diff --git a/codegen/sdk/aws-models/glacier.json b/codegen/sdk/aws-models/glacier.json index c98fd0342eb..7f0d5ab0358 100644 --- a/codegen/sdk/aws-models/glacier.json +++ b/codegen/sdk/aws-models/glacier.json @@ -2845,17 +2845,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2869,17 +2858,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2893,17 +2871,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2917,17 +2884,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/global-accelerator.json b/codegen/sdk/aws-models/global-accelerator.json index bf937e1e3f8..483f4d47163 100644 --- a/codegen/sdk/aws-models/global-accelerator.json +++ b/codegen/sdk/aws-models/global-accelerator.json @@ -3726,17 +3726,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3750,17 +3739,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3774,17 +3752,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3798,17 +3765,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/glue.json b/codegen/sdk/aws-models/glue.json index 98bad362167..4f2421a56be 100644 --- a/codegen/sdk/aws-models/glue.json +++ b/codegen/sdk/aws-models/glue.json @@ -132,6 +132,9 @@ { "target": "com.amazonaws.glue#CreateDevEndpoint" }, + { + "target": "com.amazonaws.glue#CreateGlueIdentityCenterConfiguration" + }, { "target": "com.amazonaws.glue#CreateIntegration" }, @@ -222,6 +225,9 @@ { "target": "com.amazonaws.glue#DeleteDevEndpoint" }, + { + "target": "com.amazonaws.glue#DeleteGlueIdentityCenterConfiguration" + }, { "target": "com.amazonaws.glue#DeleteIntegration" }, @@ -387,6 +393,9 @@ { "target": "com.amazonaws.glue#GetEntityRecords" }, + { + "target": "com.amazonaws.glue#GetGlueIdentityCenterConfiguration" + }, { "target": "com.amazonaws.glue#GetIntegrationResourceProperty" }, @@ -747,6 +756,9 @@ { "target": "com.amazonaws.glue#UpdateDevEndpoint" }, + { + "target": "com.amazonaws.glue#UpdateGlueIdentityCenterConfiguration" + }, { "target": "com.amazonaws.glue#UpdateIntegrationResourceProperty" }, @@ -1617,17 +1629,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1641,17 +1642,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1665,17 +1655,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1689,17 +1668,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2453,6 +2421,15 @@ "smithy.api#pattern": "^[a-zA-Z0-9.-]*$" } }, + "com.amazonaws.glue#ApplicationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1224 + } + } + }, "com.amazonaws.glue#ApplyMapping": { "type": "structure", "members": { @@ -2657,6 +2634,12 @@ "smithy.api#documentation": "

The secret manager ARN to store credentials.

" } }, + "KmsKeyArn": { + "target": "com.amazonaws.glue#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt sensitive authentication information. This key is used to protect credentials \n and other sensitive data stored within the authentication configuration.

" + } + }, "OAuth2Properties": { "target": "com.amazonaws.glue#OAuth2Properties", "traits": { @@ -4108,7 +4091,7 @@ } ], "traits": { - "smithy.api#documentation": "

Annotate datapoints over time for a specific data quality statistic.

" + "smithy.api#documentation": "

Annotate datapoints over time for a specific data quality statistic.\n The API requires both profileID and statisticID as part of the InclusionAnnotation input.\n The API only works for a single statisticId across multiple profiles.

" } }, "com.amazonaws.glue#BatchPutDataQualityStatisticAnnotationRequest": { @@ -4117,7 +4100,7 @@ "InclusionAnnotations": { "target": "com.amazonaws.glue#InclusionAnnotationList", "traits": { - "smithy.api#documentation": "

A list of DatapointInclusionAnnotation's.

", + "smithy.api#documentation": "

A list of DatapointInclusionAnnotation's. The InclusionAnnotations must contain a profileId and statisticId.\n If there are multiple InclusionAnnotations, the list must refer to a single statisticId across multiple profileIds.

", "smithy.api#required": {} } }, @@ -5622,6 +5605,12 @@ "smithy.api#documentation": "

A DataLakeAccessProperties object that specifies properties to configure data lake access for your catalog resource in the Glue Data Catalog.

" } }, + "IcebergOptimizationProperties": { + "target": "com.amazonaws.glue#IcebergOptimizationProperties", + "traits": { + "smithy.api#documentation": "

A structure that specifies Iceberg table optimization properties for the catalog. This includes configuration for compaction, retention, and \n orphan file deletion operations that can be applied to Iceberg tables in this catalog.

" + } + }, "CustomProperties": { "target": "com.amazonaws.glue#ParametersMap", "traits": { @@ -5642,6 +5631,12 @@ "smithy.api#documentation": "

A DataLakeAccessProperties object with input properties to configure data lake access for your catalog resource in the Glue Data Catalog.

" } }, + "IcebergOptimizationProperties": { + "target": "com.amazonaws.glue#IcebergOptimizationPropertiesOutput", + "traits": { + "smithy.api#documentation": "

An IcebergOptimizationPropertiesOutput object that specifies Iceberg table optimization settings for the catalog, including \n configurations for compaction, retention, and orphan file deletion operations.

" + } + }, "CustomProperties": { "target": "com.amazonaws.glue#ParametersMap", "traits": { @@ -7673,6 +7668,23 @@ "smithy.api#documentation": "

Specifies the values that an admin sets for each job or session parameter configured in a Glue usage profile.

" } }, + "com.amazonaws.glue#ConfigurationSource": { + "type": "enum", + "members": { + "CATALOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "catalog" + } + }, + "TABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "table" + } + } + } + }, "com.amazonaws.glue#ConflictException": { "type": "structure", "members": { @@ -7750,7 +7762,7 @@ "ConnectionProperties": { "target": "com.amazonaws.glue#ConnectionProperties", "traits": { - "smithy.api#documentation": "

These key-value pairs define parameters for the connection when using the version 1 Connection schema:

\n
    \n
  • \n

    \n HOST - The host URI: either the\n fully qualified domain name (FQDN) or the IPv4 address of\n the database host.

    \n
  • \n
  • \n

    \n PORT - The port number, between\n 1024 and 65535, of the port on which the database host is\n listening for database connections.

    \n
  • \n
  • \n

    \n USER_NAME - The name under which\n to log in to the database. The value string for USER_NAME is \"USERNAME\".

    \n
  • \n
  • \n

    \n PASSWORD - A password,\n if one is used, for the user name.

    \n
  • \n
  • \n

    \n ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.

    \n
  • \n
  • \n

    \n JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the\n JAR file that contains the JDBC driver to use.

    \n
  • \n
  • \n

    \n JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.

    \n
  • \n
  • \n

    \n JDBC_ENGINE - The name of the JDBC engine to use.

    \n
  • \n
  • \n

    \n JDBC_ENGINE_VERSION - The version of the JDBC engine to use.

    \n
  • \n
  • \n

    \n CONFIG_FILES - (Reserved for future use.)

    \n
  • \n
  • \n

    \n INSTANCE_ID - The instance ID to use.

    \n
  • \n
  • \n

    \n JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.

    \n
  • \n
  • \n

    \n JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure\n Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the\n client. The default is false.

    \n
  • \n
  • \n

    \n CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.

    \n
  • \n
  • \n

    \n SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip Glue’s validation of the customer certificate.

    \n
  • \n
  • \n

    \n CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.

    \n
  • \n
  • \n

    \n CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.

    \n
  • \n
  • \n

    \n SECRET_ID - The secret ID used for the secret manager of credentials.

    \n
  • \n
  • \n

    \n CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection.

    \n
  • \n
  • \n

    \n CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection.

    \n
  • \n
  • \n

    \n CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or CUSTOM connection.

    \n
  • \n
  • \n

    \n KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.

    \n
  • \n
  • \n

    \n KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is \"true\".

    \n
  • \n
  • \n

    \n KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.

    \n
  • \n
  • \n

    \n KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is \"false\".

    \n
  • \n
  • \n

    \n KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).

    \n
  • \n
  • \n

    \n KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided keystore (Optional).

    \n
  • \n
  • \n

    \n KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).

    \n
  • \n
  • \n

    \n ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).

    \n
  • \n
  • \n

    \n ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).

    \n
  • \n
  • \n

    \n KAFKA_SASL_MECHANISM - \"SCRAM-SHA-512\", \"GSSAPI\", \"AWS_MSK_IAM\", or \"PLAIN\". These are the supported SASL Mechanisms.

    \n
  • \n
  • \n

    \n KAFKA_SASL_PLAIN_USERNAME - A plaintext username used to authenticate with the \"PLAIN\" mechanism.

    \n
  • \n
  • \n

    \n KAFKA_SASL_PLAIN_PASSWORD - A plaintext password used to authenticate with the \"PLAIN\" mechanism.

    \n
  • \n
  • \n

    \n ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD - The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected).

    \n
  • \n
  • \n

    \n KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the \"SCRAM-SHA-512\" mechanism.

    \n
  • \n
  • \n

    \n KAFKA_SASL_SCRAM_PASSWORD - A plaintext password used to authenticate with the \"SCRAM-SHA-512\" mechanism.

    \n
  • \n
  • \n

    \n ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).

    \n
  • \n
  • \n

    \n KAFKA_SASL_SCRAM_SECRETS_ARN - The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.

    \n
  • \n
  • \n

    \n KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.

    \n
  • \n
  • \n

    \n KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.

    \n
  • \n
  • \n

    \n KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with sasl.kerberos.service.name in your Kafka Configuration.

    \n
  • \n
  • \n

    \n KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.

    \n
  • \n
  • \n

    \n ROLE_ARN - The role to be used for running queries.

    \n
  • \n
  • \n

    \n REGION - The Amazon Web Services Region where queries will be run.

    \n
  • \n
  • \n

    \n WORKGROUP_NAME - The name of an Amazon Redshift serverless workgroup or Amazon Athena workgroup in which queries will run.

    \n
  • \n
  • \n

    \n CLUSTER_IDENTIFIER - The cluster identifier of an Amazon Redshift cluster in which queries will run.

    \n
  • \n
  • \n

    \n DATABASE - The Amazon Redshift database that you are connecting to.

    \n
  • \n
" + "smithy.api#documentation": "

These key-value pairs define parameters for the connection when using the version 1 Connection schema:

\n
    \n
  • \n

    \n HOST - The host URI: either the\n fully qualified domain name (FQDN) or the IPv4 address of\n the database host.

    \n
  • \n
  • \n

    \n PORT - The port number, between\n 1024 and 65535, of the port on which the database host is\n listening for database connections.

    \n
  • \n
  • \n

    \n USER_NAME - The name under which\n to log in to the database. The value string for USER_NAME is \"USERNAME\".

    \n
  • \n
  • \n

    \n PASSWORD - A password,\n if one is used, for the user name.

    \n
  • \n
  • \n

    \n ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.

    \n
  • \n
  • \n

    \n JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the\n JAR file that contains the JDBC driver to use.

    \n
  • \n
  • \n

    \n JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.

    \n
  • \n
  • \n

    \n JDBC_ENGINE - The name of the JDBC engine to use.

    \n
  • \n
  • \n

    \n JDBC_ENGINE_VERSION - The version of the JDBC engine to use.

    \n
  • \n
  • \n

    \n CONFIG_FILES - (Reserved for future use.)

    \n
  • \n
  • \n

    \n INSTANCE_ID - The instance ID to use.

    \n
  • \n
  • \n

    \n JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.

    \n
  • \n
  • \n

    \n JDBC_ENFORCE_SSL - A case-insensitive Boolean string (true, false) specifying whether Secure\n Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the\n client. The default is false.

    \n
  • \n
  • \n

    \n CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.

    \n
  • \n
  • \n

    \n SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip Glue’s validation of the customer certificate.

    \n
  • \n
  • \n

    \n CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.

    \n
  • \n
  • \n

    \n CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.

    \n
  • \n
  • \n

    \n SECRET_ID - The secret ID used for the secret manager of credentials.

    \n
  • \n
  • \n

    \n CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection.

    \n
  • \n
  • \n

    \n CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection.

    \n
  • \n
  • \n

    \n CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or CUSTOM connection.

    \n
  • \n
  • \n

    \n KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.

    \n
  • \n
  • \n

    \n KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is \"true\".

    \n
  • \n
  • \n

    \n KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.

    \n
  • \n
  • \n

    \n KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is \"false\".

    \n
  • \n
  • \n

    \n KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).

    \n
  • \n
  • \n

    \n KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided keystore (Optional).

    \n
  • \n
  • \n

    \n KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).

    \n
  • \n
  • \n

    \n ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).

    \n
  • \n
  • \n

    \n ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).

    \n
  • \n
  • \n

    \n KAFKA_SASL_MECHANISM - \"SCRAM-SHA-512\", \"GSSAPI\", \"AWS_MSK_IAM\", or \"PLAIN\". These are the supported SASL Mechanisms.

    \n
  • \n
  • \n

    \n KAFKA_SASL_PLAIN_USERNAME - A plaintext username used to authenticate with the \"PLAIN\" mechanism.

    \n
  • \n
  • \n

    \n KAFKA_SASL_PLAIN_PASSWORD - A plaintext password used to authenticate with the \"PLAIN\" mechanism.

    \n
  • \n
  • \n

    \n ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD - The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected).

    \n
  • \n
  • \n

    \n KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the \"SCRAM-SHA-512\" mechanism.

    \n
  • \n
  • \n

    \n KAFKA_SASL_SCRAM_PASSWORD - A plaintext password used to authenticate with the \"SCRAM-SHA-512\" mechanism.

    \n
  • \n
  • \n

    \n ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).

    \n
  • \n
  • \n

    \n KAFKA_SASL_SCRAM_SECRETS_ARN - The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.

    \n
  • \n
  • \n

    \n KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.

    \n
  • \n
  • \n

    \n KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.

    \n
  • \n
  • \n

    \n KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with sasl.kerberos.service.name in your Kafka Configuration.

    \n
  • \n
  • \n

    \n KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.

    \n
  • \n
  • \n

    \n ROLE_ARN - The role to be used for running queries.

    \n
  • \n
  • \n

    \n REGION - The Amazon Web Services Region where queries will be run.

    \n
  • \n
  • \n

    \n WORKGROUP_NAME - The name of an Amazon Redshift serverless workgroup or Amazon Athena workgroup in which queries will run.

    \n
  • \n
  • \n

    \n CLUSTER_IDENTIFIER - The cluster identifier of an Amazon Redshift cluster in which queries will run.

    \n
  • \n
  • \n

    \n DATABASE - The Amazon Redshift database that you are connecting to.

    \n
  • \n
" } }, "SparkProperties": { @@ -8486,18 +8498,60 @@ "smithy.api#enumValue": "SALESFORCEMARKETINGCLOUD" } }, + "ADOBEANALYTICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADOBEANALYTICS" + } + }, "SLACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SLACK" } }, + "LINKEDIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINKEDIN" + } + }, + "MIXPANEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIXPANEL" + } + }, + "ASANA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASANA" + } + }, "STRIPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STRIPE" } }, + "SMARTSHEET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMARTSHEET" + } + }, + "DATADOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATADOG" + } + }, + "WOOCOMMERCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WOOCOMMERCE" + } + }, "INTERCOM": { "target": "smithy.api#Unit", "traits": { @@ -8509,6 +8563,342 @@ "traits": { "smithy.api#enumValue": "SNAPCHATADS" } + }, + "PAYPAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAYPAL" + } + }, + "QUICKBOOKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKBOOKS" + } + }, + "FACEBOOKPAGEINSIGHTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACEBOOKPAGEINSIGHTS" + } + }, + "FRESHDESK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRESHDESK" + } + }, + "TWILIO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TWILIO" + } + }, + "DOCUSIGNMONITOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUSIGNMONITOR" + } + }, + "FRESHSALES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRESHSALES" + } + }, + "ZOOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZOOM" + } + }, + "GOOGLESEARCHCONSOLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLESEARCHCONSOLE" + } + }, + "SALESFORCECOMMERCECLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCECOMMERCECLOUD" + } + }, + "SAPCONCUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAPCONCUR" + } + }, + "DYNATRACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNATRACE" + } + }, + "MICROSOFTDYNAMIC365FINANCEANDOPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MICROSOFTDYNAMIC365FINANCEANDOPS" + } + }, + "MICROSOFTTEAMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MICROSOFTTEAMS" + } + }, + "BLACKBAUDRAISEREDGENXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLACKBAUDRAISEREDGENXT" + } + }, + "MAILCHIMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAILCHIMP" + } + }, + "GITLAB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITLAB" + } + }, + "PENDO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDO" + } + }, + "PRODUCTBOARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRODUCTBOARD" + } + }, + "CIRCLECI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CIRCLECI" + } + }, + "PIPEDIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PIPEDIVE" + } + }, + "SENDGRID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SENDGRID" + } + }, + "AZURECOSMOS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AZURECOSMOS" + } + }, + "AZURESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AZURESQL" + } + }, + "BIGQUERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIGQUERY" + } + }, + "BLACKBAUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLACKBAUD" + } + }, + "CLOUDERAHIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDERAHIVE" + } + }, + "CLOUDERAIMPALA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDERAIMPALA" + } + }, + "CLOUDWATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDWATCH" + } + }, + "CLOUDWATCHMETRICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDWATCHMETRICS" + } + }, + "CMDB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CMDB" + } + }, + "DATALAKEGEN2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATALAKEGEN2" + } + }, + "DB2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DB2" + } + }, + "DB2AS400": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DB2AS400" + } + }, + "DOCUMENTDB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENTDB" + } + }, + "DOMO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMO" + } + }, + "DYNAMODB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNAMODB" + } + }, + "GOOGLECLOUDSTORAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLECLOUDSTORAGE" + } + }, + "HBASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HBASE" + } + }, + "KUSTOMER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KUSTOMER" + } + }, + "MICROSOFTDYNAMICS365CRM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MICROSOFTDYNAMICS365CRM" + } + }, + "MONDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONDAY" + } + }, + "MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL" + } + }, + "OKTA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OKTA" + } + }, + "OPENSEARCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENSEARCH" + } + }, + "ORACLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORACLE" + } + }, + "PIPEDRIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PIPEDRIVE" + } + }, + "POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRESQL" + } + }, + "SAPHANA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAPHANA" + } + }, + "SQLSERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQLSERVER" + } + }, + "SYNAPSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNAPSE" + } + }, + "TERADATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERADATA" + } + }, + "TERADATANOS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERADATANOS" + } + }, + "TIMESTREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTREAM" + } + }, + "TPCDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TPCDS" + } + }, + "VERTICA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERTICA" + } } } }, @@ -8735,6 +9125,9 @@ } } }, + "com.amazonaws.glue#ContinuousSync": { + "type": "boolean" + }, "com.amazonaws.glue#Crawl": { "type": "structure", "members": { @@ -10472,6 +10865,75 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#CreateGlueIdentityCenterConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#CreateGlueIdentityCenterConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.glue#CreateGlueIdentityCenterConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#AlreadyExistsException" + }, + { + "target": "com.amazonaws.glue#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Glue Identity Center configuration to enable integration between Glue and Amazon Web Services IAM \n Identity Center for authentication and authorization.

" + } + }, + "com.amazonaws.glue#CreateGlueIdentityCenterConfigurationRequest": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.glue#IdentityCenterInstanceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity Center instance to be associated with the Glue configuration.

", + "smithy.api#required": {} + } + }, + "Scopes": { + "target": "com.amazonaws.glue#IdentityCenterScopesList", + "traits": { + "smithy.api#documentation": "

A list of Identity Center scopes that define the permissions and access levels for the Glue configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Request to create a new Glue Identity Center configuration.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#CreateGlueIdentityCenterConfigurationResponse": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.glue#ApplicationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity Center application that was created for the Glue configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response from creating a new Glue Identity Center configuration.

", + "smithy.api#output": {} + } + }, "com.amazonaws.glue#CreateGrokClassifierRequest": { "type": "structure", "members": { @@ -13442,6 +13904,52 @@ "smithy.api#documentation": "

Additional run options you can specify for an evaluation run.

" } }, + "com.amazonaws.glue#DataQualityGlueTable": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

A database name in the Glue Data Catalog.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

A table name in the Glue Data Catalog.

", + "smithy.api#required": {} + } + }, + "CatalogId": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

A unique identifier for the Glue Data Catalog.

" + } + }, + "ConnectionName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the connection to the Glue Data Catalog.

" + } + }, + "AdditionalOptions": { + "target": "com.amazonaws.glue#GlueTableAdditionalOptions", + "traits": { + "smithy.api#documentation": "

Additional options for the table. Currently there are two keys supported:

\n
    \n
  • \n

    \n pushDownPredicate: to filter on partitions without having to list and read all the files in your dataset.

    \n
  • \n
  • \n

    \n catalogPartitionPredicate: to use server-side partition pruning using partition indexes in the Glue Data Catalog.

    \n
  • \n
" + } + }, + "PreProcessingQuery": { + "target": "com.amazonaws.glue#PreProcessingQueryString", + "traits": { + "smithy.api#documentation": "

SQL Query of SparkSQL format that can be used to pre-process the data for the table in Glue Data Catalog,\n before running the Data Quality Operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The database and table in the Glue Data Catalog that is used for input or output data\n for Data Quality Operations.

" + } + }, "com.amazonaws.glue#DataQualityMetricValues": { "type": "structure", "members": { @@ -14125,8 +14633,13 @@ "GlueTable": { "target": "com.amazonaws.glue#GlueTable", "traits": { - "smithy.api#documentation": "

An Glue table.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An Glue table.

" + } + }, + "DataQualityGlueTable": { + "target": "com.amazonaws.glue#DataQualityGlueTable", + "traits": { + "smithy.api#documentation": "

An Glue table for Data Quality Operations.

" } } }, @@ -14214,6 +14727,12 @@ "traits": { "smithy.api#enumValue": "NAME" } + }, + "TARGET_DATABASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TARGET_DATABASE" + } } } }, @@ -15191,6 +15710,54 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#DeleteGlueIdentityCenterConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DeleteGlueIdentityCenterConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.glue#DeleteGlueIdentityCenterConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the existing Glue Identity Center configuration, removing the integration between Glue and \n Amazon Web Services IAM Identity Center.

" + } + }, + "com.amazonaws.glue#DeleteGlueIdentityCenterConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Request to delete the existing Glue Identity Center configuration.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DeleteGlueIdentityCenterConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Response from deleting the Glue Identity Center configuration.

", + "smithy.api#output": {} + } + }, "com.amazonaws.glue#DeleteIntegration": { "type": "operation", "input": { @@ -21694,6 +22261,73 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#GetGlueIdentityCenterConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetGlueIdentityCenterConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetGlueIdentityCenterConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the current Glue Identity Center configuration details, including the associated Identity Center instance and \n application information.

" + } + }, + "com.amazonaws.glue#GetGlueIdentityCenterConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Request to retrieve the Glue Identity Center configuration.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetGlueIdentityCenterConfigurationResponse": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.glue#ApplicationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity Center application associated with the Glue configuration.

" + } + }, + "InstanceArn": { + "target": "com.amazonaws.glue#IdentityCenterInstanceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity Center instance associated with the Glue configuration.

" + } + }, + "Scopes": { + "target": "com.amazonaws.glue#OrchestrationStringList", + "traits": { + "smithy.api#documentation": "

A list of Identity Center scopes that define the permissions and access levels for the Glue configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Response containing the Glue Identity Center configuration details.

", + "smithy.api#output": {} + } + }, "com.amazonaws.glue#GetIntegrationResourceProperty": { "type": "operation", "input": { @@ -26227,6 +26861,18 @@ "traits": { "smithy.api#documentation": "

The strategy to use for compaction. Valid values are:

\n
    \n
  • \n

    \n binpack: Combines small files into larger files, typically targeting sizes over 100MB, while applying any pending deletes. \n This is the recommended compaction strategy for most use cases.\n

    \n
  • \n
  • \n

    \n sort: Organizes data based on specified columns which are sorted hierarchically during compaction, improving query \n performance for filtered operations. This strategy is recommended when your queries frequently filter on specific columns. To use this strategy, \n you must first define a sort order in your Iceberg table properties using the sort_order table property.

    \n
  • \n
  • \n

    \n z-order: Optimizes data organization by blending multiple attributes into a single scalar value that can be used for sorting, \n allowing efficient querying across multiple dimensions. This strategy is recommended when you need to query data across multiple dimensions \n simultaneously. To use this strategy, you must first define a sort order in your Iceberg table properties using the \n sort_order table property.\n

    \n
  • \n
\n

If an input is not provided, the default value 'binpack' will be used.

" } + }, + "minInputFiles": { + "target": "com.amazonaws.glue#NullableInteger", + "traits": { + "smithy.api#documentation": "

The minimum number of data files that must be present in a partition before compaction will actually compact files. This parameter helps control when compaction is triggered, preventing unnecessary compaction operations on partitions with few files. If an input is not provided, the default value 100 will be used.

" + } + }, + "deleteFileThreshold": { + "target": "com.amazonaws.glue#NullableInteger", + "traits": { + "smithy.api#documentation": "

The minimum number of deletes that must be present in a data file to make it eligible for compaction. This parameter helps optimize compaction by focusing on files that contain a significant number of delete operations, which can improve query performance by removing deleted records. If an input is not provided, the default value 1 will be used.

" + } } }, "traits": { @@ -26323,6 +26969,76 @@ } } }, + "com.amazonaws.glue#IcebergOptimizationProperties": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.glue#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that will be assumed to perform Iceberg table optimization operations.

" + } + }, + "Compaction": { + "target": "com.amazonaws.glue#ParametersMap", + "traits": { + "smithy.api#documentation": "

A map of key-value pairs that specify configuration parameters for Iceberg table compaction operations, which optimize the layout of data files to improve query performance.

" + } + }, + "Retention": { + "target": "com.amazonaws.glue#ParametersMap", + "traits": { + "smithy.api#documentation": "

A map of key-value pairs that specify configuration parameters for Iceberg table retention operations, which manage the lifecycle of table snapshots to control storage costs.

" + } + }, + "OrphanFileDeletion": { + "target": "com.amazonaws.glue#ParametersMap", + "traits": { + "smithy.api#documentation": "

A map of key-value pairs that specify configuration parameters for Iceberg orphan file deletion operations, which identify and remove files that are no longer referenced by the table metadata.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that specifies Iceberg table optimization properties for the catalog, including configurations for compaction, retention, and orphan file deletion operations.

" + } + }, + "com.amazonaws.glue#IcebergOptimizationPropertiesOutput": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.glue#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is used to perform Iceberg table optimization operations.

" + } + }, + "Compaction": { + "target": "com.amazonaws.glue#ParametersMap", + "traits": { + "smithy.api#documentation": "

A map of key-value pairs that specify configuration parameters for Iceberg table compaction operations, which optimize the layout of data files to improve query performance.

" + } + }, + "Retention": { + "target": "com.amazonaws.glue#ParametersMap", + "traits": { + "smithy.api#documentation": "

A map of key-value pairs that specify configuration parameters for Iceberg table retention operations, which manage the lifecycle of table snapshots to control storage costs.

" + } + }, + "OrphanFileDeletion": { + "target": "com.amazonaws.glue#ParametersMap", + "traits": { + "smithy.api#documentation": "

A map of key-value pairs that specify configuration parameters for Iceberg orphan file deletion operations, which identify and remove files that are no longer referenced by the table metadata.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the Iceberg optimization properties were last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the output properties of Iceberg table optimization configuration for your catalog resource in the Glue \n Data Catalog.

" + } + }, "com.amazonaws.glue#IcebergOrphanFileDeletionConfiguration": { "type": "structure", "members": { @@ -26337,6 +27053,12 @@ "traits": { "smithy.api#documentation": "

Specifies a directory in which to look for files (defaults to the table's location). You may choose a sub-directory rather than the top-level table location.

" } + }, + "runRateInHours": { + "target": "com.amazonaws.glue#NullableInteger", + "traits": { + "smithy.api#documentation": "

The interval in hours between orphan file deletion job runs. This parameter controls how frequently the orphan file deletion optimizer will run to clean up orphan files. The value must be between 3 and 168 hours (7 days). If an input is not provided, the default value 24 will be used.

" + } } }, "traits": { @@ -26464,6 +27186,12 @@ "traits": { "smithy.api#documentation": "

If set to false, snapshots are only deleted from table metadata, and the underlying data and metadata files are not deleted.

" } + }, + "runRateInHours": { + "target": "com.amazonaws.glue#NullableInteger", + "traits": { + "smithy.api#documentation": "

The interval in hours between retention job runs. This parameter controls how frequently the retention optimizer will run to clean up expired snapshots. The value must be between 3 and 168 hours (7 days). If an input is not provided, the default value 24 will be used.

" + } } }, "traits": { @@ -26839,6 +27567,36 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#IdentityCenterInstanceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1224 + } + } + }, + "com.amazonaws.glue#IdentityCenterScope": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.glue#IdentityCenterScopesList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#IdentityCenterScope" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.glue#IdleTimeout": { "type": "integer" }, @@ -27176,6 +27934,12 @@ "traits": { "smithy.api#documentation": "

\n A collection of key-value pairs that specify additional properties for the integration source. These properties provide configuration options that \n can be used to customize the behavior of the ODB source during data integration operations.\n

" } + }, + "ContinuousSync": { + "target": "com.amazonaws.glue#ContinuousSync", + "traits": { + "smithy.api#documentation": "

Enables continuous synchronization for on-demand data extractions from SaaS applications to Amazon Web Services data services like Amazon Redshift \n and Amazon S3.

" + } } }, "traits": { @@ -27300,7 +28064,7 @@ "FunctionSpec": { "target": "com.amazonaws.glue#String128", "traits": { - "smithy.api#documentation": "

Specifies the function used to partition data on the target. The only accepted value for this parameter is `'identity'` (string). \n The `'identity'` function ensures that the data partitioning on the target follows the same scheme as the source. In other words, the partitioning \n structure of the source data is preserved in the target destination.

" + "smithy.api#documentation": "

Specifies the function used to partition data on the target. The accepted values for this parameter are:

\n
    \n
  • \n

    \n identity - Uses source values directly without transformation

    \n
  • \n
  • \n

    \n year - Extracts the year from timestamp values (e.g., 2023)

    \n
  • \n
  • \n

    \n month - Extracts the month from timestamp values (e.g., 2023-01)

    \n
  • \n
  • \n

    \n day - Extracts the day from timestamp values (e.g., 2023-01-15)

    \n
  • \n
  • \n

    \n hour - Extracts the hour from timestamp values (e.g., 2023-01-15-14)

    \n
  • \n
" } }, "ConversionSpec": { @@ -32318,6 +33082,9 @@ "smithy.api#documentation": "

Selects source tables for the integration using Maxwell filter syntax.

" } }, + "IntegrationConfig": { + "target": "com.amazonaws.glue#IntegrationConfig" + }, "IntegrationName": { "target": "com.amazonaws.glue#String128", "traits": { @@ -32409,6 +33176,9 @@ "traits": { "smithy.api#documentation": "

Selects source tables for the integration using Maxwell filter syntax.

" } + }, + "IntegrationConfig": { + "target": "com.amazonaws.glue#IntegrationConfig" } }, "traits": { @@ -34154,6 +34924,17 @@ "smithy.api#documentation": "

Specifies a target that uses Postgres SQL.

" } }, + "com.amazonaws.glue#PreProcessingQueryString": { + "type": "string", + "traits": { + "smithy.api#documentation": "

SQL Query of SparkSQL format that can be used to pre-process data before running Data Quality Operations.

", + "smithy.api#length": { + "min": 0, + "max": 51200 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, "com.amazonaws.glue#Predecessor": { "type": "structure", "members": { @@ -41840,6 +42621,12 @@ "traits": { "smithy.api#documentation": "

A TableOptimizerRun object representing the last run of the table optimizer.

" } + }, + "configurationSource": { + "target": "com.amazonaws.glue#ConfigurationSource", + "traits": { + "smithy.api#documentation": "

\n Specifies the source of the optimizer configuration. This indicates how the table optimizer was configured and which entity or service \n initiated the configuration. \n

" + } } }, "traits": { @@ -44719,6 +45506,61 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#UpdateGlueIdentityCenterConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#UpdateGlueIdentityCenterConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.glue#UpdateGlueIdentityCenterConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the existing Glue Identity Center configuration, allowing modification of scopes and permissions for the integration.

" + } + }, + "com.amazonaws.glue#UpdateGlueIdentityCenterConfigurationRequest": { + "type": "structure", + "members": { + "Scopes": { + "target": "com.amazonaws.glue#IdentityCenterScopesList", + "traits": { + "smithy.api#documentation": "

A list of Identity Center scopes that define the updated permissions and access levels for the Glue configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Request to update an existing Glue Identity Center configuration.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#UpdateGlueIdentityCenterConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Response from updating an existing Glue Identity Center configuration.

", + "smithy.api#output": {} + } + }, "com.amazonaws.glue#UpdateGrokClassifierRequest": { "type": "structure", "members": { @@ -44779,7 +45621,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the update operations to be applied to an existing Iceberg table in AWS Glue Data Catalog, defining the new state of the table metadata.\n

" + "smithy.api#documentation": "

Contains the update operations to be applied to an existing Iceberg table inGlue Data Catalog, defining the new state of the table metadata.\n

" } }, "com.amazonaws.glue#UpdateIntegrationResourceProperty": { diff --git a/codegen/sdk/aws-models/grafana.json b/codegen/sdk/aws-models/grafana.json index 2f64bbcab04..681001013af 100644 --- a/codegen/sdk/aws-models/grafana.json +++ b/codegen/sdk/aws-models/grafana.json @@ -666,17 +666,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -690,17 +679,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -714,17 +692,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -738,17 +705,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/greengrass.json b/codegen/sdk/aws-models/greengrass.json index d7dd7e0482e..084907acdd5 100644 --- a/codegen/sdk/aws-models/greengrass.json +++ b/codegen/sdk/aws-models/greengrass.json @@ -5501,6 +5501,9 @@ "name": "greengrass" }, "aws.protocols#restJson1": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], "smithy.api#documentation": "AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS IoT Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS IoT Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally.", "smithy.api#title": "AWS Greengrass", "smithy.rules#endpointRuleSet": { @@ -6280,17 +6283,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6304,17 +6296,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -6328,17 +6309,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6352,17 +6322,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/greengrassv2.json b/codegen/sdk/aws-models/greengrassv2.json index 6b03e5a0772..4167c2ca023 100644 --- a/codegen/sdk/aws-models/greengrassv2.json +++ b/codegen/sdk/aws-models/greengrassv2.json @@ -3558,17 +3558,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3582,17 +3571,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3606,17 +3584,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3630,17 +3597,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/groundstation.json b/codegen/sdk/aws-models/groundstation.json index a629252c52f..84a518f601e 100644 --- a/codegen/sdk/aws-models/groundstation.json +++ b/codegen/sdk/aws-models/groundstation.json @@ -3934,17 +3934,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3958,17 +3947,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3982,17 +3960,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4006,17 +3973,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/guardduty.json b/codegen/sdk/aws-models/guardduty.json index c56ab51a6d0..3b136311854 100644 --- a/codegen/sdk/aws-models/guardduty.json +++ b/codegen/sdk/aws-models/guardduty.json @@ -323,7 +323,7 @@ "target": "com.amazonaws.guardduty#Email", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The email address of the member account.

\n

The rules for a valid email address:

\n
    \n
  • \n

    The email address must be a minimum of 6 and a maximum of 64 characters long.

    \n
  • \n
  • \n

    All characters must be 7-bit ASCII characters.

    \n
  • \n
  • \n

    There must be one and only one @ symbol, which separates the local name from the domain name.

    \n
  • \n
  • \n

    The local name can't contain any of the following characters:

    \n

    whitespace, \" ' ( ) < > [ ] : ' , \\ | % &

    \n
  • \n
  • \n

    The local name can't begin with a dot (.).

    \n
  • \n
  • \n

    The domain name can consist of only the characters [a-z], [A-Z], [0-9], hyphen (-), or dot (.).

    \n
  • \n
  • \n

    The domain name can't begin or end with a dot (.) or hyphen (-).

    \n
  • \n
  • \n

    The domain name must contain at least one dot.

    \n
  • \n
", + "smithy.api#documentation": "

The email address of the member account. The following list includes the\n rules for a valid email address:

\n
    \n
  • \n

    The email address must be a minimum of 6 and a maximum of 64 characters long.

    \n
  • \n
  • \n

    All characters must be 7-bit ASCII characters.

    \n
  • \n
  • \n

    There must be one and only one @ symbol, which separates the local name from the domain name.

    \n
  • \n
  • \n

    The local name can't contain any of the following characters:

    \n

    whitespace, \" ' ( ) < > [ ] : ' , \\ | % &

    \n
  • \n
  • \n

    The local name can't begin with a dot (.).

    \n
  • \n
  • \n

    The domain name can consist of only the characters [a-z], [A-Z], [0-9], hyphen (-), or dot (.).

    \n
  • \n
  • \n

    The domain name can't begin or end with a dot (.) or hyphen (-).

    \n
  • \n
  • \n

    The domain name must contain at least one dot.

    \n
  • \n
", "smithy.api#jsonName": "email", "smithy.api#required": {} } @@ -2225,7 +2225,7 @@ "target": "com.amazonaws.guardduty#FindingCriteria", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Represents the criteria to be used in the filter for querying findings.

\n

You can only use the following attributes to query findings:

\n
    \n
  • \n

    accountId

    \n
  • \n
  • \n

    id

    \n
  • \n
  • \n

    region

    \n
  • \n
  • \n

    severity

    \n

    To filter on the basis of severity, the API and CLI use the following input list for\n the FindingCriteria\n condition:

    \n
      \n
    • \n

      \n Low: [\"1\", \"2\", \"3\"]\n

      \n
    • \n
    • \n

      \n Medium: [\"4\", \"5\", \"6\"]\n

      \n
    • \n
    • \n

      \n High: [\"7\", \"8\"]\n

      \n
    • \n
    • \n

      \n Critical: [\"9\", \"10\"]\n

      \n
    • \n
    \n

    For more information, see Findings severity levels\n in the Amazon GuardDuty User Guide.

    \n
  • \n
  • \n

    type

    \n
  • \n
  • \n

    updatedAt

    \n

    Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.

    \n
  • \n
  • \n

    resource.accessKeyDetails.accessKeyId

    \n
  • \n
  • \n

    resource.accessKeyDetails.principalId

    \n
  • \n
  • \n

    resource.accessKeyDetails.userName

    \n
  • \n
  • \n

    resource.accessKeyDetails.userType

    \n
  • \n
  • \n

    resource.instanceDetails.iamInstanceProfile.id

    \n
  • \n
  • \n

    resource.instanceDetails.imageId

    \n
  • \n
  • \n

    resource.instanceDetails.instanceId

    \n
  • \n
  • \n

    resource.instanceDetails.tags.key

    \n
  • \n
  • \n

    resource.instanceDetails.tags.value

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.ipv6Addresses

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.publicDnsName

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.publicIp

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.securityGroups.groupId

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.securityGroups.groupName

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.subnetId

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.vpcId

    \n
  • \n
  • \n

    resource.instanceDetails.outpostArn

    \n
  • \n
  • \n

    resource.resourceType

    \n
  • \n
  • \n

    resource.s3BucketDetails.publicAccess.effectivePermissions

    \n
  • \n
  • \n

    resource.s3BucketDetails.name

    \n
  • \n
  • \n

    resource.s3BucketDetails.tags.key

    \n
  • \n
  • \n

    resource.s3BucketDetails.tags.value

    \n
  • \n
  • \n

    resource.s3BucketDetails.type

    \n
  • \n
  • \n

    service.action.actionType

    \n
  • \n
  • \n

    service.action.awsApiCallAction.api

    \n
  • \n
  • \n

    service.action.awsApiCallAction.callerType

    \n
  • \n
  • \n

    service.action.awsApiCallAction.errorCode

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.city.cityName

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.country.countryName

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.ipAddressV4

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.ipAddressV6

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.organization.asn

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg

    \n
  • \n
  • \n

    service.action.awsApiCallAction.serviceName

    \n
  • \n
  • \n

    service.action.dnsRequestAction.domain

    \n
  • \n
  • \n

    service.action.dnsRequestAction.domainWithSuffix

    \n
  • \n
  • \n

    service.action.networkConnectionAction.blocked

    \n
  • \n
  • \n

    service.action.networkConnectionAction.connectionDirection

    \n
  • \n
  • \n

    service.action.networkConnectionAction.localPortDetails.port

    \n
  • \n
  • \n

    service.action.networkConnectionAction.protocol

    \n
  • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.city.cityName

    \n
  • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.country.countryName

    \n
  • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.ipAddressV4

    \n
  • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.ipAddressV6

    \n
  • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.organization.asn

    \n
  • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg

    \n
  • \n
  • \n

    service.action.networkConnectionAction.remotePortDetails.port

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteAccountDetails.affiliated

    \n
  • \n
  • \n

    service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4

    \n
  • \n
  • \n

    service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV6

    \n
  • \n
  • \n

    service.action.kubernetesApiCallAction.namespace

    \n
  • \n
  • \n

    service.action.kubernetesApiCallAction.remoteIpDetails.organization.asn

    \n
  • \n
  • \n

    service.action.kubernetesApiCallAction.requestUri

    \n
  • \n
  • \n

    service.action.kubernetesApiCallAction.statusCode

    \n
  • \n
  • \n

    service.action.networkConnectionAction.localIpDetails.ipAddressV4

    \n
  • \n
  • \n

    service.action.networkConnectionAction.localIpDetails.ipAddressV6

    \n
  • \n
  • \n

    service.action.networkConnectionAction.protocol

    \n
  • \n
  • \n

    service.action.awsApiCallAction.serviceName

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteAccountDetails.accountId

    \n
  • \n
  • \n

    service.additionalInfo.threatListName

    \n
  • \n
  • \n

    service.resourceRole

    \n
  • \n
  • \n

    resource.eksClusterDetails.name

    \n
  • \n
  • \n

    resource.kubernetesDetails.kubernetesWorkloadDetails.name

    \n
  • \n
  • \n

    resource.kubernetesDetails.kubernetesWorkloadDetails.namespace

    \n
  • \n
  • \n

    resource.kubernetesDetails.kubernetesUserDetails.username

    \n
  • \n
  • \n

    resource.kubernetesDetails.kubernetesWorkloadDetails.containers.image

    \n
  • \n
  • \n

    resource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix

    \n
  • \n
  • \n

    service.ebsVolumeScanDetails.scanId

    \n
  • \n
  • \n

    service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name

    \n
  • \n
  • \n

    service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity

    \n
  • \n
  • \n

    service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash

    \n
  • \n
  • \n

    resource.ecsClusterDetails.name

    \n
  • \n
  • \n

    resource.ecsClusterDetails.taskDetails.containers.image

    \n
  • \n
  • \n

    resource.ecsClusterDetails.taskDetails.definitionArn

    \n
  • \n
  • \n

    resource.containerDetails.image

    \n
  • \n
  • \n

    resource.rdsDbInstanceDetails.dbInstanceIdentifier

    \n
  • \n
  • \n

    resource.rdsDbInstanceDetails.dbClusterIdentifier

    \n
  • \n
  • \n

    resource.rdsDbInstanceDetails.engine

    \n
  • \n
  • \n

    resource.rdsDbUserDetails.user

    \n
  • \n
  • \n

    resource.rdsDbInstanceDetails.tags.key

    \n
  • \n
  • \n

    resource.rdsDbInstanceDetails.tags.value

    \n
  • \n
  • \n

    service.runtimeDetails.process.executableSha256

    \n
  • \n
  • \n

    service.runtimeDetails.process.name

    \n
  • \n
  • \n

    service.runtimeDetails.process.executablePath

    \n
  • \n
  • \n

    resource.lambdaDetails.functionName

    \n
  • \n
  • \n

    resource.lambdaDetails.functionArn

    \n
  • \n
  • \n

    resource.lambdaDetails.tags.key

    \n
  • \n
  • \n

    resource.lambdaDetails.tags.value

    \n
  • \n
", + "smithy.api#documentation": "

Represents the criteria to be used in the filter for querying findings.

\n

You can only use the following attributes to query findings:

\n
    \n
  • \n

    accountId

    \n
  • \n
  • \n

    id

    \n
  • \n
  • \n

    region

    \n
  • \n
  • \n

    severity

    \n

    To filter on the basis of severity, the API and CLI use the following input list for\n the FindingCriteria\n condition:

    \n
      \n
    • \n

      \n Low: [\"1\", \"2\", \"3\"]\n

      \n
    • \n
    • \n

      \n Medium: [\"4\", \"5\", \"6\"]\n

      \n
    • \n
    • \n

      \n High: [\"7\", \"8\"]\n

      \n
    • \n
    • \n

      \n Critical: [\"9\", \"10\"]\n

      \n
    • \n
    \n

    For more information, see Findings severity levels\n in the Amazon GuardDuty User Guide.

    \n
  • \n
  • \n

    type

    \n
  • \n
  • \n

    updatedAt

    \n

    Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.

    \n
  • \n
  • \n

    resource.accessKeyDetails.accessKeyId

    \n
  • \n
  • \n

    resource.accessKeyDetails.principalId

    \n
  • \n
  • \n

    resource.accessKeyDetails.userName

    \n
  • \n
  • \n

    resource.accessKeyDetails.userType

    \n
  • \n
  • \n

    resource.instanceDetails.iamInstanceProfile.id

    \n
  • \n
  • \n

    resource.instanceDetails.imageId

    \n
  • \n
  • \n

    resource.instanceDetails.instanceId

    \n
  • \n
  • \n

    resource.instanceDetails.tags.key

    \n
  • \n
  • \n

    resource.instanceDetails.tags.value

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.ipv6Addresses

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.publicDnsName

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.publicIp

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.securityGroups.groupId

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.securityGroups.groupName

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.subnetId

    \n
  • \n
  • \n

    resource.instanceDetails.networkInterfaces.vpcId

    \n
  • \n
  • \n

    resource.instanceDetails.outpostArn

    \n
  • \n
  • \n

    resource.resourceType

    \n
  • \n
  • \n

    resource.s3BucketDetails.publicAccess.effectivePermissions

    \n
  • \n
  • \n

    resource.s3BucketDetails.name

    \n
  • \n
  • \n

    resource.s3BucketDetails.tags.key

    \n
  • \n
  • \n

    resource.s3BucketDetails.tags.value

    \n
  • \n
  • \n

    resource.s3BucketDetails.type

    \n
  • \n
  • \n

    service.action.actionType

    \n
  • \n
  • \n

    service.action.awsApiCallAction.api

    \n
  • \n
  • \n

    service.action.awsApiCallAction.callerType

    \n
  • \n
  • \n

    service.action.awsApiCallAction.errorCode

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.city.cityName

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.country.countryName

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.ipAddressV4

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.ipAddressV6

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.organization.asn

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg

    \n
  • \n
  • \n

    service.action.awsApiCallAction.serviceName

    \n
  • \n
  • \n

    service.action.dnsRequestAction.domain

    \n
  • \n
  • \n

    service.action.dnsRequestAction.domainWithSuffix

    \n
  • \n
  • \n

    service.action.dnsRequestAction.vpcOwnerAccountId

    \n
  • \n
  • \n

    service.action.networkConnectionAction.blocked

    \n
  • \n
  • \n

    service.action.networkConnectionAction.connectionDirection

    \n
  • \n
  • \n

    service.action.networkConnectionAction.localPortDetails.port

    \n
  • \n
  • \n

    service.action.networkConnectionAction.protocol

    \n
  • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.city.cityName

    \n
  • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.country.countryName

    \n
  • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.ipAddressV4

    \n
  • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.ipAddressV6

    \n
  • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.organization.asn

    \n
  • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg

    \n
  • \n
  • \n

    service.action.networkConnectionAction.remotePortDetails.port

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteAccountDetails.affiliated

    \n
  • \n
  • \n

    service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4

    \n
  • \n
  • \n

    service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV6

    \n
  • \n
  • \n

    service.action.kubernetesApiCallAction.namespace

    \n
  • \n
  • \n

    service.action.kubernetesApiCallAction.remoteIpDetails.organization.asn

    \n
  • \n
  • \n

    service.action.kubernetesApiCallAction.requestUri

    \n
  • \n
  • \n

    service.action.kubernetesApiCallAction.statusCode

    \n
  • \n
  • \n

    service.action.networkConnectionAction.localIpDetails.ipAddressV4

    \n
  • \n
  • \n

    service.action.networkConnectionAction.localIpDetails.ipAddressV6

    \n
  • \n
  • \n

    service.action.networkConnectionAction.protocol

    \n
  • \n
  • \n

    service.action.awsApiCallAction.serviceName

    \n
  • \n
  • \n

    service.action.awsApiCallAction.remoteAccountDetails.accountId

    \n
  • \n
  • \n

    service.additionalInfo.threatListName

    \n
  • \n
  • \n

    service.resourceRole

    \n
  • \n
  • \n

    resource.eksClusterDetails.name

    \n
  • \n
  • \n

    resource.kubernetesDetails.kubernetesWorkloadDetails.name

    \n
  • \n
  • \n

    resource.kubernetesDetails.kubernetesWorkloadDetails.namespace

    \n
  • \n
  • \n

    resource.kubernetesDetails.kubernetesUserDetails.username

    \n
  • \n
  • \n

    resource.kubernetesDetails.kubernetesWorkloadDetails.containers.image

    \n
  • \n
  • \n

    resource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix

    \n
  • \n
  • \n

    service.ebsVolumeScanDetails.scanId

    \n
  • \n
  • \n

    service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name

    \n
  • \n
  • \n

    service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity

    \n
  • \n
  • \n

    service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash

    \n
  • \n
  • \n

    resource.ecsClusterDetails.name

    \n
  • \n
  • \n

    resource.ecsClusterDetails.taskDetails.containers.image

    \n
  • \n
  • \n

    resource.ecsClusterDetails.taskDetails.definitionArn

    \n
  • \n
  • \n

    resource.containerDetails.image

    \n
  • \n
  • \n

    resource.rdsDbInstanceDetails.dbInstanceIdentifier

    \n
  • \n
  • \n

    resource.rdsDbInstanceDetails.dbClusterIdentifier

    \n
  • \n
  • \n

    resource.rdsDbInstanceDetails.engine

    \n
  • \n
  • \n

    resource.rdsDbUserDetails.user

    \n
  • \n
  • \n

    resource.rdsDbInstanceDetails.tags.key

    \n
  • \n
  • \n

    resource.rdsDbInstanceDetails.tags.value

    \n
  • \n
  • \n

    service.runtimeDetails.process.executableSha256

    \n
  • \n
  • \n

    service.runtimeDetails.process.name

    \n
  • \n
  • \n

    service.runtimeDetails.process.executablePath

    \n
  • \n
  • \n

    resource.lambdaDetails.functionName

    \n
  • \n
  • \n

    resource.lambdaDetails.functionArn

    \n
  • \n
  • \n

    resource.lambdaDetails.tags.key

    \n
  • \n
  • \n

    resource.lambdaDetails.tags.value

    \n
  • \n
", "smithy.api#jsonName": "findingCriteria", "smithy.api#required": {} } @@ -2727,6 +2727,123 @@ "smithy.api#output": {} } }, + "com.amazonaws.guardduty#CreateThreatEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateThreatEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#CreateThreatEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new threat entity set. In a threat entity set, you can provide known malicious \n IP addresses and domains for your Amazon Web Services environment. \n GuardDuty generates findings based on the entries in the threat entity sets. \n Only users of the administrator account can manage entity sets, which automatically apply\n to member accounts.

", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/threatentityset", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateThreatEntitySetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty account for which you want to create a threat entity set.

\n

To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A user-friendly name to identify the threat entity set.

\n

The name of your list can include \n lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.guardduty#ThreatEntitySetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The format of the file that contains the threat entity set.

", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The URI of the file that contains the threat entity set.

", + "smithy.api#jsonName": "location", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#ExpectedBucketOwner", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

", + "smithy.api#jsonName": "expectedBucketOwner" + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A boolean value that indicates whether GuardDuty should start using the uploaded threat entity set to\n generate findings.

", + "smithy.api#jsonName": "activate", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token for the create request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to be added to a new threat entity set resource.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateThreatEntitySetResponse": { + "type": "structure", + "members": { + "ThreatEntitySetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID returned by GuardDuty after creation of the threat entity set resource.

", + "smithy.api#jsonName": "threatEntitySetId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.guardduty#CreateThreatIntelSet": { "type": "operation", "input": { @@ -2761,7 +2878,7 @@ "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { - "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty account for which you want to create a\n ThreatIntelSet.

\n

To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.

", + "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty account for which you want to create a\n threatIntelSet.

\n

To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.

", "smithy.api#httpLabel": {}, "smithy.api#jsonName": "detectorId", "smithy.api#required": {} @@ -2847,6 +2964,123 @@ "smithy.api#output": {} } }, + "com.amazonaws.guardduty#CreateTrustedEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateTrustedEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#CreateTrustedEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new trusted entity set. In the trusted entity set, you can provide IP addresses\n and domains that you believe are secure for communication in your Amazon Web Services environment. GuardDuty \n will not generate findings for the entries that are specified in a trusted entity set. At any\n given time, you can have only one trusted entity set.

\n

Only users of the administrator account can manage the entity sets, which automatically\n apply to member accounts.

", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/trustedentityset", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateTrustedEntitySetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty account for which you want to create a trusted\n entity set.

\n

To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A user-friendly name to identify the trusted entity set.

\n

The name of your list can include \n lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.guardduty#TrustedEntitySetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The format of the file that contains the trusted entity set.

", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The URI of the file that contains the trusted entity set.

", + "smithy.api#jsonName": "location", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#ExpectedBucketOwner", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location\n parameter.

", + "smithy.api#jsonName": "expectedBucketOwner" + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A boolean value that indicates whether GuardDuty is to start using the uploaded trusted entity set.

", + "smithy.api#jsonName": "activate", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token for the create request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to be added to a new trusted entity set resource.

", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateTrustedEntitySetResponse": { + "type": "structure", + "members": { + "TrustedEntitySetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID returned by GuardDuty after creation of the trusted entity set resource.

", + "smithy.api#jsonName": "trustedEntitySetId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.guardduty#Criterion": { "type": "map", "key": { @@ -3657,6 +3891,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.guardduty#DeleteThreatEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteThreatEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DeleteThreatEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the threat entity set that is associated with the specified \n threatEntitySetId.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/detector/{DetectorId}/threatentityset/{ThreatEntitySetId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DeleteThreatEntitySetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the detector associated with the threat entity set resource.

\n

To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "ThreatEntitySetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The unique ID that helps GuardDuty identify which threat entity set needs to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "threatEntitySetId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteThreatEntitySetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.guardduty#DeleteThreatIntelSet": { "type": "operation", "input": { @@ -3715,6 +4007,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.guardduty#DeleteTrustedEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteTrustedEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DeleteTrustedEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the trusted entity set that is associated with the specified \n trustedEntitySetId.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/detector/{DetectorId}/trustedentityset/{TrustedEntitySetId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DeleteTrustedEntitySetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the detector associated with the trusted entity set resource.

\n

To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "TrustedEntitySetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The unique ID that helps GuardDuty identify which trusted entity set needs to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "trustedEntitySetId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteTrustedEntitySetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.guardduty#DescribeMalwareScans": { "type": "operation", "input": { @@ -4692,6 +5042,13 @@ "smithy.api#documentation": "

The second and top level domain involved in the \n activity that potentially prompted GuardDuty to generate this finding.\n For a list of top-level and second-level domains, see public suffix list.

", "smithy.api#jsonName": "domainWithSuffix" } + }, + "VpcOwnerAccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the VPC through which the DNS request was made.

", + "smithy.api#jsonName": "vpcOwnerAccountId" + } } }, "traits": { @@ -5227,7 +5584,6 @@ "min": 6, "max": 64 }, - "smithy.api#pattern": "^See rules in parameter description$", "smithy.api#sensitive": {} } }, @@ -5319,6 +5675,16 @@ "smithy.api#documentation": "

Contains information about the reason that the finding was generated.

" } }, + "com.amazonaws.guardduty#ExpectedBucketOwner": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]+$" + } + }, "com.amazonaws.guardduty#FargateDetails": { "type": "structure", "members": { @@ -7189,11 +7555,82 @@ "com.amazonaws.guardduty#GetOrganizationStatisticsResponse": { "type": "structure", "members": { - "OrganizationDetails": { - "target": "com.amazonaws.guardduty#OrganizationDetails", + "OrganizationDetails": { + "target": "com.amazonaws.guardduty#OrganizationDetails", + "traits": { + "smithy.api#documentation": "

Information about the statistics report for your organization.

", + "smithy.api#jsonName": "organizationDetails" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetRemainingFreeTrialDays": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDaysRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDaysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides the number of days left for each data source used in the free trial\n period.

", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/freeTrial/daysRemaining", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetRemainingFreeTrialDaysRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty member account.

\n

To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#documentation": "

A list of account identifiers of the GuardDuty member account.

", + "smithy.api#jsonName": "accountIds" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetRemainingFreeTrialDaysResponse": { + "type": "structure", + "members": { + "Accounts": { + "target": "com.amazonaws.guardduty#AccountFreeTrialInfos", "traits": { - "smithy.api#documentation": "

Information about the statistics report for your organization.

", - "smithy.api#jsonName": "organizationDetails" + "smithy.api#documentation": "

The member accounts which were included in a request and were processed\n successfully.

", + "smithy.api#jsonName": "accounts" + } + }, + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#documentation": "

The member account that was included in a request but for which the request could not be\n processed.

", + "smithy.api#jsonName": "unprocessedAccounts" } } }, @@ -7201,13 +7638,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.guardduty#GetRemainingFreeTrialDays": { + "com.amazonaws.guardduty#GetThreatEntitySet": { "type": "operation", "input": { - "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDaysRequest" + "target": "com.amazonaws.guardduty#GetThreatEntitySetRequest" }, "output": { - "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDaysResponse" + "target": "com.amazonaws.guardduty#GetThreatEntitySetResponse" }, "errors": [ { @@ -7218,31 +7655,33 @@ } ], "traits": { - "smithy.api#documentation": "

Provides the number of days left for each data source used in the free trial\n period.

", + "smithy.api#documentation": "

Retrieves the threat entity set associated with the specified threatEntitySetId.

", "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/freeTrial/daysRemaining", + "method": "GET", + "uri": "/detector/{DetectorId}/threatentityset/{ThreatEntitySetId}", "code": 200 } } }, - "com.amazonaws.guardduty#GetRemainingFreeTrialDaysRequest": { + "com.amazonaws.guardduty#GetThreatEntitySetRequest": { "type": "structure", "members": { "DetectorId": { "target": "com.amazonaws.guardduty#DetectorId", "traits": { - "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty member account.

\n

To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.

", + "smithy.api#documentation": "

The unique ID of the detector associated with the threat entity set resource.

\n

To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.

", "smithy.api#httpLabel": {}, "smithy.api#jsonName": "detectorId", "smithy.api#required": {} } }, - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", + "ThreatEntitySetId": { + "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

A list of account identifiers of the GuardDuty member account.

", - "smithy.api#jsonName": "accountIds" + "smithy.api#documentation": "

The unique ID that helps GuardDuty identify the threat entity set.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "threatEntitySetId", + "smithy.api#required": {} } } }, @@ -7250,21 +7689,78 @@ "smithy.api#input": {} } }, - "com.amazonaws.guardduty#GetRemainingFreeTrialDaysResponse": { + "com.amazonaws.guardduty#GetThreatEntitySetResponse": { "type": "structure", "members": { - "Accounts": { - "target": "com.amazonaws.guardduty#AccountFreeTrialInfos", + "Name": { + "target": "com.amazonaws.guardduty#Name", "traits": { - "smithy.api#documentation": "

The member accounts which were included in a request and were processed\n successfully.

", - "smithy.api#jsonName": "accounts" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the threat entity set associated with the specified threatEntitySetId.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} } }, - "UnprocessedAccounts": { - "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "Format": { + "target": "com.amazonaws.guardduty#ThreatEntitySetFormat", "traits": { - "smithy.api#documentation": "

The member account that was included in a request but for which the request could not be\n processed.

", - "smithy.api#jsonName": "unprocessedAccounts" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The format of the file that contains the threat entity set.

", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The URI of the file that contains the threat entity set.

", + "smithy.api#jsonName": "location", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#ExpectedBucketOwner", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location\n parameter.

", + "smithy.api#jsonName": "expectedBucketOwner" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#ThreatEntitySetStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the associated threat entity set.

", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "

The tags associated with the threat entity set resource.

", + "smithy.api#jsonName": "tags" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the associated threat entity set was created.

", + "smithy.api#jsonName": "createdAt" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the associated threat entity set was updated.

", + "smithy.api#jsonName": "updatedAt" + } + }, + "ErrorDetails": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The error details when the status is shown as ERROR.

", + "smithy.api#jsonName": "errorDetails" } } }, @@ -7381,6 +7877,136 @@ "smithy.api#output": {} } }, + "com.amazonaws.guardduty#GetTrustedEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetTrustedEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetTrustedEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the trusted entity set associated with the specified trustedEntitySetId.

", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/trustedentityset/{TrustedEntitySetId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetTrustedEntitySetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the GuardDuty detector associated with this trusted entity set.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "TrustedEntitySetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The unique ID that helps GuardDuty identify the trusted entity set.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "trustedEntitySetId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetTrustedEntitySetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the threat entity set associated with the specified trustedEntitySetId.

", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.guardduty#TrustedEntitySetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The format of the file that contains the trusted entity set.

", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The URI of the file that contains the trusted entity set.

", + "smithy.api#jsonName": "location", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#ExpectedBucketOwner", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location\n parameter.

", + "smithy.api#jsonName": "expectedBucketOwner" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#TrustedEntitySetStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of the associated trusted entity set.

", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "

The tags associated with trusted entity set resource.

", + "smithy.api#jsonName": "tags" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the associated trusted entity set was created.

", + "smithy.api#jsonName": "createdAt" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the associated trusted entity set was updated.

", + "smithy.api#jsonName": "updatedAt" + } + }, + "ErrorDetails": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The error details when the status is shown as ERROR.

", + "smithy.api#jsonName": "errorDetails" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.guardduty#GetUsageStatistics": { "type": "operation", "input": { @@ -7594,9 +8220,15 @@ { "target": "com.amazonaws.guardduty#CreateSampleFindings" }, + { + "target": "com.amazonaws.guardduty#CreateThreatEntitySet" + }, { "target": "com.amazonaws.guardduty#CreateThreatIntelSet" }, + { + "target": "com.amazonaws.guardduty#CreateTrustedEntitySet" + }, { "target": "com.amazonaws.guardduty#DeclineInvitations" }, @@ -7621,9 +8253,15 @@ { "target": "com.amazonaws.guardduty#DeletePublishingDestination" }, + { + "target": "com.amazonaws.guardduty#DeleteThreatEntitySet" + }, { "target": "com.amazonaws.guardduty#DeleteThreatIntelSet" }, + { + "target": "com.amazonaws.guardduty#DeleteTrustedEntitySet" + }, { "target": "com.amazonaws.guardduty#DescribeMalwareScans" }, @@ -7693,9 +8331,15 @@ { "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDays" }, + { + "target": "com.amazonaws.guardduty#GetThreatEntitySet" + }, { "target": "com.amazonaws.guardduty#GetThreatIntelSet" }, + { + "target": "com.amazonaws.guardduty#GetTrustedEntitySet" + }, { "target": "com.amazonaws.guardduty#GetUsageStatistics" }, @@ -7735,9 +8379,15 @@ { "target": "com.amazonaws.guardduty#ListTagsForResource" }, + { + "target": "com.amazonaws.guardduty#ListThreatEntitySets" + }, { "target": "com.amazonaws.guardduty#ListThreatIntelSets" }, + { + "target": "com.amazonaws.guardduty#ListTrustedEntitySets" + }, { "target": "com.amazonaws.guardduty#StartMalwareScan" }, @@ -7783,8 +8433,14 @@ { "target": "com.amazonaws.guardduty#UpdatePublishingDestination" }, + { + "target": "com.amazonaws.guardduty#UpdateThreatEntitySet" + }, { "target": "com.amazonaws.guardduty#UpdateThreatIntelSet" + }, + { + "target": "com.amazonaws.guardduty#UpdateTrustedEntitySet" } ], "traits": { @@ -8649,17 +9305,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -8673,17 +9318,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -8698,38 +9332,16 @@ } }, { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://guardduty-fips.us-isob-east-1.sc2s.sgov.gov" + } }, "params": { "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -11068,6 +11680,94 @@ "smithy.api#output": {} } }, + "com.amazonaws.guardduty#ListThreatEntitySets": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListThreatEntitySetsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListThreatEntitySetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the threat entity sets associated with the specified GuardDuty detector ID. If you use this\n operation from a member account, the threat entity sets that are returned as a response, belong to the \n administrator account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/threatentityset", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ThreatEntitySetIds", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListThreatEntitySetsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the GuardDuty detector that is associated with this threat entity set.

\n

To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of \n items you want in the response. The default value is 50.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value \n of this parameter to null on your first call to the list action. For\n subsequent calls to the action, fill nextToken in the request \n with the value of NextToken from the previous response to continue listing data.

", + "smithy.api#httpQuery": "nextToken", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListThreatEntitySetsResponse": { + "type": "structure", + "members": { + "ThreatEntitySetIds": { + "target": "com.amazonaws.guardduty#ThreatEntitySetIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the threat entity set resources.

", + "smithy.api#jsonName": "threatEntitySetIds", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more items.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.guardduty#ListThreatIntelSets": { "type": "operation", "input": { @@ -11156,6 +11856,94 @@ "smithy.api#output": {} } }, + "com.amazonaws.guardduty#ListTrustedEntitySets": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListTrustedEntitySetsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListTrustedEntitySetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the trusted entity sets associated with the specified GuardDuty detector ID. If you use this\n operation from a member account, the trusted entity sets that are returned as a response, belong to the \n administrator account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/trustedentityset", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrustedEntitySetIds", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListTrustedEntitySetsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the GuardDuty detector that is associated with this threat entity set.

\n

To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "

You can use this parameter to indicate the maximum number of \n items you want in the response. The default value is 50.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

You can use this parameter when paginating results. Set the value \n of this parameter to null on your first call to the list action. For\n subsequent calls to the action, fill nextToken in the request \n with the value of NextToken from the previous response to continue listing data.

", + "smithy.api#httpQuery": "nextToken", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListTrustedEntitySetsResponse": { + "type": "structure", + "members": { + "TrustedEntitySetIds": { + "target": "com.amazonaws.guardduty#TrustedEntitySetIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the trusted entity set resources.

", + "smithy.api#jsonName": "trustedEntitySetIds", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more items.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.guardduty#LocalIpDetails": { "type": "structure", "members": { @@ -15860,7 +16648,119 @@ } }, "traits": { - "smithy.api#documentation": "

Contains details about identified threats organized by threat name.

" + "smithy.api#documentation": "

Contains details about identified threats organized by threat name.

" + } + }, + "com.amazonaws.guardduty#ThreatEntitySetFormat": { + "type": "enum", + "members": { + "TXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TXT" + } + }, + "STIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STIX" + } + }, + "OTX_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTX_CSV" + } + }, + "ALIEN_VAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALIEN_VAULT" + } + }, + "PROOF_POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROOF_POINT" + } + }, + "FIRE_EYE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIRE_EYE" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#ThreatEntitySetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#ThreatEntitySetStatus": { + "type": "enum", + "members": { + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DEACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "DELETE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_PENDING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } } }, "com.amazonaws.guardduty#ThreatIntelSetFormat": { @@ -16084,6 +16984,118 @@ "smithy.api#documentation": "

Represents the reason the scan was triggered.

" } }, + "com.amazonaws.guardduty#TrustedEntitySetFormat": { + "type": "enum", + "members": { + "TXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TXT" + } + }, + "STIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STIX" + } + }, + "OTX_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTX_CSV" + } + }, + "ALIEN_VAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALIEN_VAULT" + } + }, + "PROOF_POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROOF_POINT" + } + }, + "FIRE_EYE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIRE_EYE" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#TrustedEntitySetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#TrustedEntitySetStatus": { + "type": "enum", + "members": { + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DEACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "DELETE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_PENDING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, "com.amazonaws.guardduty#UnarchiveFindings": { "type": "operation", "input": { @@ -16990,6 +18002,92 @@ "smithy.api#documentation": "

Information about the protected S3 bucket resource.

" } }, + "com.amazonaws.guardduty#UpdateThreatEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateThreatEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateThreatEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the threat entity set associated with the specified threatEntitySetId.

", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/threatentityset/{ThreatEntitySetId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateThreatEntitySetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the GuardDuty detector associated with the threat entity set that you want to\n update.

\n

To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "ThreatEntitySetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The ID returned by GuardDuty after updating the threat entity set resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "threatEntitySetId", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#documentation": "

A user-friendly name to identify the trusted entity set.

\n

The name of your list can include \n lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).

", + "smithy.api#jsonName": "name" + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#documentation": "

The URI of the file that contains the trusted entity set.

", + "smithy.api#jsonName": "location" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#ExpectedBucketOwner", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location\n parameter.

", + "smithy.api#jsonName": "expectedBucketOwner" + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "

A boolean value that indicates whether GuardDuty is to start using this updated threat entity set. After you\n update an entity set, you will need to activate it again. It might take up to 15 minutes for the updated\n entity set to be effective.

", + "smithy.api#jsonName": "activate" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateThreatEntitySetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.guardduty#UpdateThreatIntelSet": { "type": "operation", "input": { @@ -17079,6 +18177,92 @@ "smithy.api#output": {} } }, + "com.amazonaws.guardduty#UpdateTrustedEntitySet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateTrustedEntitySetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateTrustedEntitySetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the trusted entity set associated with the specified trustedEntitySetId.

", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/trustedentityset/{TrustedEntitySetId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateTrustedEntitySetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the GuardDuty detector associated with the threat entity set that you want to\n update.

\n

To find the detectorId in the current Region, see the\nSettings page in the GuardDuty console, or run the ListDetectors API.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "TrustedEntitySetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The ID returned by GuardDuty after updating the trusted entity set resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "trustedEntitySetId", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#documentation": "

A user-friendly name to identify the trusted entity set.

\n

The name of your list can include \n lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).

", + "smithy.api#jsonName": "name" + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#documentation": "

The URI of the file that contains the trusted entity set.

", + "smithy.api#jsonName": "location" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.guardduty#ExpectedBucketOwner", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location\n parameter.

", + "smithy.api#jsonName": "expectedBucketOwner" + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "

A boolean value that indicates whether GuardDuty is to start using this updated trusted entity set. After you\n update an entity set, you will need to activate it again. It might take up to 15 minutes for the updated\n entity set to be effective.

", + "smithy.api#jsonName": "activate" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateTrustedEntitySetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.guardduty#UsageAccountResult": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/health.json b/codegen/sdk/aws-models/health.json index ef72c677214..33b9d9fa45b 100644 --- a/codegen/sdk/aws-models/health.json +++ b/codegen/sdk/aws-models/health.json @@ -673,17 +673,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -697,17 +686,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -721,17 +699,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -745,17 +712,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/healthlake.json b/codegen/sdk/aws-models/healthlake.json index dcb828d648b..bbeca7a7bf1 100644 --- a/codegen/sdk/aws-models/healthlake.json +++ b/codegen/sdk/aws-models/healthlake.json @@ -129,7 +129,7 @@ } }, "traits": { - "smithy.api#documentation": "

The data store is in a transition state and the user requested action can not be performed.

", + "smithy.api#documentation": "

The data store is in a transition state and the user requested action cannot be\n performed.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -157,7 +157,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a data store that can ingest and export FHIR formatted data.

" + "smithy.api#documentation": "

Create a FHIR-enabled data store.

" } }, "com.amazonaws.healthlake#CreateFHIRDatastoreRequest": { @@ -166,45 +166,45 @@ "DatastoreName": { "target": "com.amazonaws.healthlake#DatastoreName", "traits": { - "smithy.api#documentation": "

The user generated name for the data store.

" + "smithy.api#documentation": "

The data store name (user-generated).

" } }, "DatastoreTypeVersion": { "target": "com.amazonaws.healthlake#FHIRVersion", "traits": { - "smithy.api#documentation": "

The FHIR version of the data store. The only supported version is R4.

", + "smithy.api#documentation": "

The FHIR release version supported by the data store. Current support is for version\n R4.

", "smithy.api#required": {} } }, "SseConfiguration": { "target": "com.amazonaws.healthlake#SseConfiguration", "traits": { - "smithy.api#documentation": "

\n The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.\n

" + "smithy.api#documentation": "

The server-side encryption key configuration for a customer-provided encryption key\n specified for creating a data store.

" } }, "PreloadDataConfig": { "target": "com.amazonaws.healthlake#PreloadDataConfig", "traits": { - "smithy.api#documentation": "

Optional parameter to preload data upon creation of the data store. Currently, the only\n supported preloaded data is synthetic data generated from Synthea.

" + "smithy.api#documentation": "

An optional parameter to preload (import) open source Synthea FHIR data upon creation of\n the data store.

" } }, "ClientToken": { "target": "com.amazonaws.healthlake#ClientTokenString", "traits": { - "smithy.api#documentation": "

Optional user provided token used for ensuring idempotency.

", + "smithy.api#documentation": "

An optional user-provided token to ensure API idempotency.

", "smithy.api#idempotencyToken": {} } }, "Tags": { "target": "com.amazonaws.healthlake#TagList", "traits": { - "smithy.api#documentation": "

\n Resource tags that are applied to a data store when it is created.\n

" + "smithy.api#documentation": "

The resource tags applied to a data store when it is created.

" } }, "IdentityProviderConfiguration": { "target": "com.amazonaws.healthlake#IdentityProviderConfiguration", "traits": { - "smithy.api#documentation": "

The configuration of the identity provider that you want to use for your data store.

" + "smithy.api#documentation": "

The identity provider configuration to use for the data store.

" } } }, @@ -218,28 +218,28 @@ "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

The AWS-generated data store id. This id is in the output from the initial data store\n creation call.

", + "smithy.api#documentation": "

The data store identifier.

", "smithy.api#required": {} } }, "DatastoreArn": { "target": "com.amazonaws.healthlake#DatastoreArn", "traits": { - "smithy.api#documentation": "

The data store ARN is generated during the creation of the data store and can be found in\n the output from the initial data store creation call.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data store.

", "smithy.api#required": {} } }, "DatastoreStatus": { "target": "com.amazonaws.healthlake#DatastoreStatus", "traits": { - "smithy.api#documentation": "

The status of the FHIR data store.

", + "smithy.api#documentation": "

The data store status.

", "smithy.api#required": {} } }, "DatastoreEndpoint": { "target": "com.amazonaws.healthlake#BoundedLengthString", "traits": { - "smithy.api#documentation": "

The AWS endpoint for the created data store.

", + "smithy.api#documentation": "

The AWS endpoint created for the data store.

", "smithy.api#required": {} } } @@ -260,30 +260,30 @@ "DatastoreName": { "target": "com.amazonaws.healthlake#DatastoreName", "traits": { - "smithy.api#documentation": "

Allows the user to filter data store results by name.

" + "smithy.api#documentation": "

Filter data store results by name.

" } }, "DatastoreStatus": { "target": "com.amazonaws.healthlake#DatastoreStatus", "traits": { - "smithy.api#documentation": "

Allows the user to filter data store results by status.

" + "smithy.api#documentation": "

Filter data store results by status.

" } }, "CreatedBefore": { "target": "com.amazonaws.healthlake#Timestamp", "traits": { - "smithy.api#documentation": "

A filter that allows the user to set cutoff dates for records. All data stores created\n before the specified date will be included in the results.

" + "smithy.api#documentation": "

Filter to set cutoff dates for records. All data stores created before the specified\n date are included in the results.

" } }, "CreatedAfter": { "target": "com.amazonaws.healthlake#Timestamp", "traits": { - "smithy.api#documentation": "

A filter that allows the user to set cutoff dates for records. All data stores created\n after the specified date will be included in the results.

" + "smithy.api#documentation": "

Filter to set cutoff dates for records. All data stores created after the specified date\n are included in the results.

" } } }, "traits": { - "smithy.api#documentation": "

The filters applied to data store query.

" + "smithy.api#documentation": "

The filters applied to a data store query.

" } }, "com.amazonaws.healthlake#DatastoreId": { @@ -312,66 +312,66 @@ "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

The AWS-generated ID number for the data store.

", + "smithy.api#documentation": "

The data store identifier.

", "smithy.api#required": {} } }, "DatastoreArn": { "target": "com.amazonaws.healthlake#DatastoreArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name used in the creation of the data store.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) used in the creation of the data store.

", "smithy.api#required": {} } }, "DatastoreName": { "target": "com.amazonaws.healthlake#DatastoreName", "traits": { - "smithy.api#documentation": "

The user-generated name for the data store.

" + "smithy.api#documentation": "

The data store name.

" } }, "DatastoreStatus": { "target": "com.amazonaws.healthlake#DatastoreStatus", "traits": { - "smithy.api#documentation": "

The status of the data store.

", + "smithy.api#documentation": "

The data store status.

", "smithy.api#required": {} } }, "CreatedAt": { "target": "com.amazonaws.healthlake#Timestamp", "traits": { - "smithy.api#documentation": "

The time that a data store was created.

" + "smithy.api#documentation": "

The time the data store was created.

" } }, "DatastoreTypeVersion": { "target": "com.amazonaws.healthlake#FHIRVersion", "traits": { - "smithy.api#documentation": "

The FHIR version. Only R4 version data is supported.

", + "smithy.api#documentation": "

The FHIR release version supported by the data store. Current support is for version\n R4.

", "smithy.api#required": {} } }, "DatastoreEndpoint": { "target": "com.amazonaws.healthlake#String", "traits": { - "smithy.api#documentation": "

The AWS endpoint for the data store. Each data store will have it's own endpoint with data store ID in the endpoint URL.

", + "smithy.api#documentation": "

The AWS endpoint for the data store.

", "smithy.api#required": {} } }, "SseConfiguration": { "target": "com.amazonaws.healthlake#SseConfiguration", "traits": { - "smithy.api#documentation": "

\n The server-side encryption key configuration for a customer provided encryption key (CMK).\n

" + "smithy.api#documentation": "

The server-side encryption key configuration for a customer provided encryption\n key.

" } }, "PreloadDataConfig": { "target": "com.amazonaws.healthlake#PreloadDataConfig", "traits": { - "smithy.api#documentation": "

The preloaded data configuration for the data store. Only data preloaded from Synthea is supported.

" + "smithy.api#documentation": "

The preloaded Synthea data configuration for the data store.

" } }, "IdentityProviderConfiguration": { "target": "com.amazonaws.healthlake#IdentityProviderConfiguration", "traits": { - "smithy.api#documentation": "

The identity provider that you selected when you created the data store.

" + "smithy.api#documentation": "

The identity provider selected during data store creation.

" } }, "ErrorCause": { @@ -382,7 +382,7 @@ } }, "traits": { - "smithy.api#documentation": "

Displays the properties of the data store, including the ID, ARN, name, and the status of the data store.

" + "smithy.api#documentation": "

The data store properties.

" } }, "com.amazonaws.healthlake#DatastorePropertiesList": { @@ -455,7 +455,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a data store.

" + "smithy.api#documentation": "

Delete a FHIR-enabled data store.

" } }, "com.amazonaws.healthlake#DeleteFHIRDatastoreRequest": { @@ -464,7 +464,7 @@ "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

The AWS-generated ID for the data store to be deleted.

", + "smithy.api#documentation": "

The AWS-generated identifier for the data store to be deleted.

", "smithy.api#required": {} } } @@ -479,28 +479,28 @@ "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

The AWS-generated ID for the data store to be deleted.

", + "smithy.api#documentation": "

The AWS-generated ID for the deleted data store.

", "smithy.api#required": {} } }, "DatastoreArn": { "target": "com.amazonaws.healthlake#DatastoreArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives AWS HealthLake access permission.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake.

", "smithy.api#required": {} } }, "DatastoreStatus": { "target": "com.amazonaws.healthlake#DatastoreStatus", "traits": { - "smithy.api#documentation": "

The status of the data store that the user has requested to be deleted.\n

", + "smithy.api#documentation": "

The data store status.

", "smithy.api#required": {} } }, "DatastoreEndpoint": { "target": "com.amazonaws.healthlake#BoundedLengthString", "traits": { - "smithy.api#documentation": "

The AWS endpoint for the data store the user has requested to be deleted.

", + "smithy.api#documentation": "

The AWS endpoint of the data store to be deleted.

", "smithy.api#required": {} } } @@ -532,7 +532,59 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the properties associated with the FHIR data store, including the data store ID,\n data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.

" + "smithy.api#documentation": "

Get properties for a FHIR-enabled data store.

", + "smithy.waiters#waitable": { + "FHIRDatastoreActive": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "DatastoreProperties.DatastoreStatus", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DatastoreProperties.DatastoreStatus", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DatastoreProperties.DatastoreStatus", + "expected": "DELETED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 60 + }, + "FHIRDatastoreDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "DatastoreProperties.DatastoreStatus", + "expected": "DELETED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 120 + } + } } }, "com.amazonaws.healthlake#DescribeFHIRDatastoreRequest": { @@ -541,7 +593,7 @@ "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

The AWS-generated data store ID.

", + "smithy.api#documentation": "

The data store identifier.

", "smithy.api#required": {} } } @@ -556,7 +608,7 @@ "DatastoreProperties": { "target": "com.amazonaws.healthlake#DatastoreProperties", "traits": { - "smithy.api#documentation": "

All properties associated with a data store, including the data store ID, data store ARN,\n data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.

", + "smithy.api#documentation": "

The data store properties.

", "smithy.api#required": {} } } @@ -588,7 +640,64 @@ } ], "traits": { - "smithy.api#documentation": "

Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

" + "smithy.api#documentation": "

Get FHIR export job properties.

", + "smithy.waiters#waitable": { + "FHIRExportJobCompleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ExportJobProperties.JobStatus", + "expected": "COMPLETED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "ExportJobProperties.JobStatus", + "expected": "COMPLETED_WITH_ERRORS", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ExportJobProperties.JobStatus", + "expected": "CANCEL_COMPLETED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ExportJobProperties.JobStatus", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ExportJobProperties.JobStatus", + "expected": "CANCEL_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 120 + } + } } }, "com.amazonaws.healthlake#DescribeFHIRExportJobRequest": { @@ -597,14 +706,14 @@ "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

The AWS generated ID for the data store from which files are being exported from for an export job.

", + "smithy.api#documentation": "

The data store identifier from which FHIR data is being exported from.

", "smithy.api#required": {} } }, "JobId": { "target": "com.amazonaws.healthlake#JobId", "traits": { - "smithy.api#documentation": "

The AWS generated ID for an export job.

", + "smithy.api#documentation": "

The export job identifier.

", "smithy.api#required": {} } } @@ -619,7 +728,7 @@ "ExportJobProperties": { "target": "com.amazonaws.healthlake#ExportJobProperties", "traits": { - "smithy.api#documentation": "

Displays the properties of the export job, including the ID, Arn, Name, and the status of the job.

", + "smithy.api#documentation": "

The export job properties.

", "smithy.api#required": {} } } @@ -651,7 +760,44 @@ } ], "traits": { - "smithy.api#documentation": "

Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.

" + "smithy.api#documentation": "

Get the import job properties to learn more about the job or job progress.

", + "smithy.waiters#waitable": { + "FHIRImportJobCompleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ImportJobProperties.JobStatus", + "expected": "COMPLETED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "ImportJobProperties.JobStatus", + "expected": "COMPLETED_WITH_ERRORS", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImportJobProperties.JobStatus", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 120 + } + } } }, "com.amazonaws.healthlake#DescribeFHIRImportJobRequest": { @@ -660,14 +806,14 @@ "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

The AWS-generated ID of the data store.

", + "smithy.api#documentation": "

The data store identifier.

", "smithy.api#required": {} } }, "JobId": { "target": "com.amazonaws.healthlake#JobId", "traits": { - "smithy.api#documentation": "

The AWS-generated job ID.

", + "smithy.api#documentation": "

The import job identifier.

", "smithy.api#required": {} } } @@ -682,7 +828,7 @@ "ImportJobProperties": { "target": "com.amazonaws.healthlake#ImportJobProperties", "traits": { - "smithy.api#documentation": "

The properties of the Import job request, including the ID, ARN, name, status of the job, and the progress report of the job.

", + "smithy.api#documentation": "

The import job properties.

", "smithy.api#required": {} } } @@ -724,18 +870,18 @@ "ErrorMessage": { "target": "com.amazonaws.healthlake#ErrorMessage", "traits": { - "smithy.api#documentation": "

The text of the error message.

" + "smithy.api#documentation": "

The error message text for ErrorCause.

" } }, "ErrorCategory": { "target": "com.amazonaws.healthlake#ErrorCategory", "traits": { - "smithy.api#documentation": "

The error category of the create/delete data store operation. Possible statuses are RETRYABLE_ERROR or NON_RETRYABLE_ERROR.

" + "smithy.api#documentation": "

The error category for ErrorCause.

" } } }, "traits": { - "smithy.api#documentation": "

The error info of the create/delete data store operation.

" + "smithy.api#documentation": "

The error information for CreateFHIRDatastore and\n DeleteFHIRDatastore actions.

" } }, "com.amazonaws.healthlake#ErrorMessage": { @@ -753,65 +899,65 @@ "JobId": { "target": "com.amazonaws.healthlake#JobId", "traits": { - "smithy.api#documentation": "

The AWS generated ID for an export job.

", + "smithy.api#documentation": "

The export job identifier.

", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.healthlake#JobName", "traits": { - "smithy.api#documentation": "

The user generated name for an export job.

" + "smithy.api#documentation": "

The export job name.

" } }, "JobStatus": { "target": "com.amazonaws.healthlake#JobStatus", "traits": { - "smithy.api#documentation": "

The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.

", + "smithy.api#documentation": "

The export job status.

", "smithy.api#required": {} } }, "SubmitTime": { "target": "com.amazonaws.healthlake#Timestamp", "traits": { - "smithy.api#documentation": "

The time an export job was initiated.

", + "smithy.api#documentation": "

The time the export job was initiated.

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.healthlake#Timestamp", "traits": { - "smithy.api#documentation": "

The time an export job completed.

" + "smithy.api#documentation": "

The time the export job completed.

" } }, "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

The AWS generated ID for the data store from which files are being exported for an export job.

", + "smithy.api#documentation": "

The data store identifier from which files are being exported.

", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.healthlake#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The output data configuration that was supplied when the export job was created.

", + "smithy.api#documentation": "

The output data configuration supplied when the export job was created.

", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.healthlake#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name used during the initiation of the job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) used during the initiation of the export job.

" } }, "Message": { "target": "com.amazonaws.healthlake#Message", "traits": { - "smithy.api#documentation": "

An explanation of any errors that may have occurred during the export job.

" + "smithy.api#documentation": "

An explanation of any errors that might have occurred during the export job.

" } } }, "traits": { - "smithy.api#documentation": "

The properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

" + "smithy.api#documentation": "

The properties of a FHIR export job.

" } }, "com.amazonaws.healthlake#ExportJobPropertiesList": { @@ -893,7 +1039,7 @@ "name": "healthlake" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "

AWS HealthLake is a HIPAA eligibile service that allows customers to store,\n transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.

", + "smithy.api#documentation": "

This is the AWS HealthLake API Reference. For an introduction to\n the service, see What is AWS HealthLake? in the AWS HealthLake Developer\n Guide.

", "smithy.api#title": "Amazon HealthLake", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1393,17 +1539,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1417,17 +1552,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1441,17 +1565,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1465,17 +1578,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1567,7 +1669,7 @@ "AuthorizationStrategy": { "target": "com.amazonaws.healthlake#AuthorizationStrategy", "traits": { - "smithy.api#documentation": "

The authorization strategy that you selected when you created the data store.

", + "smithy.api#documentation": "

The authorization strategy selected when the HealthLake data store is created.

\n \n

HealthLake provides support for both SMART on FHIR V1 and V2 as described below.

\n
    \n
  • \n

    \n SMART_ON_FHIR_V1 – Support for only SMART on FHIR V1, which\n includes read (read/search) and write\n (create/update/delete) permissions.

    \n
  • \n
  • \n

    \n SMART_ON_FHIR – Support for both SMART on FHIR V1 and V2,\n which includes create, read, update,\n delete, and search permissions.

    \n
  • \n
  • \n

    \n AWS_AUTH – The default HealthLake authorization\n strategy; not affiliated with SMART on FHIR.

    \n
  • \n
\n
", "smithy.api#required": {} } }, @@ -1575,24 +1677,24 @@ "target": "com.amazonaws.healthlake#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If you enabled fine-grained authorization when you created the data store.

" + "smithy.api#documentation": "

The parameter to enable SMART on FHIR fine-grained authorization for the data\n store.

" } }, "Metadata": { "target": "com.amazonaws.healthlake#ConfigurationMetadata", "traits": { - "smithy.api#documentation": "

The JSON metadata elements that you want to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART's App Launch specification.

\n

\n authorization_endpoint: The URL to the OAuth2 authorization endpoint.

\n

\n grant_types_supported: An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code and client_credentials.

\n

\n token_endpoint: The URL to the OAuth2 token endpoint.

\n

\n capabilities: An array of strings of the SMART capabilities that the authorization server supports.

\n

\n code_challenge_methods_supported: An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.

" + "smithy.api#documentation": "

The JSON metadata elements to use in your identity provider configuration. Required\n elements are listed based on the launch specification of the SMART application. For more\n information on all possible elements, see Metadata in SMART's App Launch specification.

\n

\n authorization_endpoint: The URL to the OAuth2 authorization\n endpoint.

\n

\n grant_types_supported: An array of grant types that are supported at the\n token endpoint. You must provide at least one grant type option. Valid options are\n authorization_code and client_credentials.

\n

\n token_endpoint: The URL to the OAuth2 token endpoint.

\n

\n capabilities: An array of strings of the SMART capabilities that the\n authorization server supports.

\n

\n code_challenge_methods_supported: An array of strings of supported PKCE\n code challenge methods. You must include the S256 method in the array of PKCE\n code challenge methods.

" } }, "IdpLambdaArn": { "target": "com.amazonaws.healthlake#LambdaArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the\n authorization server.

" } } }, "traits": { - "smithy.api#documentation": "

The identity provider configuration that you gave when the data store was created.

" + "smithy.api#documentation": "

The identity provider configuration selected when the data store was created.

" } }, "com.amazonaws.healthlake#ImportJobProperties": { @@ -1601,47 +1703,47 @@ "JobId": { "target": "com.amazonaws.healthlake#JobId", "traits": { - "smithy.api#documentation": "

The AWS-generated id number for the Import job.

", + "smithy.api#documentation": "

The import job identifier.

", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.healthlake#JobName", "traits": { - "smithy.api#documentation": "

The user-generated name for an Import job.

" + "smithy.api#documentation": "

The import job name.

" } }, "JobStatus": { "target": "com.amazonaws.healthlake#JobStatus", "traits": { - "smithy.api#documentation": "

The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED.

", + "smithy.api#documentation": "

The import job status.

", "smithy.api#required": {} } }, "SubmitTime": { "target": "com.amazonaws.healthlake#Timestamp", "traits": { - "smithy.api#documentation": "

The time that the Import job was submitted for processing.

", + "smithy.api#documentation": "

The time the import job was submitted for processing.

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.healthlake#Timestamp", "traits": { - "smithy.api#documentation": "

The time that the Import job was completed.

" + "smithy.api#documentation": "

The time the import job was completed.

" } }, "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

The datastore id used when the Import job was created.

", + "smithy.api#documentation": "

The data store identifier.

", "smithy.api#required": {} } }, "InputDataConfig": { "target": "com.amazonaws.healthlake#InputDataConfig", "traits": { - "smithy.api#documentation": "

The input data configuration that was supplied when the Import job was created.

", + "smithy.api#documentation": "

The input data configuration supplied when the import job was created.

", "smithy.api#required": {} } }, @@ -1651,24 +1753,30 @@ "JobProgressReport": { "target": "com.amazonaws.healthlake#JobProgressReport", "traits": { - "smithy.api#documentation": "

Displays the progress of the import job, including total resources scanned, total resources ingested, and total size of data ingested.

" + "smithy.api#documentation": "

Displays the progress of the import job, including total resources scanned, total\n resources imported, and total size of data imported.

" } }, "DataAccessRoleArn": { "target": "com.amazonaws.healthlake#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives AWS HealthLake access to your input data.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that grants AWS HealthLake access to the input data.

" } }, "Message": { "target": "com.amazonaws.healthlake#Message", "traits": { - "smithy.api#documentation": "

An explanation of any errors that may have occurred during the FHIR import job.

" + "smithy.api#documentation": "

An explanation of any errors that might have occurred during the FHIR import job.

" + } + }, + "ValidationLevel": { + "target": "com.amazonaws.healthlake#ValidationLevel", + "traits": { + "smithy.api#documentation": "

The validation level of the import job.

" } } }, "traits": { - "smithy.api#documentation": "

Displays the properties of the import job, including the ID, Arn, Name, the status of the job, and the progress report of the job.

" + "smithy.api#documentation": "

The import job properties.

" } }, "com.amazonaws.healthlake#ImportJobPropertiesList": { @@ -1683,12 +1791,12 @@ "S3Uri": { "target": "com.amazonaws.healthlake#S3Uri", "traits": { - "smithy.api#documentation": "

The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.

" + "smithy.api#documentation": "

The S3Uri is the user-specified S3 location of the FHIR data to be\n imported into AWS HealthLake.

" } } }, "traits": { - "smithy.api#documentation": "

The input properties for an import job.

" + "smithy.api#documentation": "

The import job input properties.

" } }, "com.amazonaws.healthlake#InternalServerException": { @@ -1699,7 +1807,7 @@ } }, "traits": { - "smithy.api#documentation": "

Unknown error occurs in the service.

", + "smithy.api#documentation": "

An unknown internal error occurred in the service.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1730,31 +1838,31 @@ "TotalNumberOfScannedFiles": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { - "smithy.api#documentation": "

The number of files scanned from input S3 bucket.

" + "smithy.api#documentation": "

The number of files scanned from the S3 input bucket.

" } }, "TotalSizeOfScannedFilesInMB": { "target": "com.amazonaws.healthlake#GenericDouble", "traits": { - "smithy.api#documentation": "

The size (in MB) of the files scanned from the input S3 bucket.

" + "smithy.api#documentation": "

The size (in MB) of files scanned from the S3 input bucket.

" } }, "TotalNumberOfImportedFiles": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { - "smithy.api#documentation": "

The number of files imported so far.

" + "smithy.api#documentation": "

The number of files imported.

" } }, "TotalNumberOfResourcesScanned": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { - "smithy.api#documentation": "

The number of resources scanned from the input S3 bucket.

" + "smithy.api#documentation": "

The number of resources scanned from the S3 input bucket.

" } }, "TotalNumberOfResourcesImported": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { - "smithy.api#documentation": "

The number of resources imported so far.

" + "smithy.api#documentation": "

The number of resources imported.

" } }, "TotalNumberOfResourcesWithCustomerError": { @@ -1766,18 +1874,18 @@ "TotalNumberOfFilesReadWithCustomerError": { "target": "com.amazonaws.healthlake#GenericLong", "traits": { - "smithy.api#documentation": "

The number of files that failed to be read from the input S3 bucket due to customer error.

" + "smithy.api#documentation": "

The number of files that failed to be read from the S3 input bucket due to customer\n error.

" } }, "Throughput": { "target": "com.amazonaws.healthlake#GenericDouble", "traits": { - "smithy.api#documentation": "

The throughput (in MB/sec) of the import job.

" + "smithy.api#documentation": "

The transaction rate the import job is processed at.

" } } }, "traits": { - "smithy.api#documentation": "

The progress report of an import job.

" + "smithy.api#documentation": "

The progress report for the import job.

" } }, "com.amazonaws.healthlake#JobStatus": { @@ -1851,19 +1959,19 @@ "CmkType": { "target": "com.amazonaws.healthlake#CmkType", "traits": { - "smithy.api#documentation": "

\n The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.\n

", + "smithy.api#documentation": "

The type of customer-managed-key (CMK) used for encryption.

", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.healthlake#EncryptionKeyID", "traits": { - "smithy.api#documentation": "

\n The KMS encryption key id/alias used to encrypt the data store contents at rest.\n

" + "smithy.api#documentation": "

The Key Management Service (KMS) encryption key id/alias used to encrypt the data store contents at\n rest.

" } } }, "traits": { - "smithy.api#documentation": "

\n The customer-managed-key(CMK) used when creating a data store. If a customer owned key is not specified, an AWS owned key will be used for encryption.\n

" + "smithy.api#documentation": "

The customer-managed-key (CMK) used when creating a data store. If a customer-owned key\n is not specified, an AWS-owned key is used for encryption.

" } }, "com.amazonaws.healthlake#LambdaArn": { @@ -1896,7 +2004,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all FHIR data stores that are in the user’s account, regardless of data store status.

", + "smithy.api#documentation": "

List all FHIR-enabled data stores in a user’s account, regardless of data store\n status.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1910,19 +2018,19 @@ "Filter": { "target": "com.amazonaws.healthlake#DatastoreFilter", "traits": { - "smithy.api#documentation": "

Lists all filters associated with a FHIR data store request.

" + "smithy.api#documentation": "

List all filters associated with a FHIR data store request.

" } }, "NextToken": { "target": "com.amazonaws.healthlake#NextToken", "traits": { - "smithy.api#documentation": "

Fetches the next page of data stores when results are paginated.

" + "smithy.api#documentation": "

The token used to retrieve the next page of data stores when results are\n paginated.

" } }, "MaxResults": { "target": "com.amazonaws.healthlake#MaxResultsInteger", "traits": { - "smithy.api#documentation": "

The maximum number of data stores returned in a single page of a ListFHIRDatastoresRequest call.

" + "smithy.api#documentation": "

The maximum number of data stores returned on a page.

" } } }, @@ -1936,14 +2044,14 @@ "DatastorePropertiesList": { "target": "com.amazonaws.healthlake#DatastorePropertiesList", "traits": { - "smithy.api#documentation": "

All properties associated with the listed data stores.

", + "smithy.api#documentation": "

The properties associated with all listed data stores.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.healthlake#NextToken", "traits": { - "smithy.api#documentation": "

Pagination token that can be used to retrieve the next page of results.

" + "smithy.api#documentation": "

The pagination token used to retrieve the next page of results.

" } } }, @@ -1977,7 +2085,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Lists all FHIR export jobs associated with an account and their statuses.\n

", + "smithy.api#documentation": "

Lists all FHIR export jobs associated with an account and their statuses.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1991,44 +2099,44 @@ "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

\n This parameter limits the response to the export job with the specified data store ID.\n

", + "smithy.api#documentation": "

Limits the response to the export job with the specified data store ID.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.healthlake#NextToken", "traits": { - "smithy.api#documentation": "

\n A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query. \n

" + "smithy.api#documentation": "

A pagination token used to identify the next page of results to return.

" } }, "MaxResults": { "target": "com.amazonaws.healthlake#MaxResultsInteger", "traits": { - "smithy.api#documentation": "

\n This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user. \n

" + "smithy.api#documentation": "

Limits the number of results returned for a ListFHIRExportJobs to a maximum quantity\n specified by the user.

" } }, "JobName": { "target": "com.amazonaws.healthlake#JobName", "traits": { - "smithy.api#documentation": "

\n This parameter limits the response to the export job with the specified job name.\n

" + "smithy.api#documentation": "

Limits the response to the export job with the specified job name.

" } }, "JobStatus": { "target": "com.amazonaws.healthlake#JobStatus", "traits": { - "smithy.api#documentation": "

\n This parameter limits the response to the export jobs with the specified job status. \n

" + "smithy.api#documentation": "

Limits the response to export jobs with the specified job status.

" } }, "SubmittedBefore": { "target": "com.amazonaws.healthlake#Timestamp", "traits": { - "smithy.api#documentation": "

\n This parameter limits the response to FHIR export jobs submitted before a user specified date. \n

" + "smithy.api#documentation": "

Limits the response to FHIR export jobs submitted before a user- specified date.

" } }, "SubmittedAfter": { "target": "com.amazonaws.healthlake#Timestamp", "traits": { - "smithy.api#documentation": "

\n This parameter limits the response to FHIR export jobs submitted after a user specified date. \n

" + "smithy.api#documentation": "

Limits the response to FHIR export jobs submitted after a user-specified date.

" } } }, @@ -2042,14 +2150,14 @@ "ExportJobPropertiesList": { "target": "com.amazonaws.healthlake#ExportJobPropertiesList", "traits": { - "smithy.api#documentation": "

\n The properties of listed FHIR export jobs, including the ID, ARN, name, and the status of the job.\n

", + "smithy.api#documentation": "

The properties of listed FHIR export jobs.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.healthlake#NextToken", "traits": { - "smithy.api#documentation": "

\n A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.\n

" + "smithy.api#documentation": "

The pagination token used to identify the next page of results to return.

" } } }, @@ -2083,7 +2191,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Lists all FHIR import jobs associated with an account and their statuses.\n

", + "smithy.api#documentation": "

List all FHIR import jobs associated with an account and their statuses.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2097,44 +2205,44 @@ "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

\n This parameter limits the response to the import job with the specified data store ID.\n

", + "smithy.api#documentation": "

Limits the response to the import job with the specified data store ID.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.healthlake#NextToken", "traits": { - "smithy.api#documentation": "

\n A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.\n

" + "smithy.api#documentation": "

The pagination token used to identify the next page of results to return.

" } }, "MaxResults": { "target": "com.amazonaws.healthlake#MaxResultsInteger", "traits": { - "smithy.api#documentation": "

\n This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user.\n

" + "smithy.api#documentation": "

Limits the number of results returned for ListFHIRImportJobs to a maximum\n quantity specified by the user.

" } }, "JobName": { "target": "com.amazonaws.healthlake#JobName", "traits": { - "smithy.api#documentation": "

\n This parameter limits the response to the import job with the specified job name.\n

" + "smithy.api#documentation": "

Limits the response to the import job with the specified job name.

" } }, "JobStatus": { "target": "com.amazonaws.healthlake#JobStatus", "traits": { - "smithy.api#documentation": "

\n This parameter limits the response to the import job with the specified job status.\n

" + "smithy.api#documentation": "

Limits the response to the import job with the specified job status.

" } }, "SubmittedBefore": { "target": "com.amazonaws.healthlake#Timestamp", "traits": { - "smithy.api#documentation": "

\n This parameter limits the response to FHIR import jobs submitted before a user specified date.\n

" + "smithy.api#documentation": "

Limits the response to FHIR import jobs submitted before a user- specified date.

" } }, "SubmittedAfter": { "target": "com.amazonaws.healthlake#Timestamp", "traits": { - "smithy.api#documentation": "

\n This parameter limits the response to FHIR import jobs submitted after a user specified date.\n

" + "smithy.api#documentation": "

Limits the response to FHIR import jobs submitted after a user-specified date.

" } } }, @@ -2148,14 +2256,14 @@ "ImportJobPropertiesList": { "target": "com.amazonaws.healthlake#ImportJobPropertiesList", "traits": { - "smithy.api#documentation": "

\n The properties of a listed FHIR import jobs, including the ID, ARN, name, the status of the job, and the progress report of the job.\n

", + "smithy.api#documentation": "

The properties for listed import jobs.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.healthlake#NextToken", "traits": { - "smithy.api#documentation": "

\n A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.\n

" + "smithy.api#documentation": "

The pagination token used to identify the next page of results to return.

" } } }, @@ -2180,7 +2288,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Returns a list of all existing tags associated with a data store.\n

" + "smithy.api#documentation": "

Returns a list of all existing tags associated with a data store.

" } }, "com.amazonaws.healthlake#ListTagsForResourceRequest": { @@ -2189,7 +2297,7 @@ "ResourceARN": { "target": "com.amazonaws.healthlake#AmazonResourceName", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name(ARN) of the data store for which tags are being added.\n

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data store to which tags are being added.

", "smithy.api#required": {} } } @@ -2204,7 +2312,7 @@ "Tags": { "target": "com.amazonaws.healthlake#TagList", "traits": { - "smithy.api#documentation": "

\n Returns a list of tags associated with a data store.\n

" + "smithy.api#documentation": "

Returns a list of tags associated with a data store.

" } } }, @@ -2247,12 +2355,12 @@ "S3Configuration": { "target": "com.amazonaws.healthlake#S3Configuration", "traits": { - "smithy.api#documentation": "

\n The output data configuration that was supplied when the export job was created.\n

" + "smithy.api#documentation": "

The output data configuration supplied when the export job was created.

" } } }, "traits": { - "smithy.api#documentation": "

The output data configuration that was supplied when the export job was created.

" + "smithy.api#documentation": "

The output data configuration supplied when the export job was created.

" } }, "com.amazonaws.healthlake#PreloadDataConfig": { @@ -2267,7 +2375,7 @@ } }, "traits": { - "smithy.api#documentation": "

The input properties for the preloaded data store. Only data preloaded from Synthea is supported.

" + "smithy.api#documentation": "

The input properties for the preloaded (Synthea) data store.

" } }, "com.amazonaws.healthlake#PreloadDataType": { @@ -2289,7 +2397,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested data store was not found.

", + "smithy.api#documentation": "

The requested data store was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -2300,20 +2408,20 @@ "S3Uri": { "target": "com.amazonaws.healthlake#S3Uri", "traits": { - "smithy.api#documentation": "

\n The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.\n

", + "smithy.api#documentation": "

The S3Uri is the user-specified S3 location of the FHIR data to be\n imported into AWS HealthLake.

", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.healthlake#EncryptionKeyID", "traits": { - "smithy.api#documentation": "

\n The KMS key ID used to access the S3 bucket.\n

", + "smithy.api#documentation": "

The Key Management Service (KMS) key ID used to access the S3 bucket.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n The configuration of the S3 bucket for either an import or export job. This includes assigning permissions for access.\n

" + "smithy.api#documentation": "

The configuration of the S3 bucket for either an import or export job. This includes\n assigning access permissions.

" } }, "com.amazonaws.healthlake#S3Uri": { @@ -2332,13 +2440,13 @@ "KmsEncryptionConfig": { "target": "com.amazonaws.healthlake#KmsEncryptionConfig", "traits": { - "smithy.api#documentation": "

\n The KMS encryption configuration used to provide details for data encryption.\n

", + "smithy.api#documentation": "

The Key Management Service (KMS) encryption configuration used to provide details for data\n encryption.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n The server-side encryption key configuration for a customer provided encryption key.\n

" + "smithy.api#documentation": "

The server-side encryption key configuration for a customer-provided encryption\n key.

" } }, "com.amazonaws.healthlake#StartFHIRExportJob": { @@ -2367,7 +2475,7 @@ } ], "traits": { - "smithy.api#documentation": "

Begins a FHIR export job.

" + "smithy.api#documentation": "

Start a FHIR export job.

" } }, "com.amazonaws.healthlake#StartFHIRExportJobRequest": { @@ -2376,34 +2484,34 @@ "JobName": { "target": "com.amazonaws.healthlake#JobName", "traits": { - "smithy.api#documentation": "

The user generated name for an export job.

" + "smithy.api#documentation": "

The export job name.

" } }, "OutputDataConfig": { "target": "com.amazonaws.healthlake#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The output data configuration that was supplied when the export job was created.

", + "smithy.api#documentation": "

The output data configuration supplied when the export job was started.

", "smithy.api#required": {} } }, "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

The AWS generated ID for the data store from which files are being exported for an export job.

", + "smithy.api#documentation": "

The data store identifier from which files are being exported.

", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.healthlake#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name used during the initiation of the job.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) used during initiation of the export job.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.healthlake#ClientTokenString", "traits": { - "smithy.api#documentation": "

An optional user provided token used for ensuring idempotency.

", + "smithy.api#documentation": "

An optional user provided token used for ensuring API idempotency.

", "smithy.api#idempotencyToken": {} } } @@ -2418,21 +2526,21 @@ "JobId": { "target": "com.amazonaws.healthlake#JobId", "traits": { - "smithy.api#documentation": "

The AWS generated ID for an export job.

", + "smithy.api#documentation": "

The export job identifier.

", "smithy.api#required": {} } }, "JobStatus": { "target": "com.amazonaws.healthlake#JobStatus", "traits": { - "smithy.api#documentation": "

The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.

", + "smithy.api#documentation": "

The export job status.

", "smithy.api#required": {} } }, "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

The AWS generated ID for the data store from which files are being exported for an export job.

" + "smithy.api#documentation": "

The data store identifier from which files are being exported.

" } } }, @@ -2466,7 +2574,7 @@ } ], "traits": { - "smithy.api#documentation": "

Begins a FHIR Import job.

" + "smithy.api#documentation": "

Start importing bulk FHIR data into an ACTIVE data store. The import job imports FHIR\n data found in the InputDataConfig object and stores processing results in the\n JobOutputDataConfig object.

" } }, "com.amazonaws.healthlake#StartFHIRImportJobRequest": { @@ -2475,13 +2583,13 @@ "JobName": { "target": "com.amazonaws.healthlake#JobName", "traits": { - "smithy.api#documentation": "

The name of the FHIR Import job in the StartFHIRImport job request.

" + "smithy.api#documentation": "

The import job name.

" } }, "InputDataConfig": { "target": "com.amazonaws.healthlake#InputDataConfig", "traits": { - "smithy.api#documentation": "

The input properties of the FHIR Import job in the StartFHIRImport job request.

", + "smithy.api#documentation": "

The input properties for the import job request.

", "smithy.api#required": {} } }, @@ -2494,23 +2602,29 @@ "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

The AWS-generated data store ID.

", + "smithy.api#documentation": "

The data store identifier.

", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.healthlake#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives AWS HealthLake access permission.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.healthlake#ClientTokenString", "traits": { - "smithy.api#documentation": "

Optional user provided token used for ensuring idempotency.

", + "smithy.api#documentation": "

The optional user-provided token used for ensuring API idempotency.

", "smithy.api#idempotencyToken": {} } + }, + "ValidationLevel": { + "target": "com.amazonaws.healthlake#ValidationLevel", + "traits": { + "smithy.api#documentation": "

The validation level of the import job.

" + } } }, "traits": { @@ -2523,21 +2637,21 @@ "JobId": { "target": "com.amazonaws.healthlake#JobId", "traits": { - "smithy.api#documentation": "

The AWS-generated job ID.

", + "smithy.api#documentation": "

The import job identifier.

", "smithy.api#required": {} } }, "JobStatus": { "target": "com.amazonaws.healthlake#JobStatus", "traits": { - "smithy.api#documentation": "

The status of an import job.

", + "smithy.api#documentation": "

The import job status.

", "smithy.api#required": {} } }, "DatastoreId": { "target": "com.amazonaws.healthlake#DatastoreId", "traits": { - "smithy.api#documentation": "

The AWS-generated data store ID.

" + "smithy.api#documentation": "

The data store identifier.

" } } }, @@ -2561,20 +2675,20 @@ "Key": { "target": "com.amazonaws.healthlake#TagKey", "traits": { - "smithy.api#documentation": "

\n The key portion of a tag. Tag keys are case sensitive.\n

", + "smithy.api#documentation": "

The key portion of a tag. Tag keys are case sensitive.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.healthlake#TagValue", "traits": { - "smithy.api#documentation": "

\n The value portion of a tag. Tag values are case sensitive.\n

", + "smithy.api#documentation": "

The value portion of a tag. Tag values are case-sensitive.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n A tag is a label consisting of a user-defined key and value. The form for tags is {\"Key\", \"Value\"}\n

" + "smithy.api#documentation": "

A label consisting of a user-defined key and value. The form for tags is {\"Key\",\n \"Value\"}

" } }, "com.amazonaws.healthlake#TagKey": { @@ -2628,7 +2742,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Adds a user specified key and value tag to a data store.\n

" + "smithy.api#documentation": "

Add a user-specifed key and value tag to a data store.

" } }, "com.amazonaws.healthlake#TagResourceRequest": { @@ -2637,14 +2751,14 @@ "ResourceARN": { "target": "com.amazonaws.healthlake#AmazonResourceName", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name(ARN)that gives AWS HealthLake access to the data store which tags are being added to.\n

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that grants access to the data store tags are being added to.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.healthlake#TagList", "traits": { - "smithy.api#documentation": "

\n The user specified key and value pair tags being added to a data store.\n

", + "smithy.api#documentation": "

The user-specified key and value pair tags being added to a data store.

", "smithy.api#required": {} } } @@ -2703,7 +2817,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Removes tags from a data store.\n

" + "smithy.api#documentation": "

Remove a user-specifed key and value tag from a data store.

" } }, "com.amazonaws.healthlake#UntagResourceRequest": { @@ -2712,14 +2826,14 @@ "ResourceARN": { "target": "com.amazonaws.healthlake#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name(ARN) of the data store for which tags are being removed.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data store from which tags are being removed.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.healthlake#TagKeyList", "traits": { - "smithy.api#documentation": "

\n The keys for the tags to be removed from the HealthLake data store.\n

", + "smithy.api#documentation": "

The keys for the tags to be removed from the data store.

", "smithy.api#required": {} } } @@ -2747,6 +2861,29 @@ "smithy.api#error": "client", "smithy.api#httpError": 400 } + }, + "com.amazonaws.healthlake#ValidationLevel": { + "type": "enum", + "members": { + "STRICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "strict" + } + }, + "STRUCTURE_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "structure-only" + } + }, + "MINIMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "minimal" + } + } + } } } } diff --git a/codegen/sdk/aws-models/iam.json b/codegen/sdk/aws-models/iam.json index 14058fb7484..3961912f674 100644 --- a/codegen/sdk/aws-models/iam.json +++ b/codegen/sdk/aws-models/iam.json @@ -1952,17 +1952,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1984,17 +1973,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2016,17 +1994,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2048,17 +2015,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2080,17 +2036,6 @@ "UseDualStack": false } }, - { - "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": { @@ -2112,17 +2057,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2145,18 +2079,28 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://iam-fips.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -2167,43 +2111,53 @@ } ] }, - "url": "https://iam-fips.csp.hci.ic.gov" + "url": "https://iam.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eusc-de-east-1" + } + ] + }, + "url": "https://iam-fips.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingRegion": "us-isof-south-1" + "signingRegion": "eusc-de-east-1" } ] }, - "url": "https://iam.us-isof-south-1.csp.hci.ic.gov" + "url": "https://iam.eusc-de-east-1.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } diff --git a/codegen/sdk/aws-models/identitystore.json b/codegen/sdk/aws-models/identitystore.json index cd6a00db2d8..c9ca65ae86c 100644 --- a/codegen/sdk/aws-models/identitystore.json +++ b/codegen/sdk/aws-models/identitystore.json @@ -736,17 +736,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -760,17 +749,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -784,17 +762,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -808,17 +775,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/imagebuilder.json b/codegen/sdk/aws-models/imagebuilder.json index acd1da393ef..f4d8dfd4b9b 100644 --- a/codegen/sdk/aws-models/imagebuilder.json +++ b/codegen/sdk/aws-models/imagebuilder.json @@ -158,7 +158,7 @@ "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The KMS key identifier used to encrypt the distributed image.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt the distributed image. \n\t\t\tThis can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide.

" } }, "launchPermission": { @@ -191,6 +191,30 @@ "com.amazonaws.imagebuilder#Arn": { "type": "string" }, + "com.amazonaws.imagebuilder#AutoDisableFailureCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.imagebuilder#AutoDisablePolicy": { + "type": "structure", + "members": { + "failureCount": { + "target": "com.amazonaws.imagebuilder#AutoDisableFailureCount", + "traits": { + "smithy.api#documentation": "

The number of consecutive scheduled image pipeline executions that must fail before Image Builder \n\t\t\tautomatically disables the pipeline.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the rules by which an image pipeline is automatically disabled when it fails.

" + } + }, "com.amazonaws.imagebuilder#Boolean": { "type": "boolean", "traits": { @@ -511,7 +535,7 @@ "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The KMS key identifier used to encrypt the component.

" + "smithy.api#documentation": "

The KMS key identifier used to encrypt the component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide.

" } }, "encrypted": { @@ -977,6 +1001,14 @@ "target": "com.amazonaws.imagebuilder#ComponentVersion" } }, + "com.amazonaws.imagebuilder#ConsecutiveFailures": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.imagebuilder#Container": { "type": "structure", "members": { @@ -1096,7 +1128,7 @@ "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

Identifies which KMS key is used to encrypt the container image for distribution to\n\t\t\tthe target Region.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the container image \n\t\t\tfor distribution to the target Region. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide.

" } }, "encrypted": { @@ -1191,6 +1223,12 @@ "smithy.api#documentation": "

The date when this container recipe was created.

" } }, + "instanceImage": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The base image for a container build and test instance. This can contain an AMI ID \n\t\tor it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, \n\t\tfollowed by the parameter name or ARN.

\n

If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.

" + } + }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { @@ -1339,7 +1377,7 @@ "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the KMS key that is used to encrypt this component.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide.

" } }, "tags": { @@ -1535,7 +1573,7 @@ "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

Identifies which KMS key is used to encrypt the Dockerfile template.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the Dockerfile \n\t\t\ttemplate. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide.

" } }, "clientToken": { @@ -1888,6 +1926,12 @@ "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) for the IAM role you create that grants \n\t\t\tImage Builder access to perform workflow actions.

" } + }, + "loggingConfiguration": { + "target": "com.amazonaws.imagebuilder#PipelineLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

Define logging configuration for the image build process.

" + } } }, "traits": { @@ -2033,6 +2077,12 @@ "smithy.api#documentation": "

Specify additional settings and launch scripts for your build instances.

" } }, + "amiTags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

Tags that are applied to the AMI that Image Builder creates during the Build phase \n\t\t\tprior to image distribution.

" + } + }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { @@ -2143,6 +2193,12 @@ "traits": { "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) for the IAM role you create that grants \n\t\t\tImage Builder access to perform workflow actions.

" } + }, + "loggingConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

Define logging configuration for the image build process.

" + } } }, "traits": { @@ -2586,7 +2642,7 @@ "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the KMS key that is used to encrypt this workflow resource.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this workflow resource. \n\t\t\tThis can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide.

" } }, "tags": { @@ -3662,7 +3718,7 @@ "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

Use to configure the KMS key to use when encrypting the device.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. \n\t\t\tThis can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide.

" } }, "snapshotId": { @@ -5556,10 +5612,16 @@ "traits": { "smithy.api#documentation": "

Contains the build and test workflows that are associated with the image.

" } + }, + "loggingConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

The logging configuration that's defined for the image. Image Builder uses the defined settings \n\t\t\tto direct execution log output during image creation.

" + } } }, "traits": { - "smithy.api#documentation": "

An Image Builder image. You must specify exactly one recipe for the image – either a\n\t\t\tcontainer recipe (containerRecipe), which creates a container image, or an\n\t\t\timage recipe (imageRecipe), which creates an AMI.

" + "smithy.api#documentation": "

An Image Builder image resource that keeps track of all of the settings used to create, configure, \n\t\t\tand distribute output for that image. You must specify exactly one recipe for the image – \n\t\t\teither a container recipe (containerRecipe), which creates a container image, or an\n\t\t\timage recipe (imageRecipe), which creates an AMI.

" } }, "com.amazonaws.imagebuilder#ImageAggregation": { @@ -5603,6 +5665,20 @@ "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-9]+))(?:/[0-9]+)?)?$" } }, + "com.amazonaws.imagebuilder#ImageLoggingConfiguration": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.imagebuilder#LogGroupName", + "traits": { + "smithy.api#documentation": "

The log group name that Image Builder uses for image creation. If not specified, the log group \n\t\t\tname defaults to /aws/imagebuilder/image-name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The logging configuration that's defined for the image. Image Builder uses the defined settings \n\t\t\tto direct execution log output during image creation.

" + } + }, "com.amazonaws.imagebuilder#ImagePackage": { "type": "structure", "members": { @@ -5722,6 +5798,12 @@ "smithy.api#documentation": "

This is no longer supported, and does not return a value.

" } }, + "lastRunStatus": { + "target": "com.amazonaws.imagebuilder#ImageStatus", + "traits": { + "smithy.api#documentation": "

The status of the last image that this pipeline built, such as \n\t\t\tBUILDING, TESTING, FAILED, \n\t\t\tor AVAILABLE.

" + } + }, "dateNextRun": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { @@ -5751,6 +5833,18 @@ "traits": { "smithy.api#documentation": "

Contains the workflows that run for the image pipeline.

" } + }, + "loggingConfiguration": { + "target": "com.amazonaws.imagebuilder#PipelineLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

Defines logging configuration for the output image.

" + } + }, + "consecutiveFailures": { + "target": "com.amazonaws.imagebuilder#ConsecutiveFailures", + "traits": { + "smithy.api#documentation": "

Image Builder tracks the number of consecutive failures for scheduled pipeline \n\t\t\texecutions and takes one of the following actions each time it runs on a schedule:

\n
    \n
  • \n

    If the pipeline execution is successful, the number of consecutive \n\t\t\t\t\tfailures resets to zero.

    \n
  • \n
  • \n

    If the pipeline execution fails, Image Builder increments the number of \n\t\t\t\t\tconsecutive failures. If the failure count exceeds the limit defined in the \n\t\t\t\t\tAutoDisablePolicy, Image Builder disables the pipeline.

    \n
  • \n
\n

The consecutive failure count is also reset to zero under the following \n\t\t\tconditions:

\n
    \n
  • \n

    The pipeline runs manually and succeeds.

    \n
  • \n
  • \n

    The pipeline configuration is updated.

    \n
  • \n
\n

If the pipeline runs manually and fails, the count remains the same. The next \n\t\t\tscheduled run continues to increment where it left off before.

" + } } }, "traits": { @@ -5875,6 +5969,12 @@ "traits": { "smithy.api#documentation": "

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test\n\t\t\tyour image configuration. Instance configuration adds a layer of control over those\n\t\t\tinstances. You can define settings and add scripts to run when an instance is launched\n\t\t\tfrom your AMI.

" } + }, + "amiTags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

Tags that are applied to the AMI that Image Builder creates during the Build phase \n\t\t\tprior to image distribution.

" + } } }, "traits": { @@ -6434,6 +6534,12 @@ "traits": { "smithy.api#documentation": "

Identifies the last runtime instance of the lifecycle policy to take action on the image.

" } + }, + "loggingConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

The logging configuration that's defined for the image.

" + } } }, "traits": { @@ -6692,7 +6798,7 @@ "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the KMS key that should be used to encrypt this component.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide.

" } }, "tags": { @@ -6825,6 +6931,12 @@ "smithy.api#required": {} } }, + "loggingConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

Define logging configuration for the image build process.

" + } + }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { @@ -6935,6 +7047,12 @@ "smithy.api#required": {} } }, + "loggingConfiguration": { + "target": "com.amazonaws.imagebuilder#ImageLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

Define logging configuration for the image build process.

" + } + }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { @@ -8414,14 +8532,13 @@ "componentVersionArn": { "target": "com.amazonaws.imagebuilder#ComponentVersionArn", "traits": { - "smithy.api#documentation": "

The component version Amazon Resource Name (ARN) whose versions you want to\n\t\t\tlist.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The component version Amazon Resource Name (ARN) whose versions you want to\n\t\t\tlist.

" } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -8532,7 +8649,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -8636,7 +8753,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -8734,7 +8851,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -8826,8 +8943,7 @@ "imageVersionArn": { "target": "com.amazonaws.imagebuilder#ImageVersionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image whose build versions you want to\n\t\t\tretrieve.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image whose build versions you want to\n\t\t\tretrieve.

" } }, "filters": { @@ -8839,7 +8955,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -8941,7 +9057,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -9049,7 +9165,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -9147,7 +9263,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -9239,7 +9355,7 @@ "owner": { "target": "com.amazonaws.imagebuilder#Ownership", "traits": { - "smithy.api#documentation": "

The owner defines which image recipes you want to list. By default, this request will\n\t\t\tonly show image recipes owned by your account. You can use this field to specify if you\n\t\t\twant to view image recipes owned by yourself, by Amazon, or those image recipes that\n\t\t\thave been shared with you by other customers.

" + "smithy.api#documentation": "

You can specify the recipe owner to filter results by that owner. By default, this request will\n\t\t\tonly show image recipes owned by your account. To filter by a different owner, specify one of the \n\t\t\tValid Values that are listed for this parameter.

" } }, "filters": { @@ -9251,7 +9367,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -9277,7 +9393,7 @@ "imageRecipeSummaryList": { "target": "com.amazonaws.imagebuilder#ImageRecipeSummaryList", "traits": { - "smithy.api#documentation": "

The list of image pipelines.

" + "smithy.api#documentation": "

A list of ImageRecipeSummary objects that contain identifying characteristics for the \n\t\t\timage recipe, such as the name, the Amazon Resource Name (ARN), and the date created, along with other key details.

" } }, "nextToken": { @@ -9443,7 +9559,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -9554,7 +9670,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -9658,7 +9774,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -9763,7 +9879,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -9861,7 +9977,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -9960,7 +10076,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -10104,7 +10220,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -10190,14 +10306,13 @@ "workflowVersionArn": { "target": "com.amazonaws.imagebuilder#WorkflowWildcardVersionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource for which to get a list of build versions.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the workflow resource for which to get a list of build versions.

" } }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -10283,7 +10398,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -10394,7 +10509,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -10536,7 +10651,7 @@ "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { - "smithy.api#documentation": "

The maximum items to return in a request.

" + "smithy.api#documentation": "

Specify the maximum number of items to return in a request.

" } }, "nextToken": { @@ -10570,6 +10685,16 @@ "smithy.api#output": {} } }, + "com.amazonaws.imagebuilder#LogGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-_/\\.]{1,512}$" + } + }, "com.amazonaws.imagebuilder#Logging": { "type": "structure", "members": { @@ -10889,6 +11014,26 @@ } } }, + "com.amazonaws.imagebuilder#PipelineLoggingConfiguration": { + "type": "structure", + "members": { + "imageLogGroupName": { + "target": "com.amazonaws.imagebuilder#LogGroupName", + "traits": { + "smithy.api#documentation": "

The log group name that Image Builder uses for image creation. If not specified, the log group \n\t\t\tname defaults to /aws/imagebuilder/image-name.

" + } + }, + "pipelineLogGroupName": { + "target": "com.amazonaws.imagebuilder#LogGroupName", + "traits": { + "smithy.api#documentation": "

The log group name that Image Builder uses for the log output during creation of a new pipeline. \n\t\t\tIf not specified, the pipeline log group name defaults to \n\t\t\t/aws/imagebuilder/pipeline/pipeline-name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The logging configuration that's defined for pipeline execution.

" + } + }, "com.amazonaws.imagebuilder#PipelineStatus": { "type": "enum", "members": { @@ -11645,6 +11790,12 @@ "traits": { "smithy.api#documentation": "

The start condition configures when the pipeline should trigger a new image build, \n\t\t\tas follows. If no value is set Image Builder defaults to \n\t\t\tEXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE.

\n
    \n
  • \n

    \n EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE (default) – \n\t\t\t\t\tWhen you use semantic version filters on the base image or components in your \n\t\t\t\t\timage recipe, EC2 Image Builder builds a new image only when there are new versions of \n\t\t\t\t\tthe base image or components in your recipe that match the filter.

    \n \n

    For semantic version syntax, see CreateComponent.

    \n
    \n
  • \n
  • \n

    \n EXPRESSION_MATCH_ONLY – This condition builds a new \n\t\t\t\t\timage every time the CRON expression matches the current time.

    \n
  • \n
" } + }, + "autoDisablePolicy": { + "target": "com.amazonaws.imagebuilder#AutoDisablePolicy", + "traits": { + "smithy.api#documentation": "

The policy that configures when Image Builder should automatically disable a pipeline that \n\t\t\tis failing.

" + } } }, "traits": { @@ -11981,6 +12132,12 @@ "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

Specify tags for Image Builder to apply to the image resource that's created \n\t\t\tWhen it starts pipeline execution.

" + } } }, "traits": { @@ -12145,7 +12302,7 @@ "uninstallAfterBuild": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { - "smithy.api#documentation": "

Controls whether the Systems Manager agent is removed from your final build image, prior to\n\t\t\tcreating the new AMI. If this is set to true, then the agent is removed from the final\n\t\t\timage. If it's set to false, then the agent is left in, so that it is included in the\n\t\t\tnew AMI. The default value is false.

" + "smithy.api#documentation": "

Controls whether the Systems Manager agent is removed from your final build image, prior to\n\t\t\tcreating the new AMI. If this is set to true, then the agent is removed from the final\n\t\t\timage. If it's set to false, then the agent is left in, so that it is included in the\n\t\t\tnew AMI. default value is false.

\n

The default behavior of uninstallAfterBuild is to remove the SSM Agent if it was installed by EC2 Image Builder

" } } }, @@ -12616,6 +12773,12 @@ "smithy.api#documentation": "

Contains the workflows to run for the pipeline.

" } }, + "loggingConfiguration": { + "target": "com.amazonaws.imagebuilder#PipelineLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

Update logging configuration for the output image that's created when \n\t\t\tthe pipeline runs.

" + } + }, "executionRole": { "target": "com.amazonaws.imagebuilder#RoleNameOrArn", "traits": { @@ -13123,7 +13286,7 @@ "kmsKeyId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The KMS key identifier used to encrypt the workflow resource.

" + "smithy.api#documentation": "

The KMS key identifier used to encrypt the workflow resource. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) \n\t\t\tin the Key Management Service Developer Guide.

" } }, "dateCreated": { @@ -14732,17 +14895,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -14756,17 +14908,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -14780,17 +14921,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -14804,17 +14934,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/inspector-scan.json b/codegen/sdk/aws-models/inspector-scan.json index b55afbfc0d6..967763635a6 100644 --- a/codegen/sdk/aws-models/inspector-scan.json +++ b/codegen/sdk/aws-models/inspector-scan.json @@ -546,17 +546,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -570,17 +559,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -594,17 +572,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -618,17 +585,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/inspector.json b/codegen/sdk/aws-models/inspector.json index 3d38b389259..bf03c4ff65d 100644 --- a/codegen/sdk/aws-models/inspector.json +++ b/codegen/sdk/aws-models/inspector.json @@ -4138,17 +4138,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4162,17 +4151,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4186,17 +4164,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4210,17 +4177,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/inspector2.json b/codegen/sdk/aws-models/inspector2.json index bfd6f7803d0..f3bc36228c3 100644 --- a/codegen/sdk/aws-models/inspector2.json +++ b/codegen/sdk/aws-models/inspector2.json @@ -5544,14 +5544,14 @@ "type": "structure", "members": { "baseScore": { - "target": "com.amazonaws.inspector2#Cvss2BaseScore", + "target": "com.amazonaws.inspector2#CvssBaseScore", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The CVSS v2 base score for the vulnerability.

" } }, "scoringVector": { - "target": "com.amazonaws.inspector2#Cvss2ScoringVector", + "target": "com.amazonaws.inspector2#CvssScoringVector", "traits": { "smithy.api#documentation": "

The scoring vector associated with the CVSS v2 score.

" } @@ -5561,32 +5561,18 @@ "smithy.api#documentation": "

The Common Vulnerability Scoring System (CVSS) version 2 details for the\n vulnerability.

" } }, - "com.amazonaws.inspector2#Cvss2BaseScore": { - "type": "double", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.inspector2#Cvss2ScoringVector": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, "com.amazonaws.inspector2#Cvss3": { "type": "structure", "members": { "baseScore": { - "target": "com.amazonaws.inspector2#Cvss3BaseScore", + "target": "com.amazonaws.inspector2#CvssBaseScore", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The CVSS v3 base score for the vulnerability.

" } }, "scoringVector": { - "target": "com.amazonaws.inspector2#Cvss3ScoringVector", + "target": "com.amazonaws.inspector2#CvssScoringVector", "traits": { "smithy.api#documentation": "

The scoring vector associated with the CVSS v3 score.

" } @@ -5596,18 +5582,31 @@ "smithy.api#documentation": "

The Common Vulnerability Scoring System (CVSS) version 3 details for the\n vulnerability.

" } }, - "com.amazonaws.inspector2#Cvss3BaseScore": { - "type": "double", + "com.amazonaws.inspector2#Cvss4": { + "type": "structure", + "members": { + "baseScore": { + "target": "com.amazonaws.inspector2#CvssBaseScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The base CVSS v4 score for the vulnerability finding, which rates the severity of the vulnerability on a scale from 0 to 10.

" + } + }, + "scoringVector": { + "target": "com.amazonaws.inspector2#CvssScoringVector", + "traits": { + "smithy.api#documentation": "

The CVSS v4 scoring vector, which contains the metrics and measurements that were used to calculate the base score.

" + } + } + }, "traits": { - "smithy.api#default": 0 + "smithy.api#documentation": "

The Common Vulnerability Scoring System (CVSS) version 4 details for the vulnerability.

" } }, - "com.amazonaws.inspector2#Cvss3ScoringVector": { - "type": "string", + "com.amazonaws.inspector2#CvssBaseScore": { + "type": "double", "traits": { - "smithy.api#length": { - "min": 0 - } + "smithy.api#default": 0 } }, "com.amazonaws.inspector2#CvssScore": { @@ -5728,6 +5727,14 @@ "target": "com.amazonaws.inspector2#CvssScore" } }, + "com.amazonaws.inspector2#CvssScoringVector": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, "com.amazonaws.inspector2#Cwe": { "type": "string", "traits": { @@ -6419,7 +6426,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 3 + "max": 5 } } }, @@ -7175,7 +7182,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 3 + "max": 5 } } }, @@ -10974,17 +10981,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -10998,17 +10994,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -11022,17 +11007,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -11046,17 +11020,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -15409,7 +15372,7 @@ "reason": { "target": "com.amazonaws.inspector2#ScanStatusReason", "traits": { - "smithy.api#documentation": "

The scan status. Possible return values and descriptions are:

\n

\n ACCESS_DENIED - Resource access policy restricting Amazon Inspector access. Please\n update the IAM policy.

\n

\n ACCESS_DENIED_TO_ENCRYPTION_KEY - The KMS key policy doesn't allow Amazon Inspector\n access. Update the key policy.

\n

\n DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED - Amazon Inspector failed to extract\n the package inventory because the package collection time exceeding the maximum threshold\n of 15 minutes.

\n

\n DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED - The SSM agent couldn't\n send inventory to Amazon Inspector because the SSM quota for Inventory data collected per instance per\n day has already been reached for this instance.

\n

\n DEEP_INSPECTION_NO_INVENTORY - The Amazon Inspector plugin hasn't yet been able to\n collect an inventory of packages for this instance. This is usually the result of a pending\n scan, however, if this status persists after 6 hours, use SSM to ensure that\n the required Amazon Inspector associations exist and are running for the instance.

\n

\n DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED - The instance has\n exceeded the 5000 package limit for Amazon Inspector Deep inspection. To resume Deep inspection for\n this instance you can try to adjust the custom paths associated with the account.

\n

\n EC2_INSTANCE_STOPPED - This EC2 instance is in a stopped state, therefore,\n Amazon Inspector will pause scanning. The existing findings will continue to exist until the instance\n is terminated. Once the instance is re-started, Inspector will automatically start scanning\n the instance again. Please note that you will not be charged for this instance while it's\n in a stopped state.

\n

\n EXCLUDED_BY_TAG - This resource was not scanned because it has been\n excluded by a tag.

\n

\n IMAGE_SIZE_EXCEEDED - Reserved for future use.

\n

\n INTEGRATION_CONNNECTION_LOST - Amazon Inspector couldn't communicate with the source\n code management platform.

\n

\n INTERNAL_ERROR - Amazon Inspector has encountered an internal error for this resource.\n Amazon Inspector service will automatically resolve the issue and resume the scanning. No action\n required from the user.

\n

\n NO INVENTORY - Amazon Inspector couldn't find software application inventory to scan\n for vulnerabilities. This might be caused due to required Amazon Inspector associations being deleted\n or failing to run on your resource. Please verify the status of\n InspectorInventoryCollection-do-not-delete association in the SSM console\n for the resource. Additionally, you can verify the instance's inventory in the SSM Fleet\n Manager console.

\n

\n NO_RESOURCES_FOUND - Reserved for future use.

\n

\n NO_SCAN_CONFIGURATION_ASSOCIATED - The code repository resource doesn't\n have an associated scan configuration.

\n

\n PENDING_DISABLE - This resource is pending cleanup during disablement. The\n customer will not be billed while a resource is in the pending disable status.

\n

\n PENDING_INITIAL_SCAN - This resource has been identified for scanning,\n results will be available soon.

\n

\n RESOURCE_TERMINATED - This resource has been terminated. The findings and\n coverage associated with this resource are in the process of being cleaned up.

\n

\n SCAN_ELIGIBILITY_EXPIRED - The configured scan duration has lapsed for this\n image.

\n

\n SCAN_FREQUENCY_MANUAL - This image will not be covered by Amazon Inspector due to the\n repository scan frequency configuration.

\n

\n SCAN_FREQUENCY_SCAN_ON_PUSH - This image will be scanned one time and will\n not new findings because of the scan frequency configuration.

\n

\n SCAN_IN_PROGRESS - The resource is currently being scanned.

\n

\n STALE_INVENTORY - Amazon Inspector wasn't able to collect an updated software\n application inventory in the last 7 days. Please confirm the required Amazon Inspector associations\n still exist and you can still see an updated inventory in the SSM console.

\n

\n SUCCESSFUL - The scan was successful.

\n

\n UNMANAGED_EC2_INSTANCE - The EC2 instance is not managed by SSM, please use\n the following SSM automation to remediate the issue: https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-awssupport-troubleshoot-managed-instance.html.\n Once the instance becomes managed by SSM, Inspector will automatically begin scanning this\n instance.

\n

\n UNSUPPORTED_CONFIG_FILE - Reserved for future use.

\n

\n UNSUPPORTED_LANGUAGE - The scan was unsuccessful because the repository\n contains files in an unsupported programming language.

\n

\n UNSUPPORTED_MEDIA_TYPE - The ECR image has an unsupported media\n type.

\n

\n UNSUPPORTED_OS - Amazon Inspector does not support this OS, architecture, or image\n manifest type at this time. To see a complete list of supported operating systems see:\n https://docs.aws.amazon.com/inspector/latest/user/supported.html.

\n

\n UNSUPPORTED_RUNTIME - The function was not scanned because it has an\n unsupported runtime. To see a complete list of supported runtimes see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.

", + "smithy.api#documentation": "

The scan status. Possible return values and descriptions are:

\n

\n ACCESS_DENIED - Resource access policy restricting Amazon Inspector access. Please\n update the IAM policy.

\n

\n ACCESS_DENIED_TO_ENCRYPTION_KEY - The KMS key policy doesn't allow Amazon Inspector\n access. Update the key policy.

\n

\n DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED - Amazon Inspector failed to extract\n the package inventory because the package collection time exceeding the maximum threshold\n of 15 minutes.

\n

\n DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED - The SSM agent couldn't\n send inventory to Amazon Inspector because the SSM quota for Inventory data collected per instance per\n day has already been reached for this instance.

\n

\n DEEP_INSPECTION_NO_INVENTORY - The Amazon Inspector plugin hasn't yet been able to\n collect an inventory of packages for this instance. This is usually the result of a pending\n scan, however, if this status persists after 6 hours, use SSM to ensure that\n the required Amazon Inspector associations exist and are running for the instance.

\n

\n DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED - The instance has\n exceeded the 5000 package limit for Amazon Inspector Deep inspection. To resume Deep inspection for\n this instance you can try to adjust the custom paths associated with the account.

\n

\n EC2_INSTANCE_STOPPED - This EC2 instance is in a stopped state, therefore,\n Amazon Inspector will pause scanning. The existing findings will continue to exist until the instance\n is terminated. Once the instance is re-started, Inspector will automatically start scanning\n the instance again. Please note that you will not be charged for this instance while it's\n in a stopped state.

\n

\n EXCLUDED_BY_TAG - This resource was not scanned because it has been\n excluded by a tag.

\n

\n IMAGE_SIZE_EXCEEDED - Reserved for future use.

\n

\n INTEGRATION_CONNNECTION_LOST - Amazon Inspector couldn't communicate with the source\n code management platform.

\n

\n INTERNAL_ERROR - Amazon Inspector has encountered an internal error for this resource.\n Amazon Inspector service will automatically resolve the issue and resume the scanning. No action\n required from the user.

\n

\n NO_INVENTORY - Amazon Inspector couldn't find software application inventory to scan\n for vulnerabilities. This might be caused due to required Amazon Inspector associations being deleted\n or failing to run on your resource. Please verify the status of\n InspectorInventoryCollection-do-not-delete association in the SSM console\n for the resource. Additionally, you can verify the instance's inventory in the SSM Fleet\n Manager console.

\n

\n NO_RESOURCES_FOUND - Reserved for future use.

\n

\n NO_SCAN_CONFIGURATION_ASSOCIATED - The code repository resource doesn't\n have an associated scan configuration.

\n

\n PENDING_DISABLE - This resource is pending cleanup during disablement. The\n customer will not be billed while a resource is in the pending disable status.

\n

\n PENDING_INITIAL_SCAN - This resource has been identified for scanning,\n results will be available soon.

\n

\n RESOURCE_TERMINATED - This resource has been terminated. The findings and\n coverage associated with this resource are in the process of being cleaned up.

\n

\n SCAN_ELIGIBILITY_EXPIRED - The configured scan duration has lapsed for this\n image.

\n

\n SCAN_FREQUENCY_MANUAL - This image will not be covered by Amazon Inspector due to the\n repository scan frequency configuration.

\n

\n SCAN_FREQUENCY_SCAN_ON_PUSH - This image will be scanned one time and will\n not new findings because of the scan frequency configuration.

\n

\n SCAN_IN_PROGRESS - The resource is currently being scanned.

\n

\n STALE_INVENTORY - Amazon Inspector wasn't able to collect an updated software\n application inventory in the last 7 days. Please confirm the required Amazon Inspector associations\n still exist and you can still see an updated inventory in the SSM console.

\n

\n SUCCESSFUL - The scan was successful.

\n

\n UNMANAGED_EC2_INSTANCE - The EC2 instance is not managed by SSM, please use\n the following SSM automation to remediate the issue: https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-awssupport-troubleshoot-managed-instance.html.\n Once the instance becomes managed by SSM, Inspector will automatically begin scanning this\n instance.

\n

\n UNSUPPORTED_CONFIG_FILE - Reserved for future use.

\n

\n UNSUPPORTED_LANGUAGE - The scan was unsuccessful because the repository\n contains files in an unsupported programming language.

\n

\n UNSUPPORTED_MEDIA_TYPE - The ECR image has an unsupported media\n type.

\n

\n UNSUPPORTED_OS - Amazon Inspector does not support this OS, architecture, or image\n manifest type at this time. To see a complete list of supported operating systems see:\n https://docs.aws.amazon.com/inspector/latest/user/supported.html.

\n

\n UNSUPPORTED_RUNTIME - The function was not scanned because it has an\n unsupported runtime. To see a complete list of supported runtimes see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.

", "smithy.api#required": {} } } @@ -18407,6 +18370,12 @@ "smithy.api#documentation": "

The severity assigned by the vendor.

" } }, + "cvss4": { + "target": "com.amazonaws.inspector2#Cvss4", + "traits": { + "smithy.api#documentation": "

An object that contains the Common Vulnerability Scoring System (CVSS) Version 4 details for the vulnerability.

" + } + }, "cvss3": { "target": "com.amazonaws.inspector2#Cvss3", "traits": { diff --git a/codegen/sdk/aws-models/internetmonitor.json b/codegen/sdk/aws-models/internetmonitor.json index f9f115cd0d1..a0eb47ba44c 100644 --- a/codegen/sdk/aws-models/internetmonitor.json +++ b/codegen/sdk/aws-models/internetmonitor.json @@ -1972,17 +1972,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1996,17 +1985,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2020,17 +1998,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2044,17 +2011,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/invoicing.json b/codegen/sdk/aws-models/invoicing.json index 7b0e0106267..7daadcfe049 100644 --- a/codegen/sdk/aws-models/invoicing.json +++ b/codegen/sdk/aws-models/invoicing.json @@ -1449,166 +1449,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://invoicing-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://invoicing.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://invoicing-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://invoicing.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eu-isoe-west-1" - } - ] - }, - "url": "https://invoicing-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eu-isoe-west-1" - } - ] - }, - "url": "https://invoicing.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isof-south-1" - } - ] - }, - "url": "https://invoicing-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isof-south-1" - } - ] - }, - "url": "https://invoicing.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { diff --git a/codegen/sdk/aws-models/iot-data-plane.json b/codegen/sdk/aws-models/iot-data-plane.json index 1b58de88f6a..26e4f7731d6 100644 --- a/codegen/sdk/aws-models/iot-data-plane.json +++ b/codegen/sdk/aws-models/iot-data-plane.json @@ -29,6 +29,22 @@ ] }, "shapes": { + "com.amazonaws.iotdataplane#CleanSession": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.iotdataplane#ClientId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[^$]" + } + }, "com.amazonaws.iotdataplane#ConflictException": { "type": "structure", "members": { @@ -51,6 +67,72 @@ "com.amazonaws.iotdataplane#CorrelationData": { "type": "string" }, + "com.amazonaws.iotdataplane#DeleteConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdataplane#DeleteConnectionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iotdataplane#ForbiddenException" + }, + { + "target": "com.amazonaws.iotdataplane#InternalFailureException" + }, + { + "target": "com.amazonaws.iotdataplane#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotdataplane#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotdataplane#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Disconnects a connected MQTT client from Amazon Web Services IoT Core. When you disconnect a client, Amazon Web Services IoT Core closes the client's network connection and optionally cleans the session state.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/connections/{clientId}", + "code": 200 + } + } + }, + "com.amazonaws.iotdataplane#DeleteConnectionRequest": { + "type": "structure", + "members": { + "clientId": { + "target": "com.amazonaws.iotdataplane#ClientId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the MQTT client to disconnect. The client ID can't start with a dollar sign ($).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "cleanSession": { + "target": "com.amazonaws.iotdataplane#CleanSession", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to remove the client's session state when disconnecting. Set to TRUE to delete all session information, including subscriptions and queued messages. Set to FALSE to preserve the session state. By default, this is set to FALSE (preserves the session state).

", + "smithy.api#httpQuery": "cleanSession" + } + }, + "preventWillMessage": { + "target": "com.amazonaws.iotdataplane#PreventWillMessage", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Controls if Amazon Web Services IoT Core publishes the client's Last Will and Testament (LWT) message upon disconnection. Set to TRUE to prevent publishing the LWT message. Set to FALSE to allow publishing. By default, this is set to FALSE (allows publishing the LWT message).

", + "smithy.api#httpQuery": "preventWillMessage" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.iotdataplane#DeleteThingShadow": { "type": "operation", "input": { @@ -135,6 +217,19 @@ "smithy.api#output": {} } }, + "com.amazonaws.iotdataplane#ForbiddenException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotdataplane#errorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The caller isn't authorized to make the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, "com.amazonaws.iotdataplane#GetRetainedMessage": { "type": "operation", "input": { @@ -167,7 +262,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the details of a single retained message for the specified topic.

\n

This action returns the message payload of the retained message, which can \n incur messaging costs. To list only the topic names of the retained messages, call\n ListRetainedMessages.

\n

Requires permission to access the GetRetainedMessage action.

\n

For more information about messaging costs, see Amazon Web Services IoT Core\n pricing - Messaging.

", + "smithy.api#documentation": "

Gets the details of a single retained message for the specified topic.

\n

This action returns the message payload of the retained message, which can \n incur messaging costs. To list only the topic names of the retained messages, call\n ListRetainedMessages.

\n

Requires permission to access the GetRetainedMessage action.

\n

For more information about messaging costs, see Amazon Web Services IoT Core\n pricing - Messaging.

", "smithy.api#http": { "method": "GET", "uri": "/retainedMessage/{topic}", @@ -368,6 +463,9 @@ "type": "service", "version": "2015-05-28", "operations": [ + { + "target": "com.amazonaws.iotdataplane#DeleteConnection" + }, { "target": "com.amazonaws.iotdataplane#DeleteThingShadow" }, @@ -1416,17 +1514,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1440,17 +1527,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1464,17 +1540,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1488,17 +1553,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1703,7 +1757,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists summary information about the retained messages stored for the account.

\n

This action returns only the topic names of the retained messages. It doesn't \n return any message payloads. Although this action doesn't return a message payload,\n it can still incur messaging costs.

\n

To get the message payload of a retained message, call\n GetRetainedMessage\n with the topic name of the retained message.

\n

Requires permission to access the ListRetainedMessages action.

\n

For more information about messaging costs, see Amazon Web Services IoT Core\n pricing - Messaging.

", + "smithy.api#documentation": "

Lists summary information about the retained messages stored for the account.

\n

This action returns only the topic names of the retained messages. It doesn't \n return any message payloads. Although this action doesn't return a message payload,\n it can still incur messaging costs.

\n

To get the message payload of a retained message, call\n GetRetainedMessage\n with the topic name of the retained message.

\n

Requires permission to access the ListRetainedMessages action.

\n

For more information about messaging costs, see Amazon Web Services IoT Core\n pricing - Messaging.

", "smithy.api#http": { "method": "GET", "uri": "/retainedMessage", @@ -1834,6 +1888,12 @@ "smithy.api#default": 0 } }, + "com.amazonaws.iotdataplane#PreventWillMessage": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.iotdataplane#Publish": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/iot-events-data.json b/codegen/sdk/aws-models/iot-events-data.json index 54b33b00470..70a385f2c9e 100644 --- a/codegen/sdk/aws-models/iot-events-data.json +++ b/codegen/sdk/aws-models/iot-events-data.json @@ -2123,17 +2123,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2147,17 +2136,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2171,17 +2149,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2195,17 +2162,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/iot-events.json b/codegen/sdk/aws-models/iot-events.json index c21e9215c5d..016e8cb7d15 100644 --- a/codegen/sdk/aws-models/iot-events.json +++ b/codegen/sdk/aws-models/iot-events.json @@ -3342,17 +3342,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3366,17 +3355,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3390,17 +3368,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3414,17 +3381,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/iot-jobs-data-plane.json b/codegen/sdk/aws-models/iot-jobs-data-plane.json index ae29d1aae59..3483e1b0efa 100644 --- a/codegen/sdk/aws-models/iot-jobs-data-plane.json +++ b/codegen/sdk/aws-models/iot-jobs-data-plane.json @@ -1258,17 +1258,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1282,17 +1271,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1306,17 +1284,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1330,17 +1297,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/iot-managed-integrations.json b/codegen/sdk/aws-models/iot-managed-integrations.json index 5e0d7ab44c6..208c2448854 100644 --- a/codegen/sdk/aws-models/iot-managed-integrations.json +++ b/codegen/sdk/aws-models/iot-managed-integrations.json @@ -7419,102 +7419,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.iotmanagedintegrations-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://api.iotmanagedintegrations.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://api.iotmanagedintegrations-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://api.iotmanagedintegrations.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://api.iotmanagedintegrations-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://api.iotmanagedintegrations.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://api.iotmanagedintegrations-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://api.iotmanagedintegrations.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { diff --git a/codegen/sdk/aws-models/iot-wireless.json b/codegen/sdk/aws-models/iot-wireless.json index dc96d88e5f8..22a362b472f 100644 --- a/codegen/sdk/aws-models/iot-wireless.json +++ b/codegen/sdk/aws-models/iot-wireless.json @@ -17036,17 +17036,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -17060,17 +17049,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -17084,17 +17062,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -17108,17 +17075,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/iot.json b/codegen/sdk/aws-models/iot.json index dbc3b0c588d..81f891a8ea8 100644 --- a/codegen/sdk/aws-models/iot.json +++ b/codegen/sdk/aws-models/iot.json @@ -1723,17 +1723,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1747,17 +1736,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1771,17 +1749,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1795,17 +1762,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/iotanalytics.json b/codegen/sdk/aws-models/iotanalytics.json index 21626984fb0..6c50427af6d 100644 --- a/codegen/sdk/aws-models/iotanalytics.json +++ b/codegen/sdk/aws-models/iotanalytics.json @@ -713,17 +713,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -737,17 +726,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -761,17 +739,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -785,17 +752,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/iotdeviceadvisor.json b/codegen/sdk/aws-models/iotdeviceadvisor.json index fd638cd1e0d..7036ca6687f 100644 --- a/codegen/sdk/aws-models/iotdeviceadvisor.json +++ b/codegen/sdk/aws-models/iotdeviceadvisor.json @@ -1274,17 +1274,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1298,17 +1287,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1322,17 +1300,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1346,17 +1313,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/iotfleethub.json b/codegen/sdk/aws-models/iotfleethub.json index b336891cfd2..e81218fd4d0 100644 --- a/codegen/sdk/aws-models/iotfleethub.json +++ b/codegen/sdk/aws-models/iotfleethub.json @@ -739,17 +739,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -763,17 +752,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -787,17 +765,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -811,17 +778,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/iotfleetwise.json b/codegen/sdk/aws-models/iotfleetwise.json index 76ecaf71201..ed261a00f63 100644 --- a/codegen/sdk/aws-models/iotfleetwise.json +++ b/codegen/sdk/aws-models/iotfleetwise.json @@ -4968,17 +4968,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4992,17 +4981,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5016,17 +4994,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5040,17 +5007,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/iotsecuretunneling.json b/codegen/sdk/aws-models/iotsecuretunneling.json index 2fd0ad123ac..29ade33739e 100644 --- a/codegen/sdk/aws-models/iotsecuretunneling.json +++ b/codegen/sdk/aws-models/iotsecuretunneling.json @@ -1589,28 +1589,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1637,28 +1615,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/iotsitewise.json b/codegen/sdk/aws-models/iotsitewise.json index db2c6802462..cf1139cfaab 100644 --- a/codegen/sdk/aws-models/iotsitewise.json +++ b/codegen/sdk/aws-models/iotsitewise.json @@ -1037,17 +1037,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1061,17 +1050,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1085,17 +1063,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1109,17 +1076,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5113,6 +5069,12 @@ } } }, + "com.amazonaws.iotsitewise#ComputationModelVersionFilter": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(LATEST|ACTIVE|[1-9]{1}\\d{0,9})$" + } + }, "com.amazonaws.iotsitewise#ComputeLocation": { "type": "enum", "members": { @@ -5309,7 +5271,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or\n IAM user) access to the specified IoT SiteWise Monitor portal or project resource.

", + "smithy.api#documentation": "

Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or\n IAM user) access to the specified IoT SiteWise Monitor portal or project resource.

\n \n

Support for access policies that use an SSO Group as the identity is not supported at this time.

\n
", "smithy.api#endpoint": { "hostPrefix": "monitor." }, @@ -9339,6 +9301,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "computationModelVersion": { + "target": "com.amazonaws.iotsitewise#ComputationModelVersionFilter", + "traits": { + "smithy.api#documentation": "

The version of the computation model.

", + "smithy.api#httpQuery": "computationModelVersion" + } } }, "traits": { @@ -11193,7 +11162,7 @@ "maxResults": { "target": "com.amazonaws.iotsitewise#ExecuteQueryMaxResults", "traits": { - "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
" + "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 20000

    \n
  • \n
" } }, "clientToken": { diff --git a/codegen/sdk/aws-models/iotthingsgraph.json b/codegen/sdk/aws-models/iotthingsgraph.json index 16925121ad5..40894b2b5ec 100644 --- a/codegen/sdk/aws-models/iotthingsgraph.json +++ b/codegen/sdk/aws-models/iotthingsgraph.json @@ -2770,17 +2770,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2794,17 +2783,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2818,17 +2796,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2842,17 +2809,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/iottwinmaker.json b/codegen/sdk/aws-models/iottwinmaker.json index 5e190b05ffe..eb2702dcec1 100644 --- a/codegen/sdk/aws-models/iottwinmaker.json +++ b/codegen/sdk/aws-models/iottwinmaker.json @@ -674,17 +674,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -698,17 +687,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -722,17 +700,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -746,17 +713,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/ivs-realtime.json b/codegen/sdk/aws-models/ivs-realtime.json index 3aafab1eeb4..0ea2a8136a9 100644 --- a/codegen/sdk/aws-models/ivs-realtime.json +++ b/codegen/sdk/aws-models/ivs-realtime.json @@ -736,17 +736,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -760,17 +749,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -784,17 +762,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -808,17 +775,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2413,7 +2369,7 @@ "target": "com.amazonaws.ivsrealtime#Replica", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If true, this indicates the participantId is a replicated participant. \n\t If this is a subscribe event, then this flag refers to remoteParticipantId.

" + "smithy.api#documentation": "

If true, this indicates the participantId is a replicated participant. \n\t If this is a subscribe event, then this flag refers to remoteParticipantId. Default: false.

" } } }, @@ -3108,6 +3064,12 @@ "smithy.api#default": 0, "smithy.api#documentation": "

Specifies the spacing between participant tiles in pixels. Default:\n 2.

" } + }, + "participantOrderAttribute": { + "target": "com.amazonaws.ivsrealtime#AttributeKey", + "traits": { + "smithy.api#documentation": "

Attribute name in ParticipantTokenConfiguration identifying the participant ordering key.\n Participants with participantOrderAttribute set to \"\" or not specified are ordered based\n\ton their arrival time into the stage.

" + } } }, "traits": { @@ -3162,8 +3124,7 @@ "smithy.api#http": { "method": "POST", "uri": "/ImportPublicKey" - }, - "smithy.api#readonly": {} + } } }, "com.amazonaws.ivsrealtime#ImportPublicKeyRequest": { @@ -4970,7 +4931,7 @@ "sourceStageArn": { "target": "com.amazonaws.ivsrealtime#StageArn", "traits": { - "smithy.api#documentation": "

ARN of the stage from which this participant is replicated.

" + "smithy.api#documentation": "

Source stage ARN from which this participant is replicated, if replicationType is REPLICA.

" } }, "sourceSessionId": { @@ -5340,6 +5301,12 @@ "traits": { "smithy.api#documentation": "

Specifies the height of the PiP window in pixels. When this is not set explicitly,\n pipHeight’s value will be based on the size of the composition and the\n aspect ratio of the participant’s video.

" } + }, + "participantOrderAttribute": { + "target": "com.amazonaws.ivsrealtime#AttributeKey", + "traits": { + "smithy.api#documentation": "

Attribute name in ParticipantTokenConfiguration identifying the participant ordering key.\n Participants with participantOrderAttribute set to \"\" or not specified are ordered based\n\ton their arrival time into the stage.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/ivs.json b/codegen/sdk/aws-models/ivs.json index eb1f138452d..9458a345675 100644 --- a/codegen/sdk/aws-models/ivs.json +++ b/codegen/sdk/aws-models/ivs.json @@ -709,17 +709,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -733,17 +722,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -757,17 +735,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -781,17 +748,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/ivschat.json b/codegen/sdk/aws-models/ivschat.json index e8d7a8da753..628e90dc552 100644 --- a/codegen/sdk/aws-models/ivschat.json +++ b/codegen/sdk/aws-models/ivschat.json @@ -603,17 +603,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -627,17 +616,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -651,17 +629,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -675,17 +642,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/kafka.json b/codegen/sdk/aws-models/kafka.json index dadfcfaa815..877214bd085 100644 --- a/codegen/sdk/aws-models/kafka.json +++ b/codegen/sdk/aws-models/kafka.json @@ -4867,17 +4867,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4891,17 +4880,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4915,17 +4893,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4939,17 +4906,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/kafkaconnect.json b/codegen/sdk/aws-models/kafkaconnect.json index 2d3b20d2c52..a0f206c14fe 100644 --- a/codegen/sdk/aws-models/kafkaconnect.json +++ b/codegen/sdk/aws-models/kafkaconnect.json @@ -2921,17 +2921,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2945,17 +2934,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2969,17 +2947,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2993,17 +2960,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/kendra.json b/codegen/sdk/aws-models/kendra.json index 8843498634f..8e38892454c 100644 --- a/codegen/sdk/aws-models/kendra.json +++ b/codegen/sdk/aws-models/kendra.json @@ -848,17 +848,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -872,17 +861,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -896,17 +874,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -920,17 +887,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/keyspaces.json b/codegen/sdk/aws-models/keyspaces.json index f4caf69a1c3..991f7b5b572 100644 --- a/codegen/sdk/aws-models/keyspaces.json +++ b/codegen/sdk/aws-models/keyspaces.json @@ -2319,17 +2319,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2343,17 +2332,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2367,17 +2345,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2391,17 +2358,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/keyspacesstreams.json b/codegen/sdk/aws-models/keyspacesstreams.json index 0b8ebb6437b..e11e93c3035 100644 --- a/codegen/sdk/aws-models/keyspacesstreams.json +++ b/codegen/sdk/aws-models/keyspacesstreams.json @@ -892,102 +892,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://cassandra-streams-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://cassandra-streams.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://cassandra-streams-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://cassandra-streams.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://cassandra-streams-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://cassandra-streams.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://cassandra-streams-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://cassandra-streams.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { diff --git a/codegen/sdk/aws-models/kinesis-analytics-v2.json b/codegen/sdk/aws-models/kinesis-analytics-v2.json index f71ca716c46..c1e67759e3d 100644 --- a/codegen/sdk/aws-models/kinesis-analytics-v2.json +++ b/codegen/sdk/aws-models/kinesis-analytics-v2.json @@ -119,7 +119,7 @@ "OperationId": { "target": "com.amazonaws.kinesisanalyticsv2#OperationId", "traits": { - "smithy.api#documentation": "Operation ID for tracking AddApplicationCloudWatchLoggingOption request" + "smithy.api#documentation": "

The operation ID that can be used to track the request.

" } } }, @@ -566,7 +566,7 @@ "OperationId": { "target": "com.amazonaws.kinesisanalyticsv2#OperationId", "traits": { - "smithy.api#documentation": "Operation ID for tracking AddApplicationVpcConfiguration request" + "smithy.api#documentation": "

The operation ID that can be used to track the request.

" } } }, @@ -670,7 +670,10 @@ } }, "ApplicationSystemRollbackConfiguration": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationSystemRollbackConfiguration" + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationSystemRollbackConfiguration", + "traits": { + "smithy.api#documentation": "

Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.

" + } }, "VpcConfigurations": { "target": "com.amazonaws.kinesisanalyticsv2#VpcConfigurations", @@ -683,6 +686,12 @@ "traits": { "smithy.api#documentation": "

The configuration parameters for a Managed Service for Apache Flink Studio notebook.

" } + }, + "ApplicationEncryptionConfiguration": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration to manage encryption at rest.

" + } } }, "traits": { @@ -729,7 +738,10 @@ } }, "ApplicationSystemRollbackConfigurationDescription": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationSystemRollbackConfigurationDescription" + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationSystemRollbackConfigurationDescription", + "traits": { + "smithy.api#documentation": "

Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.

" + } }, "VpcConfigurationDescriptions": { "target": "com.amazonaws.kinesisanalyticsv2#VpcConfigurationDescriptions", @@ -742,6 +754,12 @@ "traits": { "smithy.api#documentation": "

The configuration parameters for a Managed Service for Apache Flink Studio notebook.

" } + }, + "ApplicationEncryptionConfigurationDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationEncryptionConfigurationDescription", + "traits": { + "smithy.api#documentation": "

Describes the encryption at rest configuration.

" + } } }, "traits": { @@ -782,7 +800,10 @@ } }, "ApplicationSystemRollbackConfigurationUpdate": { - "target": "com.amazonaws.kinesisanalyticsv2#ApplicationSystemRollbackConfigurationUpdate" + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationSystemRollbackConfigurationUpdate", + "traits": { + "smithy.api#documentation": "

Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.

" + } }, "VpcConfigurationUpdates": { "target": "com.amazonaws.kinesisanalyticsv2#VpcConfigurationUpdates", @@ -795,6 +816,12 @@ "traits": { "smithy.api#documentation": "

Updates to the configuration of a Managed Service for Apache Flink Studio notebook.

" } + }, + "ApplicationEncryptionConfigurationUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationEncryptionConfigurationUpdate", + "traits": { + "smithy.api#documentation": "

Represents an update for encryption at rest configuration.

" + } } }, "traits": { @@ -905,7 +932,7 @@ "ApplicationVersionCreateTimestamp": { "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", "traits": { - "smithy.api#documentation": "The current timestamp when the application version was created." + "smithy.api#documentation": "

The timestamp that indicates when the application version was created.

" } }, "ConditionalToken": { @@ -931,6 +958,69 @@ "smithy.api#documentation": "

Describes the application, including the application Amazon Resource Name (ARN), status,\n latest version, and input and output configurations.

" } }, + "com.amazonaws.kinesisanalyticsv2#ApplicationEncryptionConfiguration": { + "type": "structure", + "members": { + "KeyId": { + "target": "com.amazonaws.kinesisanalyticsv2#KeyId", + "traits": { + "smithy.api#documentation": "

The key ARN, key ID, alias ARN, or alias name of the KMS key used for encryption at rest.

" + } + }, + "KeyType": { + "target": "com.amazonaws.kinesisanalyticsv2#KeyType", + "traits": { + "smithy.api#documentation": "

Specifies the type of key used for encryption at rest.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the configuration to manage encryption at rest.

" + } + }, + "com.amazonaws.kinesisanalyticsv2#ApplicationEncryptionConfigurationDescription": { + "type": "structure", + "members": { + "KeyId": { + "target": "com.amazonaws.kinesisanalyticsv2#KeyId", + "traits": { + "smithy.api#documentation": "

The key ARN, key ID, alias ARN, or alias name of the KMS key used for encryption at rest.

" + } + }, + "KeyType": { + "target": "com.amazonaws.kinesisanalyticsv2#KeyType", + "traits": { + "smithy.api#documentation": "

Specifies the type of key used for encryption at rest.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the encryption at rest configuration.

" + } + }, + "com.amazonaws.kinesisanalyticsv2#ApplicationEncryptionConfigurationUpdate": { + "type": "structure", + "members": { + "KeyIdUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#KeyId", + "traits": { + "smithy.api#documentation": "

The key ARN, key ID, alias ARN, or alias name of the KMS key to be used for encryption at rest.

" + } + }, + "KeyTypeUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#KeyType", + "traits": { + "smithy.api#documentation": "

Specifies the type of key to be used for encryption at rest.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes configuration updates to encryption at rest.

" + } + }, "com.amazonaws.kinesisanalyticsv2#ApplicationMaintenanceConfigurationDescription": { "type": "structure", "members": { @@ -1008,7 +1098,7 @@ "com.amazonaws.kinesisanalyticsv2#ApplicationName": { "type": "string", "traits": { - "smithy.api#documentation": "The name of the application", + "smithy.api#documentation": "

The name of the application.

", "smithy.api#length": { "min": 1, "max": 128 @@ -1028,13 +1118,13 @@ "StartTime": { "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", "traits": { - "smithy.api#documentation": "The timestamp at which the operation was created" + "smithy.api#documentation": "

The timestamp that indicates when the operation was created.

" } }, "EndTime": { "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", "traits": { - "smithy.api#documentation": "The timestamp at which the operation finished for the application" + "smithy.api#documentation": "

The timestamp that indicates when the operation finished.

" } }, "OperationStatus": { @@ -1042,7 +1132,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides a description of the operation, such as the type and status of operation" + "smithy.api#documentation": "

A description of the aplication operation that provides information about the updates that were made to the application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationOperationInfoDetails": { @@ -1057,14 +1147,14 @@ "StartTime": { "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", "traits": { - "smithy.api#documentation": "The timestamp at which the operation was created", + "smithy.api#documentation": "

The timestamp that indicates when the operation was created.

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", "traits": { - "smithy.api#documentation": "The timestamp at which the operation finished for the application", + "smithy.api#documentation": "

The timestamp that indicates when the operation finished.

", "smithy.api#required": {} } }, @@ -1082,7 +1172,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides a description of the operation, such as the operation-type and status" + "smithy.api#documentation": "

A description of the application operation that provides information about the updates that were made to the application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationOperationInfoList": { @@ -1091,7 +1181,7 @@ "target": "com.amazonaws.kinesisanalyticsv2#ApplicationOperationInfo" }, "traits": { - "smithy.api#documentation": "List of ApplicationOperationInfo for an application" + "smithy.api#documentation": "

A list of ApplicationOperationInfo objects that are associated with an application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationRestoreConfiguration": { @@ -1315,13 +1405,13 @@ "RollbackEnabled": { "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", "traits": { - "smithy.api#documentation": "Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application", + "smithy.api#documentation": "

Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Describes system rollback configuration for a Managed Service for Apache Flink application" + "smithy.api#documentation": "

Describes the system rollback configuration for a Managed Service for Apache Flink application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationSystemRollbackConfigurationDescription": { @@ -1330,13 +1420,13 @@ "RollbackEnabled": { "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", "traits": { - "smithy.api#documentation": "Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application", + "smithy.api#documentation": "

Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Describes system rollback configuration for a Managed Service for Apache Flink application" + "smithy.api#documentation": "

Describes the system rollback configuration for a Managed Service for Apache Flink application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationSystemRollbackConfigurationUpdate": { @@ -1345,13 +1435,13 @@ "RollbackEnabledUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", "traits": { - "smithy.api#documentation": "Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application", + "smithy.api#documentation": "

Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Describes system rollback configuration for a Managed Service for Apache Flink application" + "smithy.api#documentation": "

Describes the system rollback configuration for a Managed Service for Apache Flink application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationVersionChangeDetails": { @@ -1360,20 +1450,20 @@ "ApplicationVersionUpdatedFrom": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", "traits": { - "smithy.api#documentation": "The operation was performed on this version of the application", + "smithy.api#documentation": "

The new version that the application was updated to.

", "smithy.api#required": {} } }, "ApplicationVersionUpdatedTo": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", "traits": { - "smithy.api#documentation": "The operation execution resulted in the transition to the following version of the application", + "smithy.api#documentation": "

The version that the operation execution applied to the applicartion.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains information about the application version changes due to an operation" + "smithy.api#documentation": "

Contains information about the version changes that the operation applied to the application.

" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId": { @@ -1554,12 +1644,12 @@ "MinPauseBetweenCheckpoints": { "target": "com.amazonaws.kinesisanalyticsv2#MinPauseBetweenCheckpoints", "traits": { - "smithy.api#documentation": "

Describes the minimum time in milliseconds after a checkpoint operation completes that a\n new checkpoint operation can start. If a checkpoint operation takes longer than the\n CheckpointInterval, the application otherwise performs continual checkpoint\n operations. For more information, see Tuning Checkpointing in the Apache Flink\n Documentation.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this \n API or in application code.

\n
" + "smithy.api#documentation": "

Describes the minimum time in milliseconds after a checkpoint operation completes that a\n new checkpoint operation can start. If a checkpoint operation takes longer than the\n CheckpointInterval, the application otherwise performs continual checkpoint\n operations. For more information, see Tuning Checkpointing in the Apache Flink\n Documentation.

\n \n

If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this \n API or in application code.

\n
" } } }, "traits": { - "smithy.api#documentation": "

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault \n tolerance.\n For more information, see \n \n Checkpoints for Fault Tolerance in the\n Apache Flink Documentation.

" + "smithy.api#documentation": "

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault \n tolerance.\n For more information, see \n \n Checkpoints for Fault Tolerance in the\n Apache Flink Documentation.

" } }, "com.amazonaws.kinesisanalyticsv2#CheckpointConfigurationDescription": { @@ -2330,7 +2420,7 @@ "OperationId": { "target": "com.amazonaws.kinesisanalyticsv2#OperationId", "traits": { - "smithy.api#documentation": "Operation ID for tracking DeleteApplicationCloudWatchLoggingOption request" + "smithy.api#documentation": "

The operation ID that can be used to track the request.

" } } }, @@ -2750,7 +2840,7 @@ "OperationId": { "target": "com.amazonaws.kinesisanalyticsv2#OperationId", "traits": { - "smithy.api#documentation": "Operation ID for tracking DeleteApplicationVpcConfiguration request" + "smithy.api#documentation": "

The operation ID that can be used to track the request.

" } } }, @@ -2845,7 +2935,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about a specific operation performed on a Managed Service for Apache Flink application" + "smithy.api#documentation": "

Provides a detailed description of a specified application operation. To see a list of all the operations of an application, invoke the ListApplicationOperations operation.

\n \n

This operation is supported only for Managed Service for Apache Flink.

\n
" } }, "com.amazonaws.kinesisanalyticsv2#DescribeApplicationOperationRequest": { @@ -2865,7 +2955,7 @@ } }, "traits": { - "smithy.api#documentation": "Request for information about a specific operation performed on a Managed Service for Apache Flink application", + "smithy.api#documentation": "

A request for information about a specific operation that was performed on a Managed Service for Apache Flink application.

", "smithy.api#input": {} } }, @@ -2877,7 +2967,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides details of the operation corresponding to the operation-ID on a Managed Service for Apache Flink application", + "smithy.api#documentation": "

Provides details of the operation that corresponds to the operation ID on a Managed Service for Apache Flink application.

", "smithy.api#output": {} } }, @@ -3203,7 +3293,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides a description of the operation failure error" + "smithy.api#documentation": "

A description of the error that caused an operation to fail.

" } }, "com.amazonaws.kinesisanalyticsv2#ErrorMessage": { @@ -3212,7 +3302,7 @@ "com.amazonaws.kinesisanalyticsv2#ErrorString": { "type": "string", "traits": { - "smithy.api#documentation": "Error message resulting in failure of the operation", + "smithy.api#documentation": "

An error message that is returned when an operation fails.

", "smithy.api#length": { "min": 1, "max": 512 @@ -3234,7 +3324,7 @@ "CheckpointConfiguration": { "target": "com.amazonaws.kinesisanalyticsv2#CheckpointConfiguration", "traits": { - "smithy.api#documentation": "

Describes an application's checkpointing configuration. Checkpointing is the \n process of persisting application state for fault tolerance.\n For more information, see \n \n Checkpoints for Fault Tolerance in the \n Apache Flink Documentation.

" + "smithy.api#documentation": "

Describes an application's checkpointing configuration. Checkpointing is the \n process of persisting application state for fault tolerance.\n For more information, see \n \n Checkpoints for Fault Tolerance in the \n Apache Flink Documentation.

" } }, "MonitoringConfiguration": { @@ -3278,7 +3368,7 @@ "JobPlanDescription": { "target": "com.amazonaws.kinesisanalyticsv2#JobPlanDescription", "traits": { - "smithy.api#documentation": "

The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink\n Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.

" + "smithy.api#documentation": "

The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink\n Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.

" } } }, @@ -3318,7 +3408,7 @@ "AllowNonRestoredState": { "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", "traits": { - "smithy.api#documentation": "

When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot \n be mapped to the new program.\n This will happen if the program is updated between snapshots to remove stateful parameters, and \n state data in the snapshot no longer \n corresponds to valid application data. For more information, see \n \n Allowing Non-Restored State in the Apache Flink\n documentation.

\n \n

This value defaults to false. If you update your application without\n specifying this parameter, AllowNonRestoredState will be set to false,\n even if it was previously set to true.

\n
" + "smithy.api#documentation": "

When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot \n be mapped to the new program.\n This will happen if the program is updated between snapshots to remove stateful parameters, and \n state data in the snapshot no longer \n corresponds to valid application data. For more information, see \n \n Allowing Non-Restored State in the Apache Flink\n documentation.

\n \n

This value defaults to false. If you update your application without\n specifying this parameter, AllowNonRestoredState will be set to false,\n even if it was previously set to true.

\n
" } } }, @@ -3833,6 +3923,32 @@ "com.amazonaws.kinesisanalyticsv2#JobPlanDescription": { "type": "string" }, + "com.amazonaws.kinesisanalyticsv2#KeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.kinesisanalyticsv2#KeyType": { + "type": "enum", + "members": { + "AWS_OWNED_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_OWNED_KEY" + } + }, + "CUSTOMER_MANAGED_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_MANAGED_KEY" + } + } + } + }, "com.amazonaws.kinesisanalyticsv2#KinesisAnalyticsARN": { "type": "string", "traits": { @@ -4723,17 +4839,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4747,17 +4852,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4771,17 +4865,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4795,17 +4878,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5168,7 +5240,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists information about operations performed on a Managed Service for Apache Flink application", + "smithy.api#documentation": "

Lists all the operations performed for the specified application such as UpdateApplication, StartApplication etc.\n The response also includes a summary of the operation.

\n

To get the complete description of a specific operation, invoke the DescribeApplicationOperation operation.

\n \n

This operation is supported only for Managed Service for Apache Flink.

\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5180,7 +5252,7 @@ "com.amazonaws.kinesisanalyticsv2#ListApplicationOperationsInputLimit": { "type": "integer", "traits": { - "smithy.api#documentation": "Limit on the number of records returned in the response", + "smithy.api#documentation": "

The limit on the number of records to be returned in the response.

", "smithy.api#range": { "min": 1, "max": 50 @@ -5210,7 +5282,7 @@ } }, "traits": { - "smithy.api#documentation": "Request to list operations performed on an application", + "smithy.api#documentation": "

A request for a list of operations performed on an application.

", "smithy.api#input": {} } }, @@ -5225,7 +5297,7 @@ } }, "traits": { - "smithy.api#documentation": "Response with the list of operations for an application", + "smithy.api#documentation": "

A response that returns a list of operations for an application.

", "smithy.api#output": {} } }, @@ -5758,7 +5830,7 @@ "com.amazonaws.kinesisanalyticsv2#NextToken": { "type": "string", "traits": { - "smithy.api#documentation": "If a previous command returned a pagination token, pass it into this value to retrieve the next set of results", + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", "smithy.api#length": { "min": 1, "max": 512 @@ -5777,7 +5849,7 @@ "com.amazonaws.kinesisanalyticsv2#Operation": { "type": "string", "traits": { - "smithy.api#documentation": "Type of operation performed on an application", + "smithy.api#documentation": "

The type of operation that is performed on an application.

", "smithy.api#length": { "min": 1, "max": 64 @@ -5790,7 +5862,7 @@ "RollbackOperationId": { "target": "com.amazonaws.kinesisanalyticsv2#OperationId", "traits": { - "smithy.api#documentation": "Provides the operation ID of a system-rollback operation executed due to failure in the current operation" + "smithy.api#documentation": "

The rollback operation ID of the system-rollback operation that executed due to failure in the current operation.

" } }, "ErrorInfo": { @@ -5798,13 +5870,13 @@ } }, "traits": { - "smithy.api#documentation": "Provides a description of the operation failure" + "smithy.api#documentation": "

Provides a description of the operation failure.

" } }, "com.amazonaws.kinesisanalyticsv2#OperationId": { "type": "string", "traits": { - "smithy.api#documentation": "Identifier of the Operation", + "smithy.api#documentation": "

The operation ID of the request.

", "smithy.api#length": { "min": 1, "max": 64 @@ -5840,7 +5912,7 @@ } }, "traits": { - "smithy.api#documentation": "Status of the operation performed on an application" + "smithy.api#documentation": "

The status of the operation.

" } }, "com.amazonaws.kinesisanalyticsv2#Output": { @@ -6011,7 +6083,7 @@ "Parallelism": { "target": "com.amazonaws.kinesisanalyticsv2#Parallelism", "traits": { - "smithy.api#documentation": "

Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If AutoScalingEnabled \n is set to True, Managed Service for Apache Flink increases the CurrentParallelism value in response to application\n load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is \n ParalellismPerKPU times the maximum KPUs for the application. \n The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If \n application load is reduced, the service can\n reduce the CurrentParallelism value down to the Parallelism setting.

" + "smithy.api#documentation": "

Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If\n AutoScalingEnabled is set to True, Managed Service for Apache Flink increases the\n CurrentParallelism value in response to application load. The service can\n increase the CurrentParallelism value up to the maximum parallelism, which is\n ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs\n for an application is 64 by default, and can be increased by requesting a limit increase. If\n application load is reduced, the service can reduce the CurrentParallelism value\n down to the Parallelism setting.

" } }, "ParallelismPerKPU": { @@ -6028,7 +6100,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes parameters for how a Managed Service for Apache Flink application\n executes multiple tasks simultaneously. For more information about parallelism,\n see Parallel Execution in the Apache Flink\n Documentation.

" + "smithy.api#documentation": "

Describes parameters for how a Managed Service for Apache Flink application\n executes multiple tasks simultaneously. For more information about parallelism,\n see Parallel Execution in the Apache Flink\n Documentation.

" } }, "com.amazonaws.kinesisanalyticsv2#ParallelismConfigurationDescription": { @@ -6043,7 +6115,7 @@ "Parallelism": { "target": "com.amazonaws.kinesisanalyticsv2#Parallelism", "traits": { - "smithy.api#documentation": "

Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. \n If AutoScalingEnabled is set to True, then Managed Service for Apache Flink can increase the CurrentParallelism value in response to application\n load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. \n The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can\n reduce the CurrentParallelism value down to the Parallelism setting.

" + "smithy.api#documentation": "

Describes the initial number of parallel tasks that a Managed Service for Apache Flink application can perform. If\n AutoScalingEnabled is set to True, then Managed Service for Apache Flink can increase the\n CurrentParallelism value in response to application load. The service can\n increase CurrentParallelism up to the maximum parallelism, which is\n ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs\n for an application is 64 by default, and can be increased by requesting a limit increase. If\n application load is reduced, the service can reduce the CurrentParallelism value\n down to the Parallelism setting.

" } }, "ParallelismPerKPU": { @@ -6589,7 +6661,7 @@ "OperationId": { "target": "com.amazonaws.kinesisanalyticsv2#OperationId", "traits": { - "smithy.api#documentation": "Operation ID for tracking RollbackApplication request" + "smithy.api#documentation": "

The operation ID that can be used to track the request.

" } } }, @@ -7043,6 +7115,12 @@ "traits": { "smithy.api#documentation": "

The Flink Runtime for the application snapshot.

" } + }, + "ApplicationEncryptionConfigurationDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationEncryptionConfigurationDescription", + "traits": { + "smithy.api#documentation": "

Specifies the encryption settings of data at rest for the application snapshot.

" + } } }, "traits": { @@ -7284,7 +7362,7 @@ "OperationId": { "target": "com.amazonaws.kinesisanalyticsv2#OperationId", "traits": { - "smithy.api#documentation": "Operation ID for tracking StartApplication request" + "smithy.api#documentation": "

The operation ID that can be used to track the request.

" } } }, @@ -7351,7 +7429,7 @@ "OperationId": { "target": "com.amazonaws.kinesisanalyticsv2#OperationId", "traits": { - "smithy.api#documentation": "Operation ID for tracking StopApplication request" + "smithy.api#documentation": "

The operation ID that can be used to track the request.

" } } }, @@ -7792,7 +7870,7 @@ "OperationId": { "target": "com.amazonaws.kinesisanalyticsv2#OperationId", "traits": { - "smithy.api#documentation": "Operation ID for tracking UpdateApplication request" + "smithy.api#documentation": "

The operation ID that can be used to track the request.

" } } }, diff --git a/codegen/sdk/aws-models/kinesis-analytics.json b/codegen/sdk/aws-models/kinesis-analytics.json index 161e29d25df..6a38a93aa4d 100644 --- a/codegen/sdk/aws-models/kinesis-analytics.json +++ b/codegen/sdk/aws-models/kinesis-analytics.json @@ -2702,17 +2702,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2726,17 +2715,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2750,17 +2728,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2774,17 +2741,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/kinesis-video-archived-media.json b/codegen/sdk/aws-models/kinesis-video-archived-media.json index f52422cfb57..b216ff22e6f 100644 --- a/codegen/sdk/aws-models/kinesis-video-archived-media.json +++ b/codegen/sdk/aws-models/kinesis-video-archived-media.json @@ -733,17 +733,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -757,17 +746,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -781,17 +759,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -805,17 +772,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/kinesis-video-media.json b/codegen/sdk/aws-models/kinesis-video-media.json index de554e72cd8..24c92d928ca 100644 --- a/codegen/sdk/aws-models/kinesis-video-media.json +++ b/codegen/sdk/aws-models/kinesis-video-media.json @@ -718,17 +718,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -742,17 +731,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -766,17 +744,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -790,17 +757,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/kinesis-video-signaling.json b/codegen/sdk/aws-models/kinesis-video-signaling.json index 793406e6bb2..b3ed8640bbd 100644 --- a/codegen/sdk/aws-models/kinesis-video-signaling.json +++ b/codegen/sdk/aws-models/kinesis-video-signaling.json @@ -721,17 +721,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -745,17 +734,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -769,17 +747,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -793,17 +760,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/kinesis-video-webrtc-storage.json b/codegen/sdk/aws-models/kinesis-video-webrtc-storage.json index 7f9e198c024..c8768a8f820 100644 --- a/codegen/sdk/aws-models/kinesis-video-webrtc-storage.json +++ b/codegen/sdk/aws-models/kinesis-video-webrtc-storage.json @@ -544,17 +544,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -568,17 +557,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -592,17 +570,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -616,17 +583,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/kinesis-video.json b/codegen/sdk/aws-models/kinesis-video.json index 00b2eaf395d..64781c286f7 100644 --- a/codegen/sdk/aws-models/kinesis-video.json +++ b/codegen/sdk/aws-models/kinesis-video.json @@ -2507,17 +2507,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2531,17 +2520,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2555,17 +2533,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2579,17 +2546,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/kinesis.json b/codegen/sdk/aws-models/kinesis.json index d18cf40f687..e30bf4547f8 100644 --- a/codegen/sdk/aws-models/kinesis.json +++ b/codegen/sdk/aws-models/kinesis.json @@ -4177,17 +4177,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4201,17 +4190,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4225,17 +4203,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4249,17 +4216,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -4427,19 +4383,6 @@ "StreamARN": "arn:aws:kinesis:us-east-1:123:accesspoint/testStream" } }, - { - "documentation": "Dual Stack not supported region.", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-west-1", - "UseFIPS": true, - "UseDualStack": true, - "StreamARN": "arn:aws-iso:kinesis:us-iso-west-1:123456789012:stream/testStream", - "OperationType": "control" - } - }, { "documentation": "OperationType not set", "expect": { @@ -4803,19 +4746,6 @@ "ConsumerARN": "arn:aws:kinesis:us-east-1:123:accesspoint/testStream/consumer/test-consumer:1525898737" } }, - { - "documentation": "Dual Stack not supported region.", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-west-1", - "UseFIPS": true, - "UseDualStack": true, - "ConsumerARN": "arn:aws-iso:kinesis:us-iso-west-1:123456789012:stream/testStream/consumer/test-consumer:1525898737", - "OperationType": "control" - } - }, { "documentation": "OperationType not set", "expect": { @@ -5210,19 +5140,6 @@ "ResourceARN": "arn:aws:kinesis:us-east-1:123:accesspoint/testStream" } }, - { - "documentation": "ResourceARN as StreamARN test: Dual Stack not supported region.", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-west-1", - "UseFIPS": true, - "UseDualStack": true, - "ResourceARN": "arn:aws-iso:kinesis:us-iso-west-1:123456789012:stream/testStream", - "OperationType": "control" - } - }, { "documentation": "ResourceARN as StreamARN test: OperationType not set", "expect": { @@ -5574,19 +5491,6 @@ "ResourceARN": "arn:aws:kinesis:us-east-1:123:accesspoint/testStream/consumer/test-consumer:1525898737" } }, - { - "documentation": "ResourceARN as ConsumerARN test: Dual Stack not supported region.", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-west-1", - "UseFIPS": true, - "UseDualStack": true, - "ResourceARN": "arn:aws-iso:kinesis:us-iso-west-1:123456789012:stream/testStream/consumer/test-consumer:1525898737", - "OperationType": "control" - } - }, { "documentation": "ResourceARN as ConsumerARN test: OperationType not set", "expect": { diff --git a/codegen/sdk/aws-models/kms.json b/codegen/sdk/aws-models/kms.json index 3d799c399b0..a270bb7af8c 100644 --- a/codegen/sdk/aws-models/kms.json +++ b/codegen/sdk/aws-models/kms.json @@ -646,7 +646,7 @@ "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\n must 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": {} } } @@ -1027,7 +1027,7 @@ "KeyUsage": { "target": "com.amazonaws.kms#KeyUsageType", "traits": { - "smithy.api#documentation": "

Determines the cryptographic operations for which you can use the KMS key. The default value is\n ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric\n encryption KMS key; otherwise, it is required. You can't change the KeyUsage\n value after the KMS key is created.

\n

Select only one valid value.

\n
    \n
  • \n

    For symmetric encryption KMS keys, omit the parameter or specify\n ENCRYPT_DECRYPT.

    \n
  • \n
  • \n

    For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.

    \n
  • \n
  • \n

    For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or\n SIGN_VERIFY.

    \n
  • \n
  • \n

    For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify\n SIGN_VERIFY or KEY_AGREEMENT.

    \n
  • \n
  • \n

    For asymmetric KMS keys with ECC_SECG_P256K1 key pairs, specify\n SIGN_VERIFY.

    \n
  • \n
  • \n

    For asymmetric KMS keys with ML-DSA key pairs, specify\n SIGN_VERIFY.

    \n
  • \n
  • \n

    For asymmetric KMS keys with SM2 key pairs (China Regions only), specify\n ENCRYPT_DECRYPT, SIGN_VERIFY, or\n KEY_AGREEMENT.

    \n
  • \n
" + "smithy.api#documentation": "

Determines the cryptographic operations for which you can use the KMS key. The default value is\n ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric\n encryption KMS key; otherwise, it is required. You can't change the \n KeyUsage\n value after the KMS key is created. Each KMS key can have\n only one key usage. This follows key usage best practices according to NIST SP 800-57 Recommendations for\n Key Management, section 5.2, Key usage.

\n

Select only one valid value.

\n
    \n
  • \n

    For symmetric encryption KMS keys, omit the parameter or specify\n ENCRYPT_DECRYPT.

    \n
  • \n
  • \n

    For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.

    \n
  • \n
  • \n

    For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or\n SIGN_VERIFY.

    \n
  • \n
  • \n

    For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify\n SIGN_VERIFY or KEY_AGREEMENT.

    \n
  • \n
  • \n

    For asymmetric KMS keys with ECC_SECG_P256K1 key pairs, specify\n SIGN_VERIFY.

    \n
  • \n
  • \n

    For asymmetric KMS keys with ML-DSA key pairs, specify\n SIGN_VERIFY.

    \n
  • \n
  • \n

    For asymmetric KMS keys with SM2 key pairs (China Regions only), specify\n ENCRYPT_DECRYPT, SIGN_VERIFY, or\n KEY_AGREEMENT.

    \n
  • \n
" } }, "CustomerMasterKeySpec": { @@ -1477,7 +1477,7 @@ } ], "traits": { - "smithy.api#documentation": "

Decrypts ciphertext that was encrypted by a KMS key using any of the following\n operations:

\n \n

You can use this operation to decrypt ciphertext that was encrypted under a symmetric\n encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you\n must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext.\n For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

The Decrypt operation also decrypts ciphertext that was encrypted outside of\n KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric\n ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption.\n These libraries return a ciphertext format that is incompatible with KMS.

\n

If the ciphertext was encrypted under a symmetric encryption KMS key, the\n KeyId parameter is optional. KMS can get this information from metadata that\n it adds to the symmetric ciphertext blob. This feature adds durability to your implementation\n by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even\n if they've lost track of the key ID. However, specifying the KMS key is always recommended as\n a best practice. When you use the KeyId parameter to specify a KMS key, KMS\n only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key,\n the Decrypt operation fails. This practice ensures that you use the KMS key that\n you intend.

\n

Whenever possible, use key policies to give users permission to call the\n Decrypt operation on a particular KMS key, instead of using IAM policies.\n Otherwise, you might create an IAM policy that gives the user Decrypt\n permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys\n in other accounts if the key policy for the cross-account KMS key permits it. If you must use\n an IAM policy for Decrypt permissions, limit the user to particular KMS keys or\n particular trusted accounts. For details, see Best practices for IAM\n policies in the Key Management Service Developer Guide.

\n

\n Decrypt also supports Amazon Web Services Nitro Enclaves, which provide an\n isolated compute environment in Amazon EC2. To call Decrypt for a Nitro enclave, use\n the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient parameter to provide the\n attestation document for the enclave. Instead of the plaintext data, the response includes the\n plaintext data encrypted with the public key from the attestation document\n (CiphertextForRecipient). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

\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: Yes. If you use the KeyId\n parameter to identify a KMS key in a different Amazon Web Services account, specify the key ARN or the alias\n ARN of the KMS key.

\n

\n Required permissions: kms:Decrypt (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": "

Decrypts ciphertext that was encrypted by a KMS key using any of the following\n operations:

\n \n

You can use this operation to decrypt ciphertext that was encrypted under a symmetric\n encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you\n must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext.\n For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

The Decrypt operation also decrypts ciphertext that was encrypted outside of\n KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric\n ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption.\n These libraries return a ciphertext format that is incompatible with KMS.

\n

If the ciphertext was encrypted under a symmetric encryption KMS key, the\n KeyId parameter is optional. KMS can get this information from metadata that\n it adds to the symmetric ciphertext blob. This feature adds durability to your implementation\n by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even\n if they've lost track of the key ID. However, specifying the KMS key is always recommended as\n a best practice. When you use the KeyId parameter to specify a KMS key, KMS\n only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key,\n the Decrypt operation fails. This practice ensures that you use the KMS key that\n you intend.

\n

Whenever possible, use key policies to give users permission to call the\n Decrypt operation on a particular KMS key, instead of using IAM policies.\n Otherwise, you might create an IAM policy that gives the user Decrypt\n permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys\n in other accounts if the key policy for the cross-account KMS key permits it. If you must use\n an IAM policy for Decrypt permissions, limit the user to particular KMS keys or\n particular trusted accounts. For details, see Best practices for IAM\n policies in the Key Management Service Developer Guide.

\n

\n Decrypt also supports Amazon Web Services Nitro Enclaves and NitroTPM, which provide \n attested environments in Amazon EC2. To call Decrypt for a Nitro enclave or NitroTPM, use\n the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient parameter to provide the\n attestation document for the attested environment. Instead of the plaintext data, the response \n includes the plaintext data encrypted with the public key from the attestation document\n (CiphertextForRecipient). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

\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: Yes. If you use the KeyId\n parameter to identify a KMS key in a different Amazon Web Services account, specify the key ARN or the alias\n ARN of the KMS key.

\n

\n Required permissions: kms:Decrypt (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 decrypt data with an asymmetric encryption KMS key", @@ -1547,7 +1547,7 @@ "Recipient": { "target": "com.amazonaws.kms#RecipientInfo", "traits": { - "smithy.api#documentation": "

A signed attestation\n document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the\n enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

\n

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this\n parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

\n

When you use this parameter, instead of returning the plaintext data, KMS encrypts the\n plaintext data with the public key in the attestation document, and returns the resulting\n ciphertext in the CiphertextForRecipient field in the response. This ciphertext\n can be decrypted only with the private key in the enclave. The Plaintext field in\n the response is null or empty.

\n

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A signed attestation\n document from an Amazon Web Services Nitro enclave or NitroTPM, and the encryption algorithm to use with the\n public key in the attestation document. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

\n

This parameter supports the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK for Amazon Web Services Nitro Enclaves. It supports \n any Amazon Web Services SDK for Amazon Web Services NitroTPM.\n

\n

When you use this parameter, instead of returning the plaintext data, KMS encrypts the\n plaintext data with the public key in the attestation document, and returns the resulting\n ciphertext in the CiphertextForRecipient field in the response. This ciphertext\n can be decrypted only with the private key in the attested environment. The Plaintext field in\n the response is null or empty.

\n

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

" } }, "DryRun": { @@ -1585,7 +1585,7 @@ "CiphertextForRecipient": { "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

The plaintext data encrypted with the public key in the attestation document.

\n

This field is included in the response only when the Recipient parameter in\n the request includes a valid attestation document from an Amazon Web Services Nitro enclave.\n For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The plaintext data encrypted with the public key from the attestation document. This\n ciphertext can be decrypted only by using a private key from the attested environment.

\n

This field is included in the response only when the Recipient parameter in\n the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM.\n For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

" } }, "KeyMaterialId": { @@ -1845,7 +1845,7 @@ } ], "traits": { - "smithy.api#documentation": "

Derives a shared secret using a key agreement algorithm.

\n \n

You must use an asymmetric NIST-recommended elliptic curve (ECC) or SM2 (China Regions\n only) KMS key pair with a KeyUsage value of KEY_AGREEMENT to call\n DeriveSharedSecret.

\n
\n

DeriveSharedSecret uses the Elliptic Curve Cryptography Cofactor Diffie-Hellman Primitive (ECDH) to establish a\n key agreement between two peers by deriving a shared secret from their elliptic curve\n public-private key pairs. You can use the raw shared secret that DeriveSharedSecret returns to\n derive a symmetric key that can encrypt and decrypt data that is sent between the two peers,\n or that can generate and verify HMACs. KMS recommends that you follow NIST\n recommendations for key derivation when using the raw shared secret to derive a\n symmetric key.

\n

The following workflow demonstrates how to establish key agreement over an insecure\n communication channel using DeriveSharedSecret.

\n
    \n
  1. \n

    \n Alice calls CreateKey to create an\n asymmetric KMS key pair with a KeyUsage value of\n KEY_AGREEMENT.

    \n

    The asymmetric KMS key must use a NIST-recommended elliptic curve (ECC) or SM2 (China\n Regions only) key spec.

    \n
  2. \n
  3. \n

    \n Bob creates an elliptic curve key pair.

    \n

    Bob can call CreateKey to create an asymmetric KMS key pair or\n generate a key pair outside of KMS. Bob's key pair must use the same NIST-recommended\n elliptic curve (ECC) or SM2 (China Regions ony) curve as Alice.

    \n
  4. \n
  5. \n

    Alice and Bob exchange their public keys through an\n insecure communication channel (like the internet).

    \n

    Use GetPublicKey to download the public key of your asymmetric KMS\n key pair.

    \n \n

    KMS strongly recommends verifying that the public key you receive came from the\n expected party before using it to derive a shared secret.

    \n
    \n
  6. \n
  7. \n

    \n Alice calls DeriveSharedSecret.

    \n

    KMS uses the private key from the KMS key pair generated in Step 1, Bob's public key, and the Elliptic Curve Cryptography Cofactor\n Diffie-Hellman Primitive to derive the shared secret. The private key in your KMS key pair\n never leaves KMS unencrypted. DeriveSharedSecret returns the raw shared secret.

    \n
  8. \n
  9. \n

    \n Bob uses the Elliptic Curve Cryptography Cofactor\n Diffie-Hellman Primitive to calculate the same raw secret using his private key and\n Alice's public key.

    \n
  10. \n
\n

To derive a shared secret you must provide a key agreement algorithm, the private key of\n the caller's asymmetric NIST-recommended elliptic curve or SM2 (China Regions only) KMS key\n pair, and the public key from your peer's NIST-recommended elliptic curve or SM2 (China\n Regions only) key pair. The public key can be from another asymmetric KMS key pair or from a\n key pair generated outside of KMS, but both key pairs must be on the same elliptic\n curve.

\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: 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:DeriveSharedSecret (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": "

Derives a shared secret using a key agreement algorithm.

\n \n

You must use an asymmetric NIST-recommended elliptic curve (ECC) or SM2 (China Regions\n only) KMS key pair with a KeyUsage\n value of KEY_AGREEMENT to call DeriveSharedSecret.

\n
\n

DeriveSharedSecret uses the Elliptic Curve Cryptography Cofactor Diffie-Hellman Primitive (ECDH) to establish a\n key agreement between two peers by deriving a shared secret from their elliptic curve\n public-private key pairs. You can use the raw shared secret that DeriveSharedSecret returns to\n derive a symmetric key that can encrypt and decrypt data that is sent between the two peers,\n or that can generate and verify HMACs. KMS recommends that you follow NIST\n recommendations for key derivation when using the raw shared secret to derive a\n symmetric key.

\n

The following workflow demonstrates how to establish key agreement over an insecure\n communication channel using DeriveSharedSecret.

\n
    \n
  1. \n

    \n Alice calls CreateKey to create an\n asymmetric KMS key pair with a KeyUsage value of\n KEY_AGREEMENT.

    \n

    The asymmetric KMS key must use a NIST-recommended elliptic curve (ECC) or SM2 (China\n Regions only) key spec.

    \n
  2. \n
  3. \n

    \n Bob creates an elliptic curve key pair.

    \n

    Bob can call CreateKey to create an asymmetric KMS key pair or\n generate a key pair outside of KMS. Bob's key pair must use the same NIST-recommended\n elliptic curve (ECC) or SM2 (China Regions ony) curve as Alice.

    \n
  4. \n
  5. \n

    Alice and Bob exchange their public keys through an\n insecure communication channel (like the internet).

    \n

    Use GetPublicKey to download the public key of your asymmetric KMS\n key pair.

    \n \n

    KMS strongly recommends verifying that the public key you receive came from the\n expected party before using it to derive a shared secret.

    \n
    \n
  6. \n
  7. \n

    \n Alice calls DeriveSharedSecret.

    \n

    KMS uses the private key from the KMS key pair generated in Step 1, Bob's public key, and the Elliptic Curve Cryptography Cofactor\n Diffie-Hellman Primitive to derive the shared secret. The private key in your KMS key pair\n never leaves KMS unencrypted. DeriveSharedSecret returns the raw shared secret.

    \n
  8. \n
  9. \n

    \n Bob uses the Elliptic Curve Cryptography Cofactor\n Diffie-Hellman Primitive to calculate the same raw secret using his private key and\n Alice's public key.

    \n
  10. \n
\n

To derive a shared secret you must provide a key agreement algorithm, the private key of\n the caller's asymmetric NIST-recommended elliptic curve or SM2 (China Regions only) KMS key\n pair, and the public key from your peer's NIST-recommended elliptic curve or SM2 (China\n Regions only) key pair. The public key can be from another asymmetric KMS key pair or from a\n key pair generated outside of KMS, but both key pairs must be on the same elliptic\n curve.

\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: 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:DeriveSharedSecret (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 derive a shared secret", @@ -1904,7 +1904,7 @@ "Recipient": { "target": "com.amazonaws.kms#RecipientInfo", "traits": { - "smithy.api#documentation": "

A signed attestation document from\n an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The\n only valid encryption algorithm is RSAES_OAEP_SHA_256.

\n

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To call\n DeriveSharedSecret for an Amazon Web Services Nitro Enclaves, use the Amazon Web Services Nitro Enclaves SDK to generate the\n attestation document and then use the Recipient parameter from any Amazon Web Services SDK to provide the\n attestation document for the enclave.

\n

When you use this parameter, instead of returning a plaintext copy of the shared secret,\n KMS encrypts the plaintext shared secret under the public key in the attestation document,\n and returns the resulting ciphertext in the CiphertextForRecipient field in the\n response. This ciphertext can be decrypted only with the private key in the enclave. The\n CiphertextBlob field in the response contains the encrypted shared secret\n derived from the KMS key specified by the KeyId parameter and public key\n specified by the PublicKey parameter. The SharedSecret field in the\n response is null or empty.

\n

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A signed attestation document from\n an Amazon Web Services Nitro enclave or NitroTPM, and the encryption algorithm to use with the public key in the attestation document. The\n only valid encryption algorithm is RSAES_OAEP_SHA_256.

\n

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM. To call\n DeriveSharedSecret generate an attestation document use either Amazon Web Services Nitro Enclaves SDK for an Amazon Web Services Nitro Enclaves or\n Amazon Web Services NitroTPM tools for Amazon Web Services NitroTPM. Then use the Recipient parameter from any Amazon Web Services SDK to provide the\n attestation document for the attested environment.

\n

When you use this parameter, instead of returning a plaintext copy of the shared secret,\n KMS encrypts the plaintext shared secret under the public key in the attestation document,\n and returns the resulting ciphertext in the CiphertextForRecipient field in the\n response. This ciphertext can be decrypted only with the private key in the attested environment. The\n CiphertextBlob field in the response contains the encrypted shared secret\n derived from the KMS key specified by the KeyId parameter and public key\n specified by the PublicKey parameter. The SharedSecret field in the\n response is null or empty.

\n

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

" } } }, @@ -1930,7 +1930,7 @@ "CiphertextForRecipient": { "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

The plaintext shared secret encrypted with the public key in the attestation\n document.

\n

This field is included in the response only when the Recipient parameter in\n the request includes a valid attestation document from an Amazon Web Services Nitro enclave.\n For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The plaintext shared secret encrypted with the public key from the attestation document. This\n ciphertext can be decrypted only by using a private key from the attested environment.

\n

This field is included in the response only when the Recipient parameter in\n the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM.\n For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

" } }, "KeyAgreementAlgorithm": { @@ -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\n managed 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 KeyId and Arn in the\n 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": {} } }, @@ -2875,7 +2875,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a unique symmetric data key for use outside of KMS. This operation returns a\n plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS\n key that you specify. The bytes in the plaintext key are random; they are not related to the\n caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and\n store the encrypted data key with the encrypted data.

\n

To generate a data key, specify the symmetric encryption KMS key that will be used to\n encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the\n type of your KMS key, use the DescribeKey operation.

\n

You must also specify the length of the data key. Use either the KeySpec or\n NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use\n the KeySpec parameter.

\n

To generate a 128-bit SM4 data key (China Regions only), specify a KeySpec\n value of AES_128 or a NumberOfBytes value of 16. The\n symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption\n key.

\n

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use\n the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure\n random byte string, use GenerateRandom.

\n

You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

\n GenerateDataKey also supports Amazon Web Services Nitro Enclaves, which provide an\n isolated compute environment in Amazon EC2. To call GenerateDataKey for an Amazon Web Services Nitro\n enclave, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient parameter\n to provide the attestation document for the enclave. GenerateDataKey returns a\n copy of the data key encrypted under the specified KMS key, as usual. But instead of a\n plaintext copy of the data key, the response includes a copy of the data key encrypted under\n the public key from the attestation document (CiphertextForRecipient).\n For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide..

\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 How to use your data key\n

\n

We recommend that you use the following pattern to encrypt data locally in your\n application. You can write your own code or use a client-side encryption library, such as the\n Amazon Web Services Encryption SDK, the\n Amazon DynamoDB Encryption Client,\n or Amazon S3\n client-side encryption to do these tasks for you.

\n

To encrypt data outside of KMS:

\n
    \n
  1. \n

    Use the GenerateDataKey operation to get a data key.

    \n
  2. \n
  3. \n

    Use the plaintext data key (in the Plaintext field of the response) to\n encrypt your data outside of KMS. Then erase the plaintext data key from memory.

    \n
  4. \n
  5. \n

    Store the encrypted data key (in the CiphertextBlob field of the\n response) with the encrypted data.

    \n
  6. \n
\n

To decrypt data outside of KMS:

\n
    \n
  1. \n

    Use the Decrypt operation to decrypt the encrypted data key. The\n operation returns a plaintext copy of the data key.

    \n
  2. \n
  3. \n

    Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext\n data key from memory.

    \n
  4. \n
\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:GenerateDataKey (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": "

Returns a unique symmetric data key for use outside of KMS. This operation returns a\n plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS\n key that you specify. The bytes in the plaintext key are random; they are not related to the\n caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and\n store the encrypted data key with the encrypted data.

\n

To generate a data key, specify the symmetric encryption KMS key that will be used to\n encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the\n type of your KMS key, use the DescribeKey operation.

\n

You must also specify the length of the data key. Use either the KeySpec or\n NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use\n the KeySpec parameter.

\n

To generate a 128-bit SM4 data key (China Regions only), specify a KeySpec\n value of AES_128 or a NumberOfBytes value of 16. The\n symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption\n key.

\n

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use\n the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure\n random byte string, use GenerateRandom.

\n

You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

\n GenerateDataKey also supports Amazon Web Services Nitro Enclaves, which provide an\n isolated compute environment in Amazon EC2. To call GenerateDataKey for an Amazon Web Services Nitro\n enclave or NitroTPM, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient parameter\n to provide the attestation document for the attested environment. GenerateDataKey returns a\n copy of the data key encrypted under the specified KMS key, as usual. But instead of a\n plaintext copy of the data key, the response includes a copy of the data key encrypted under\n the public key from the attestation document (CiphertextForRecipient).\n For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

\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 How to use your data key\n

\n

We recommend that you use the following pattern to encrypt data locally in your\n application. You can write your own code or use a client-side encryption library, such as the\n Amazon Web Services Encryption SDK, the\n Amazon DynamoDB Encryption Client,\n or Amazon S3\n client-side encryption to do these tasks for you.

\n

To encrypt data outside of KMS:

\n
    \n
  1. \n

    Use the GenerateDataKey operation to get a data key.

    \n
  2. \n
  3. \n

    Use the plaintext data key (in the Plaintext field of the response) to\n encrypt your data outside of KMS. Then erase the plaintext data key from memory.

    \n
  4. \n
  5. \n

    Store the encrypted data key (in the CiphertextBlob field of the\n response) with the encrypted data.

    \n
  6. \n
\n

To decrypt data outside of KMS:

\n
    \n
  1. \n

    Use the Decrypt operation to decrypt the encrypted data key. The\n operation returns a plaintext copy of the data key.

    \n
  2. \n
  3. \n

    Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext\n data key from memory.

    \n
  4. \n
\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:GenerateDataKey (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 generate a data key", @@ -2935,7 +2935,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a unique asymmetric data key pair for use outside of KMS. This operation returns\n a plaintext public key, a plaintext private key, and a copy of the private key that is\n encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to\n perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes\n in the keys are random; they are not related to the caller or to the KMS key that is used to\n encrypt the private key.

\n

You can use the public key that GenerateDataKeyPair returns to encrypt data\n or verify a signature outside of KMS. Then, store the encrypted private key with the data.\n When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n

To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt\n the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a\n custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

\n

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that\n you use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or\n signing, but not both. However, KMS cannot enforce any restrictions on the use of data key\n pairs outside of KMS.

\n

If you are using the data key pair to encrypt data, or for any operation where you don't\n immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.\n GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an\n encrypted private key, but omits the plaintext private key that you need only to decrypt\n ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use\n the Decrypt operation to decrypt the encrypted private key in the data key\n pair.

\n

\n GenerateDataKeyPair returns a unique data key pair for each request. The\n bytes in the keys are random; they are not related to the caller or the KMS key that is used\n to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as\n specified in RFC 5280. The private\n key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958.

\n

\n GenerateDataKeyPair also supports Amazon Web Services Nitro Enclaves, which provide an\n isolated compute environment in Amazon EC2. To call GenerateDataKeyPair for an Amazon Web Services\n Nitro enclave, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient\n parameter to provide the attestation document for the enclave.\n GenerateDataKeyPair returns the public data key and a copy of the private data\n key encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the\n private data key (PrivateKeyPlaintext), the response includes a copy of the\n private data key encrypted under the public key from the attestation document\n (CiphertextForRecipient). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide..

\n

You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\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: 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:GenerateDataKeyPair (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": "

Returns a unique asymmetric data key pair for use outside of KMS. This operation returns\n a plaintext public key, a plaintext private key, and a copy of the private key that is\n encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to\n perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes\n in the keys are random; they are not related to the caller or to the KMS key that is used to\n encrypt the private key.

\n

You can use the public key that GenerateDataKeyPair returns to encrypt data\n or verify a signature outside of KMS. Then, store the encrypted private key with the data.\n When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n

To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt\n the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a\n custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

\n

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that\n you use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or\n signing, but not both. However, KMS cannot enforce any restrictions on the use of data key\n pairs outside of KMS.

\n

If you are using the data key pair to encrypt data, or for any operation where you don't\n immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.\n GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an\n encrypted private key, but omits the plaintext private key that you need only to decrypt\n ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use\n the Decrypt operation to decrypt the encrypted private key in the data key\n pair.

\n

\n GenerateDataKeyPair returns a unique data key pair for each request. The\n bytes in the keys are random; they are not related to the caller or the KMS key that is used\n to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as\n specified in RFC 5280. The private\n key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958.

\n

\n GenerateDataKeyPair also supports Amazon Web Services Nitro Enclaves, which provide an\n isolated compute environment in Amazon EC2. To call GenerateDataKeyPair for an Amazon Web Services\n Nitro enclave or NitroTPM, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient\n parameter to provide the attestation document for the attested environment.\n GenerateDataKeyPair returns the public data key and a copy of the private data\n key encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the\n private data key (PrivateKeyPlaintext), the response includes a copy of the\n private data key encrypted under the public key from the attestation document\n (CiphertextForRecipient). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

\n

You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\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: 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:GenerateDataKeyPair (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 generate an RSA key pair for encryption and decryption", @@ -2988,7 +2988,7 @@ "Recipient": { "target": "com.amazonaws.kms#RecipientInfo", "traits": { - "smithy.api#documentation": "

A signed attestation document from\n an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The\n only valid encryption algorithm is RSAES_OAEP_SHA_256.

\n

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To call\n DeriveSharedSecret for an Amazon Web Services Nitro Enclaves, use the Amazon Web Services Nitro Enclaves SDK to generate the\n attestation document and then use the Recipient parameter from any Amazon Web Services SDK to provide the\n attestation document for the enclave.

\n

When you use this parameter, instead of returning a plaintext copy of the private data\n key, KMS encrypts the plaintext private data key under the public key in the attestation\n document, and returns the resulting ciphertext in the CiphertextForRecipient\n field in the response. This ciphertext can be decrypted only with the private key in the\n enclave. The CiphertextBlob field in the response contains a copy of the private\n data key encrypted under the KMS key specified by the KeyId parameter. The\n PrivateKeyPlaintext field in the response is null or empty.

\n

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A signed attestation document from\n an Amazon Web Services Nitro enclave or NitroTPM, and the encryption algorithm to use with the public key in the attestation document. The\n only valid encryption algorithm is RSAES_OAEP_SHA_256.

\n

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM. To call\n GenerateDataKeyPair generate an attestation document use either Amazon Web Services Nitro Enclaves SDK for an Amazon Web Services Nitro Enclaves or\n Amazon Web Services NitroTPM tools for Amazon Web Services NitroTPM. Then use the Recipient parameter from any Amazon Web Services SDK to provide the\n attestation document for the attested environment.

\n

When you use this parameter, instead of returning a plaintext copy of the private data\n key, KMS encrypts the plaintext private data key under the public key in the attestation\n document, and returns the resulting ciphertext in the CiphertextForRecipient\n field in the response. This ciphertext can be decrypted only with the private key in the\n attested environment. The CiphertextBlob field in the response contains a copy of the private\n data key encrypted under the KMS key specified by the KeyId parameter. The\n PrivateKeyPlaintext field in the response is null or empty.

\n

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

" } }, "DryRun": { @@ -3038,7 +3038,7 @@ "CiphertextForRecipient": { "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

The plaintext private data key encrypted with the public key from the Nitro enclave. This\n ciphertext can be decrypted only by using a private key in the Nitro enclave.

\n

This field is included in the response only when the Recipient parameter in\n the request includes a valid attestation document from an Amazon Web Services Nitro enclave.\n For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The plaintext private data key encrypted with the public key from the attestation document. This\n ciphertext can be decrypted only by using a private key from the attested environment.

\n

This field is included in the response only when the Recipient parameter in\n the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM.\n For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

" } }, "KeyMaterialId": { @@ -3228,7 +3228,7 @@ "Recipient": { "target": "com.amazonaws.kms#RecipientInfo", "traits": { - "smithy.api#documentation": "

A signed attestation document from\n an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The\n only valid encryption algorithm is RSAES_OAEP_SHA_256.

\n

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this\n parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

\n

When you use this parameter, instead of returning the plaintext data key, KMS encrypts\n the plaintext data key under the public key in the attestation document, and returns the\n resulting ciphertext in the CiphertextForRecipient field in the response. This\n ciphertext can be decrypted only with the private key in the enclave. The\n CiphertextBlob field in the response contains a copy of the data key encrypted\n under the KMS key specified by the KeyId parameter. The Plaintext\n field in the response is null or empty.

\n

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A signed attestation document from\n an Amazon Web Services Nitro enclave or NitroTPM, and the encryption algorithm to use with the public key in the attestation document. The\n only valid encryption algorithm is RSAES_OAEP_SHA_256.

\n

This parameter supports the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK for Amazon Web Services Nitro Enclaves. It supports \n any Amazon Web Services SDK for Amazon Web Services NitroTPM.\n

\n

When you use this parameter, instead of returning the plaintext data key, KMS encrypts\n the plaintext data key under the public key in the attestation document, and returns the\n resulting ciphertext in the CiphertextForRecipient field in the response. This\n ciphertext can be decrypted only with the private key in the enclave. The\n CiphertextBlob field in the response contains a copy of the data key encrypted\n under the KMS key specified by the KeyId parameter. The Plaintext\n field in the response is null or empty.

\n

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

" } }, "DryRun": { @@ -3266,7 +3266,7 @@ "CiphertextForRecipient": { "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

The plaintext data key encrypted with the public key from the Nitro enclave. This\n ciphertext can be decrypted only by using a private key in the Nitro enclave.

\n

This field is included in the response only when the Recipient parameter in\n the request includes a valid attestation document from an Amazon Web Services Nitro enclave.\n For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The plaintext data key encrypted with the public key from the attestation document. This\n ciphertext can be decrypted only by using a private key from the attested environment.

\n

This field is included in the response only when the Recipient parameter in\n the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM.\n For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

" } }, "KeyMaterialId": { @@ -3554,7 +3554,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a random byte string that is cryptographically secure.

\n

You must use the NumberOfBytes parameter to specify the length of the random\n byte string. There is no default value for string length.

\n

By default, the random byte string is generated in KMS. To generate the byte string in\n the CloudHSM cluster associated with an CloudHSM key store, use the CustomKeyStoreId\n parameter.

\n

\n GenerateRandom also supports Amazon Web Services Nitro Enclaves, which provide an\n isolated compute environment in Amazon EC2. To call GenerateRandom for a Nitro\n enclave, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient parameter\n to provide the attestation document for the enclave. Instead of plaintext bytes, the response\n includes the plaintext bytes encrypted under the public key from the attestation document\n (CiphertextForRecipient).For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

\n

For more information about entropy and random number generation, see Entropy and random number generation in the Key Management Service Developer Guide.

\n

\n Cross-account use: Not applicable.\n GenerateRandom does not use any account-specific resources, such as KMS\n keys.

\n

\n Required permissions: kms:GenerateRandom (IAM policy)

\n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

", + "smithy.api#documentation": "

Returns a random byte string that is cryptographically secure.

\n

You must use the NumberOfBytes parameter to specify the length of the random\n byte string. There is no default value for string length.

\n

By default, the random byte string is generated in KMS. To generate the byte string in\n the CloudHSM cluster associated with an CloudHSM key store, use the CustomKeyStoreId\n parameter.

\n

\n GenerateRandom also supports Amazon Web Services Nitro Enclaves, which provide an\n isolated compute environment in Amazon EC2. To call GenerateRandom for a Nitro\n enclave or NitroTPM, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient parameter\n to provide the attestation document for the attested environment. Instead of plaintext bytes, the response\n includes the plaintext bytes encrypted under the public key from the attestation document\n (CiphertextForRecipient). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

\n

For more information about entropy and random number generation, see Entropy and random number generation in the Key Management Service Developer Guide.

\n

\n Cross-account use: Not applicable.\n GenerateRandom does not use any account-specific resources, such as KMS\n keys.

\n

\n Required permissions: kms:GenerateRandom (IAM policy)

\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 generate random data", @@ -3587,7 +3587,7 @@ "Recipient": { "target": "com.amazonaws.kms#RecipientInfo", "traits": { - "smithy.api#documentation": "

A signed attestation document from\n an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The\n only valid encryption algorithm is RSAES_OAEP_SHA_256.

\n

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this\n parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

\n

When you use this parameter, instead of returning plaintext bytes, KMS encrypts the\n plaintext bytes under the public key in the attestation document, and returns the resulting\n ciphertext in the CiphertextForRecipient field in the response. This ciphertext\n can be decrypted only with the private key in the enclave. The Plaintext field in\n the response is null or empty.

\n

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A signed attestation document from\n an Amazon Web Services Nitro enclave or NitroTPM, and the encryption algorithm to use with the public key in the attestation document. The\n only valid encryption algorithm is RSAES_OAEP_SHA_256.

\n

This parameter supports the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK for Amazon Web Services Nitro Enclaves. It supports \n any Amazon Web Services SDK for Amazon Web Services NitroTPM.\n

\n

When you use this parameter, instead of returning plaintext bytes, KMS encrypts the\n plaintext bytes under the public key in the attestation document, and returns the resulting\n ciphertext in the CiphertextForRecipient field in the response. This ciphertext\n can be decrypted only with the private key in the attested environment. The Plaintext field in\n the response is null or empty.

\n

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

" } } }, @@ -3607,7 +3607,7 @@ "CiphertextForRecipient": { "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

The plaintext random bytes encrypted with the public key from the Nitro enclave. This\n ciphertext can be decrypted only by using a private key in the Nitro enclave.

\n

This field is included in the response only when the Recipient parameter in\n the request includes a valid attestation document from an Amazon Web Services Nitro enclave.\n For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The plaintext random bytes encrypted with the public key from the attestation document. This\n ciphertext can be decrypted only by using a private key from the attested environment.

\n

This field is included in the response only when the Recipient parameter in\n the request includes a valid attestation document from an Amazon Web Services Nitro enclave or NitroTPM.\n For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

" } } }, @@ -6504,18 +6504,18 @@ "KeyEncryptionAlgorithm": { "target": "com.amazonaws.kms#KeyEncryptionMechanism", "traits": { - "smithy.api#documentation": "

The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro\n Enclave to encrypt plaintext values for the response. The only valid value is\n RSAES_OAEP_SHA_256.

" + "smithy.api#documentation": "

The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro\n Enclave or NitroTPM to encrypt plaintext values for the response. The only valid value is\n RSAES_OAEP_SHA_256.

" } }, "AttestationDocument": { "target": "com.amazonaws.kms#AttestationDocumentType", "traits": { - "smithy.api#documentation": "

The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's\n public key.

" + "smithy.api#documentation": "

The attestation document for an Amazon Web Services Nitro Enclave or a NitroTPM. This document includes the enclave's\n public key.

" } } }, "traits": { - "smithy.api#documentation": "

Contains information about the party that receives the response from the API\n operation.

\n

This data type is designed to support Amazon Web Services Nitro Enclaves, which lets you create an isolated\n compute environment in Amazon EC2. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Contains information about the party that receives the response from the API\n operation.

\n

This data type is designed to support Amazon Web Services Nitro Enclaves and Amazon Web Services NitroTPM, which lets you create an attested \n environment in Amazon EC2. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.

" } }, "com.amazonaws.kms#RegionType": { @@ -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\n cannot tag an Amazon Web Services 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", @@ -8751,28 +8751,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -8799,28 +8777,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -8935,7 +8891,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\n tag, 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 +8981,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\n with the alias. You don't have permission to associate an alias with an Amazon Web Services managed\n 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/lakeformation.json b/codegen/sdk/aws-models/lakeformation.json index d9931f3aa37..b9c62148ad2 100644 --- a/codegen/sdk/aws-models/lakeformation.json +++ b/codegen/sdk/aws-models/lakeformation.json @@ -1038,17 +1038,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1062,17 +1051,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1086,17 +1064,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1110,17 +1077,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/lambda.json b/codegen/sdk/aws-models/lambda.json index d36ea5fd5f2..b4ce2168652 100644 --- a/codegen/sdk/aws-models/lambda.json +++ b/codegen/sdk/aws-models/lambda.json @@ -1297,17 +1297,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1321,17 +1310,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1345,17 +1323,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1369,17 +1336,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -3182,7 +3138,7 @@ "InvokeMode": { "target": "com.amazonaws.lambda#InvokeMode", "traits": { - "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.

" + "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 200 MB.

" } } }, @@ -3230,7 +3186,7 @@ "InvokeMode": { "target": "com.amazonaws.lambda#InvokeMode", "traits": { - "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.

" + "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 200 MB.

" } } }, @@ -5443,7 +5399,7 @@ "InvokeMode": { "target": "com.amazonaws.lambda#InvokeMode", "traits": { - "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.

" + "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 200 MB.

" } } }, @@ -6715,7 +6671,7 @@ "InvokeMode": { "target": "com.amazonaws.lambda#InvokeMode", "traits": { - "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.

" + "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 200 MB.

" } } }, @@ -14623,7 +14579,7 @@ "InvokeMode": { "target": "com.amazonaws.lambda#InvokeMode", "traits": { - "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.

" + "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 200 MB.

" } } }, @@ -14678,7 +14634,7 @@ "InvokeMode": { "target": "com.amazonaws.lambda#InvokeMode", "traits": { - "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.

" + "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 200 MB.

" } } }, diff --git a/codegen/sdk/aws-models/launch-wizard.json b/codegen/sdk/aws-models/launch-wizard.json index 786835f03bc..4c9d121a8be 100644 --- a/codegen/sdk/aws-models/launch-wizard.json +++ b/codegen/sdk/aws-models/launch-wizard.json @@ -1584,17 +1584,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1608,17 +1597,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1632,17 +1610,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1656,17 +1623,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/lex-model-building-service.json b/codegen/sdk/aws-models/lex-model-building-service.json index 035105c07bb..52f86d2b690 100644 --- a/codegen/sdk/aws-models/lex-model-building-service.json +++ b/codegen/sdk/aws-models/lex-model-building-service.json @@ -877,17 +877,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -901,17 +890,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -925,17 +903,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -949,17 +916,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/lex-models-v2.json b/codegen/sdk/aws-models/lex-models-v2.json index 68ccbe35ffa..c17af38dd19 100644 --- a/codegen/sdk/aws-models/lex-models-v2.json +++ b/codegen/sdk/aws-models/lex-models-v2.json @@ -14338,17 +14338,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -14362,17 +14351,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -14386,17 +14364,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -14410,17 +14377,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/lex-runtime-service.json b/codegen/sdk/aws-models/lex-runtime-service.json index d2813a8d319..b6dea1c6383 100644 --- a/codegen/sdk/aws-models/lex-runtime-service.json +++ b/codegen/sdk/aws-models/lex-runtime-service.json @@ -766,17 +766,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -790,17 +779,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -814,17 +792,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -838,17 +805,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/lex-runtime-v2.json b/codegen/sdk/aws-models/lex-runtime-v2.json index 7df26930eeb..50ad73df35e 100644 --- a/codegen/sdk/aws-models/lex-runtime-v2.json +++ b/codegen/sdk/aws-models/lex-runtime-v2.json @@ -677,17 +677,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -701,17 +690,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -725,17 +703,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -749,17 +716,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/license-manager-linux-subscriptions.json b/codegen/sdk/aws-models/license-manager-linux-subscriptions.json index 1fa1ca48cec..7b4818028eb 100644 --- a/codegen/sdk/aws-models/license-manager-linux-subscriptions.json +++ b/codegen/sdk/aws-models/license-manager-linux-subscriptions.json @@ -941,17 +941,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -965,17 +954,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -989,17 +967,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1013,17 +980,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/license-manager-user-subscriptions.json b/codegen/sdk/aws-models/license-manager-user-subscriptions.json index fbcf8385adb..b0f3e927011 100644 --- a/codegen/sdk/aws-models/license-manager-user-subscriptions.json +++ b/codegen/sdk/aws-models/license-manager-user-subscriptions.json @@ -25,13 +25,19 @@ "ActiveDirectorySettings": { "target": "com.amazonaws.licensemanagerusersubscriptions#ActiveDirectorySettings", "traits": { - "smithy.api#documentation": "

The ActiveDirectorySettings resource contains details about \n\t\t\tthe Active Directory, including network access details such as domain name and IP \n\t\t\taddresses, and the credential provider for user administration.

" + "smithy.api#documentation": "

The ActiveDirectorySettings resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.

" } }, "ActiveDirectoryType": { "target": "com.amazonaws.licensemanagerusersubscriptions#ActiveDirectoryType", "traits": { - "smithy.api#documentation": "

The type of Active Directory – either a self-managed Active Directory or an \n\t\t\tAmazon Web Services Managed Active Directory.

" + "smithy.api#documentation": "

The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.

" + } + }, + "IsSharedActiveDirectory": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default value is false.

" } } }, @@ -61,18 +67,18 @@ "DomainCredentialsProvider": { "target": "com.amazonaws.licensemanagerusersubscriptions#CredentialsProvider", "traits": { - "smithy.api#documentation": "

Points to the CredentialsProvider resource that contains \n\t\t\tinformation about the credential provider for user administration.

" + "smithy.api#documentation": "

Points to the CredentialsProvider resource that contains information about the credential provider for user administration.

" } }, "DomainNetworkSettings": { "target": "com.amazonaws.licensemanagerusersubscriptions#DomainNetworkSettings", "traits": { - "smithy.api#documentation": "

The DomainNetworkSettings resource contains an array of \n\t\t\tsubnets that apply for the Active Directory.

" + "smithy.api#documentation": "

The DomainNetworkSettings resource contains an array of subnets that apply for the Active Directory.

" } } }, "traits": { - "smithy.api#documentation": "

Contains network access and credential details that are needed for \n\t\t\tuser administration in the Active Directory.

" + "smithy.api#documentation": "

Contains network access and credential details that are needed for user administration in the Active Directory.

" } }, "com.amazonaws.licensemanagerusersubscriptions#ActiveDirectoryType": { @@ -130,7 +136,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates the user to an EC2 instance to utilize user-based subscriptions.

\n \n

Your estimated bill for charges on the number of users and related costs will take 48\n\t\t\thours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your\n\t\t\t\tmonthly charges in the Amazon Web Services Billing User Guide.

\n
", + "smithy.api#documentation": "

Associates the user to an EC2 instance to utilize user-based subscriptions.

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -166,7 +172,7 @@ "Domain": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The domain name of the Active Directory that contains information for the user to associate.

" + "smithy.api#documentation": "

The domain name of the Active Directory that contains information for the user to associate.

" } }, "Tags": { @@ -206,7 +212,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request couldn't be completed because it conflicted with the current state of the\n\t\t\tresource.

", + "smithy.api#documentation": "

The request couldn't be completed because it conflicted with the current state of the resource.

", "smithy.api#error": "server" } }, @@ -257,14 +263,14 @@ "IdentityProviderArn": { "target": "com.amazonaws.licensemanagerusersubscriptions#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the IdentityProvider resource that contains details \n\t\t\tabout a registered identity provider. In the case of Active Directory, that can be \n\t\t\ta self-managed Active Directory or an Amazon Web Services Managed Active Directory that contains user identity details.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the IdentityProvider resource that contains details about a registered identity provider. In the case of Active Directory, that can be a self-managed Active Directory or an Amazon Web Services Managed Active Directory that contains user identity details.

", "smithy.api#required": {} } }, "LicenseServerSettings": { "target": "com.amazonaws.licensemanagerusersubscriptions#LicenseServerSettings", "traits": { - "smithy.api#documentation": "

The LicenseServerSettings resource to create for the endpoint. The \n\t\t\tsettings include the type of license server and the Secrets Manager secret that \n\t\t\tenables administrators to add or remove users associated with the \n\t\t\tlicense server.

", + "smithy.api#documentation": "

The LicenseServerSettings resource to create for the endpoint. The settings include the type of license server and the Secrets Manager secret that enables administrators to add or remove users associated with the license server.

", "smithy.api#required": {} } }, @@ -305,12 +311,12 @@ "SecretsManagerCredentialsProvider": { "target": "com.amazonaws.licensemanagerusersubscriptions#SecretsManagerCredentialsProvider", "traits": { - "smithy.api#documentation": "

Identifies the Secrets Manager secret that contains credentials needed for \n\t\t\tuser administration in the Active Directory.

" + "smithy.api#documentation": "

Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.

" } } }, "traits": { - "smithy.api#documentation": "

Contains information about the credential provider for user \n\t\t\tadministration.

" + "smithy.api#documentation": "

Contains information about the credential provider for user administration.

" } }, "com.amazonaws.licensemanagerusersubscriptions#DeleteLicenseServerEndpoint": { @@ -360,7 +366,7 @@ "LicenseServerEndpointArn": { "target": "com.amazonaws.licensemanagerusersubscriptions#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the LicenseServerEndpoint \n\t\t\tresource to delete.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the LicenseServerEndpoint resource to delete.

", "smithy.api#required": {} } }, @@ -443,7 +449,7 @@ "Product": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the user-based subscription product.

\n

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | \nREMOTE_DESKTOP_SERVICES\n

" + "smithy.api#documentation": "

The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | REMOTE_DESKTOP_SERVICES

" } }, "IdentityProviderArn": { @@ -549,7 +555,7 @@ "Domain": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The domain name of the Active Directory that contains information for the user to disassociate.

" + "smithy.api#documentation": "

The domain name of the Active Directory that contains information for the user to disassociate.

" } } }, @@ -613,7 +619,7 @@ } }, "traits": { - "smithy.api#documentation": "

A filter name and value pair that is used to return more specific results from a describe\n\t\t\tor list operation. You can use filters can be used to match a set of resources by specific \n\t\t\tcriteria, such as tags, attributes, or IDs.

" + "smithy.api#documentation": "

A filter name and value pair that is used to return more specific results from a describe or list operation. You can use filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

" } }, "com.amazonaws.licensemanagerusersubscriptions#FilterList": { @@ -628,7 +634,7 @@ "ActiveDirectoryIdentityProvider": { "target": "com.amazonaws.licensemanagerusersubscriptions#ActiveDirectoryIdentityProvider", "traits": { - "smithy.api#documentation": "

The ActiveDirectoryIdentityProvider resource contains settings \n\t\t\tand other details about a specific Active Directory identity provider.

" + "smithy.api#documentation": "

The ActiveDirectoryIdentityProvider resource contains settings and other details about a specific Active Directory identity provider.

" } } }, @@ -642,14 +648,14 @@ "IdentityProvider": { "target": "com.amazonaws.licensemanagerusersubscriptions#IdentityProvider", "traits": { - "smithy.api#documentation": "

The IdentityProvider resource contains information about \n\t\t\tan identity provider.

", + "smithy.api#documentation": "

The IdentityProvider resource contains information about an identity provider.

", "smithy.api#required": {} } }, "Settings": { "target": "com.amazonaws.licensemanagerusersubscriptions#Settings", "traits": { - "smithy.api#documentation": "

The Settings resource contains details about the registered \n\t\t\tidentity provider’s product related configuration settings, such as the \n\t\t\tsubnets to provision VPC endpoints.

", + "smithy.api#documentation": "

The Settings resource contains details about the registered identity provider’s product related configuration settings, such as the subnets to provision VPC endpoints.

", "smithy.api#required": {} } }, @@ -678,6 +684,12 @@ "traits": { "smithy.api#documentation": "

The failure message associated with an identity provider.

" } + }, + "OwnerAccountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The AWS Account ID of the owner of this resource.

" + } } }, "traits": { @@ -725,6 +737,18 @@ "traits": { "smithy.api#documentation": "

The status message for an EC2 instance.

" } + }, + "OwnerAccountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The AWS Account ID of the owner of this resource.

" + } + }, + "IdentityProvider": { + "target": "com.amazonaws.licensemanagerusersubscriptions#IdentityProvider", + "traits": { + "smithy.api#documentation": "

The IdentityProvider resource specifies details about the identity provider.

" + } } }, "traits": { @@ -757,7 +781,7 @@ "IdentityProvider": { "target": "com.amazonaws.licensemanagerusersubscriptions#IdentityProvider", "traits": { - "smithy.api#documentation": "

The IdentityProvider resource specifies details \n\t\t\tabout the identity provider.

", + "smithy.api#documentation": "

The IdentityProvider resource specifies details about the identity provider.

", "smithy.api#required": {} } }, @@ -783,7 +807,7 @@ "Domain": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The domain name of the Active Directory that contains the user information for the product subscription.

" + "smithy.api#documentation": "

The domain name of the Active Directory that contains the user information for the product subscription.

" } }, "AssociationDate": { @@ -923,7 +947,7 @@ "x-amzn-trace-id" ] }, - "smithy.api#documentation": "

With License Manager, you can create user-based subscriptions to utilize licensed software with\n\t\ta per user subscription fee on Amazon EC2 instances.

", + "smithy.api#documentation": "

With License Manager, you can create user-based subscriptions to utilize licensed software with a per user subscription fee on Amazon EC2 instances.

", "smithy.api#title": "AWS License Manager User Subscriptions", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1397,17 +1421,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1421,17 +1434,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1445,17 +1447,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1469,17 +1460,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1561,7 +1541,7 @@ "ProvisioningStatus": { "target": "com.amazonaws.licensemanagerusersubscriptions#LicenseServerEndpointProvisioningStatus", "traits": { - "smithy.api#documentation": "

The current state of the provisioning process for the RDS \n\t\t\tlicense server.

" + "smithy.api#documentation": "

The current state of the provisioning process for the RDS license server.

" } }, "HealthStatus": { @@ -1573,7 +1553,7 @@ "Ipv4Address": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A list of domain IPv4 addresses that are used for the RDS \n\t\t\tlicense server.

" + "smithy.api#documentation": "

A list of domain IPv4 addresses that are used for the RDS license server.

" } } }, @@ -1587,7 +1567,7 @@ "IdentityProviderArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the identity provider that's associated with \n\t\t\tthe RDS license server endpoint.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the identity provider that's associated with the RDS license server endpoint.

" } }, "ServerType": { @@ -1599,7 +1579,7 @@ "ServerEndpoint": { "target": "com.amazonaws.licensemanagerusersubscriptions#ServerEndpoint", "traits": { - "smithy.api#documentation": "

The ServerEndpoint resource contains the network \n\t\t\taddress of the RDS license server endpoint.

" + "smithy.api#documentation": "

The ServerEndpoint resource contains the network address of the RDS license server endpoint.

" } }, "StatusMessage": { @@ -1617,19 +1597,19 @@ "LicenseServerEndpointArn": { "target": "com.amazonaws.licensemanagerusersubscriptions#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the ServerEndpoint resource for the RDS \n\t\t\tlicense server.

" + "smithy.api#documentation": "

The ARN of the ServerEndpoint resource for the RDS license server.

" } }, "LicenseServerEndpointProvisioningStatus": { "target": "com.amazonaws.licensemanagerusersubscriptions#LicenseServerEndpointProvisioningStatus", "traits": { - "smithy.api#documentation": "

The current state of the provisioning process for the RDS license \n\t\t\tserver endpoint

" + "smithy.api#documentation": "

The current state of the provisioning process for the RDS license server endpoint

" } }, "LicenseServers": { "target": "com.amazonaws.licensemanagerusersubscriptions#LicenseServerList", "traits": { - "smithy.api#documentation": "

An array of LicenseServer resources that represent the \n\t\t\tlicense servers that are accessed through this endpoint.

" + "smithy.api#documentation": "

An array of LicenseServer resources that represent the license servers that are accessed through this endpoint.

" } }, "CreationTime": { @@ -1640,7 +1620,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains details about a network endpoint for a Remote Desktop Services (RDS) \n\t\t\tlicense server.

" + "smithy.api#documentation": "

Contains details about a network endpoint for a Remote Desktop Services (RDS) license server.

" } }, "com.amazonaws.licensemanagerusersubscriptions#LicenseServerEndpointId": { @@ -1730,7 +1710,7 @@ "ServerSettings": { "target": "com.amazonaws.licensemanagerusersubscriptions#ServerSettings", "traits": { - "smithy.api#documentation": "

The ServerSettings resource contains the settings for your \n\t\t\tserver.

", + "smithy.api#documentation": "

The ServerSettings resource contains the settings for your server.

", "smithy.api#required": {} } } @@ -1797,13 +1777,13 @@ "Filters": { "target": "com.amazonaws.licensemanagerusersubscriptions#FilterList", "traits": { - "smithy.api#documentation": "

You can use the following filters to streamline results:

\n
    \n
  • \n

    Product

    \n
  • \n
  • \n

    DirectoryId

    \n
  • \n
" + "smithy.api#documentation": "

You can use the following filters to streamline results:

  • Product

  • DirectoryId

" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.

" + "smithy.api#documentation": "

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

" } } }, @@ -1817,14 +1797,14 @@ "IdentityProviderSummaries": { "target": "com.amazonaws.licensemanagerusersubscriptions#IdentityProviderSummaryList", "traits": { - "smithy.api#documentation": "

An array of IdentityProviderSummary resources that contain \n\t\t\tdetails about the Active Directory identity providers that meet the request criteria.

", + "smithy.api#documentation": "

An array of IdentityProviderSummary resources that contain details about the Active Directory identity providers that meet the request criteria.

", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

" } } }, @@ -1890,13 +1870,13 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.

" + "smithy.api#documentation": "

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

" } }, "Filters": { "target": "com.amazonaws.licensemanagerusersubscriptions#FilterList", "traits": { - "smithy.api#documentation": "

You can use the following filters to streamline results:

\n
    \n
  • \n

    Status

    \n
  • \n
  • \n

    InstanceId

    \n
  • \n
" + "smithy.api#documentation": "

You can use the following filters to streamline results:

  • Status

  • InstanceId

" } } }, @@ -1910,13 +1890,13 @@ "InstanceSummaries": { "target": "com.amazonaws.licensemanagerusersubscriptions#InstanceSummaryList", "traits": { - "smithy.api#documentation": "

An array of InstanceSummary resources that contain details \n\t\t\tabout the instances that provide user-based subscriptions and also meet the \n\t\t\trequest criteria.

" + "smithy.api#documentation": "

An array of InstanceSummary resources that contain details about the instances that provide user-based subscriptions and also meet the request criteria.

" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

" } } }, @@ -1983,13 +1963,13 @@ "Filters": { "target": "com.amazonaws.licensemanagerusersubscriptions#FilterList", "traits": { - "smithy.api#documentation": "

You can use the following filters to streamline results:

\n
    \n
  • \n

    IdentityProviderArn

    \n
  • \n
" + "smithy.api#documentation": "

You can use the following filters to streamline results:

  • IdentityProviderArn

" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.

" + "smithy.api#documentation": "

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

" } } }, @@ -2003,13 +1983,13 @@ "LicenseServerEndpoints": { "target": "com.amazonaws.licensemanagerusersubscriptions#LicenseServerEndpointList", "traits": { - "smithy.api#documentation": "

An array of LicenseServerEndpoint resources that \n\t\t\tcontain detailed information about the RDS License Servers that meet \n\t\t\tthe request criteria.

" + "smithy.api#documentation": "

An array of LicenseServerEndpoint resources that contain detailed information about the RDS License Servers that meet the request criteria.

" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

" } } }, @@ -2069,7 +2049,7 @@ "Product": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the user-based subscription product.

\n

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | \nREMOTE_DESKTOP_SERVICES\n

" + "smithy.api#documentation": "

The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | REMOTE_DESKTOP_SERVICES

" } }, "IdentityProvider": { @@ -2088,13 +2068,13 @@ "Filters": { "target": "com.amazonaws.licensemanagerusersubscriptions#FilterList", "traits": { - "smithy.api#documentation": "

You can use the following filters to streamline results:

\n
    \n
  • \n

    Status

    \n
  • \n
  • \n

    Username

    \n
  • \n
  • \n

    Domain

    \n
  • \n
" + "smithy.api#documentation": "

You can use the following filters to streamline results:

  • Status

  • Username

  • Domain

" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.

" + "smithy.api#documentation": "

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

" } } }, @@ -2114,7 +2094,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

" } } }, @@ -2252,13 +2232,13 @@ "Filters": { "target": "com.amazonaws.licensemanagerusersubscriptions#FilterList", "traits": { - "smithy.api#documentation": "

You can use the following filters to streamline results:

\n
    \n
  • \n

    Status

    \n
  • \n
  • \n

    Username

    \n
  • \n
  • \n

    Domain

    \n
  • \n
" + "smithy.api#documentation": "

You can use the following filters to streamline results:

  • Status

  • Username

  • Domain

" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token to specify where to start paginating. This is the nextToken \n\tfrom a previously truncated response.

" + "smithy.api#documentation": "

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

" } } }, @@ -2278,7 +2258,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, \n\tthere are additional elements that the service hasn't included in this request. Use this token \n\t\twith the next request to retrieve additional objects.

" + "smithy.api#documentation": "

The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

" } } }, @@ -2332,7 +2312,7 @@ "Domain": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The domain name of the Active Directory that contains the user information for the product subscription.

" + "smithy.api#documentation": "

The domain name of the Active Directory that contains the user information for the product subscription.

" } }, "SubscriptionStartDate": { @@ -2364,7 +2344,7 @@ "RdsSalCredentialsProvider": { "target": "com.amazonaws.licensemanagerusersubscriptions#CredentialsProvider", "traits": { - "smithy.api#documentation": "

The CredentialsProvider resource contains a reference to \n\t\t\tthe credentials provider that's used for RDS license server user administration.

", + "smithy.api#documentation": "

The CredentialsProvider resource contains a reference to the credentials provider that's used for RDS license server user administration.

", "smithy.api#required": {} } } @@ -2427,14 +2407,14 @@ "Product": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the user-based subscription product.

\n

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | \nREMOTE_DESKTOP_SERVICES\n

", + "smithy.api#documentation": "

The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | REMOTE_DESKTOP_SERVICES

", "smithy.api#required": {} } }, "Settings": { "target": "com.amazonaws.licensemanagerusersubscriptions#Settings", "traits": { - "smithy.api#documentation": "

The registered identity provider’s product related configuration \n\t\t\tsettings such as the subnets to provision VPC endpoints.

" + "smithy.api#documentation": "

The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.

" } }, "Tags": { @@ -2529,7 +2509,7 @@ "RdsSalSettings": { "target": "com.amazonaws.licensemanagerusersubscriptions#RdsSalSettings", "traits": { - "smithy.api#documentation": "

The RdsSalSettings resource contains settings to configure \n\t\t\ta specific Remote Desktop Services (RDS) license server.

" + "smithy.api#documentation": "

The RdsSalSettings resource contains settings to configure a specific Remote Desktop Services (RDS) license server.

" } } }, @@ -2577,13 +2557,13 @@ "SecurityGroupId": { "target": "com.amazonaws.licensemanagerusersubscriptions#SecurityGroup", "traits": { - "smithy.api#documentation": "

A security group ID that allows inbound TCP port 1688 communication between resources in\n\t\t\tyour VPC and the VPC endpoint for activation servers.

", + "smithy.api#documentation": "

A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoint for activation servers.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The registered identity provider’s product related configuration settings such as the\n\t\t\tsubnets to provision VPC endpoints, and the security group ID that is associated with the VPC\n\t\t\tendpoints. The security group should permit inbound TCP port 1688 communication from resources\n\t\t\tin the VPC.

" + "smithy.api#documentation": "

The registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints, and the security group ID that is associated with the VPC endpoints. The security group should permit inbound TCP port 1688 communication from resources in the VPC.

" } }, "com.amazonaws.licensemanagerusersubscriptions#StartProductSubscription": { @@ -2618,7 +2598,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a product subscription for a user with the specified identity provider.

\n \n

Your estimated bill for charges on the number of users and related costs will take 48\n\t\t\thours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your\n\t\t\t\tmonthly charges in the Amazon Web Services Billing User Guide.

\n
", + "smithy.api#documentation": "

Starts a product subscription for a user with the specified identity provider.

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -2646,14 +2626,14 @@ "Product": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the user-based subscription product.

\n

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | \nREMOTE_DESKTOP_SERVICES\n

", + "smithy.api#documentation": "

The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | REMOTE_DESKTOP_SERVICES

", "smithy.api#required": {} } }, "Domain": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The domain name of the Active Directory that contains the user for whom to start the product \n\t\t\tsubscription.

" + "smithy.api#documentation": "

The domain name of the Active Directory that contains the user for whom to start the product subscription.

" } }, "Tags": { @@ -2740,7 +2720,7 @@ "Product": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the user-based subscription product.

\n

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | \nREMOTE_DESKTOP_SERVICES\n

" + "smithy.api#documentation": "

The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | REMOTE_DESKTOP_SERVICES

" } }, "ProductUserArn": { @@ -2752,7 +2732,7 @@ "Domain": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The domain name of the Active Directory that contains the user for whom to stop the product \n\t\t\tsubscription.

" + "smithy.api#documentation": "

The domain name of the Active Directory that contains the user for whom to stop the product subscription.

" } } }, @@ -2971,7 +2951,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates additional product configuration settings for the registered identity\n\t\t\tprovider.

", + "smithy.api#documentation": "

Updates additional product configuration settings for the registered identity provider.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -2989,7 +2969,7 @@ "Product": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the user-based subscription product.

\n

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | \nREMOTE_DESKTOP_SERVICES\n

" + "smithy.api#documentation": "

The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | REMOTE_DESKTOP_SERVICES

" } }, "IdentityProviderArn": { @@ -3001,7 +2981,7 @@ "UpdateSettings": { "target": "com.amazonaws.licensemanagerusersubscriptions#UpdateSettings", "traits": { - "smithy.api#documentation": "

Updates the registered identity provider’s product related configuration settings. You can\n\t\t\tupdate any combination of settings in a single operation such as the:

\n
    \n
  • \n

    Subnets which you want to add to provision VPC endpoints.

    \n
  • \n
  • \n

    Subnets which you want to remove the VPC endpoints from.

    \n
  • \n
  • \n

    Security group ID which permits traffic to the VPC endpoints.

    \n
  • \n
", + "smithy.api#documentation": "

Updates the registered identity provider’s product related configuration settings. You can update any combination of settings in a single operation such as the:

  • Subnets which you want to add to provision VPC endpoints.

  • Subnets which you want to remove the VPC endpoints from.

  • Security group ID which permits traffic to the VPC endpoints.

", "smithy.api#required": {} } } @@ -3030,7 +3010,7 @@ "AddSubnets": { "target": "com.amazonaws.licensemanagerusersubscriptions#Subnets", "traits": { - "smithy.api#documentation": "

The ID of one or more subnets in which License Manager will create a VPC endpoint for products that\n\t\t\trequire connectivity to activation servers.

", + "smithy.api#documentation": "

The ID of one or more subnets in which License Manager will create a VPC endpoint for products that require connectivity to activation servers.

", "smithy.api#required": {} } }, @@ -3044,12 +3024,12 @@ "SecurityGroupId": { "target": "com.amazonaws.licensemanagerusersubscriptions#SecurityGroup", "traits": { - "smithy.api#documentation": "

A security group ID that allows inbound TCP port 1688 communication between resources in\n\t\t\tyour VPC and the VPC endpoints for activation servers.

" + "smithy.api#documentation": "

A security group ID that allows inbound TCP port 1688 communication between resources in your VPC and the VPC endpoints for activation servers.

" } } }, "traits": { - "smithy.api#documentation": "

Updates the registered identity provider’s product related configuration settings such as\n\t\t\tthe subnets to provision VPC endpoints.

" + "smithy.api#documentation": "

Updates the registered identity provider’s product related configuration settings such as the subnets to provision VPC endpoints.

" } }, "com.amazonaws.licensemanagerusersubscriptions#ValidationException": { diff --git a/codegen/sdk/aws-models/license-manager.json b/codegen/sdk/aws-models/license-manager.json index 5c478212875..7d3c714c828 100644 --- a/codegen/sdk/aws-models/license-manager.json +++ b/codegen/sdk/aws-models/license-manager.json @@ -1037,17 +1037,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1061,17 +1050,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1085,17 +1063,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1109,17 +1076,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/lightsail.json b/codegen/sdk/aws-models/lightsail.json index 82bfe0be72b..fb4cb1a1953 100644 --- a/codegen/sdk/aws-models/lightsail.json +++ b/codegen/sdk/aws-models/lightsail.json @@ -199,7 +199,7 @@ "message": { "target": "com.amazonaws.lightsail#BPAStatusMessage", "traits": { - "smithy.api#documentation": "

A message that provides a reason for a Failed or Defaulted\n synchronization status.

\n

The following messages are possible:

\n
    \n
  • \n

    \n SYNC_ON_HOLD - The synchronization has not yet happened. This status\n message occurs immediately after you create your first Lightsail bucket. This status\n message should change after the first synchronization happens, approximately 1 hour after\n the first bucket is created.

    \n
  • \n
  • \n

    \n DEFAULTED_FOR_SLR_MISSING - The synchronization failed because the\n required service-linked role is missing from your Amazon Web Services account. The\n account-level BPA configuration for your Lightsail buckets is defaulted to\n active until the synchronization can occur. This means that all\n your buckets are private and not publicly accessible. For more information about how to\n create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

    \n
  • \n
  • \n

    \n DEFAULTED_FOR_SLR_MISSING_ON_HOLD - The synchronization failed because\n the required service-linked role is missing from your Amazon Web Services account.\n Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the\n bucket access permissions and individual object access permissions apply to your\n Lightsail buckets. For more information about how to create the required service-linked\n role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

    \n
  • \n
  • \n

    \n Unknown - The reason that synchronization failed is unknown. Contact\n Amazon Web ServicesSupport for more information.

    \n
  • \n
" + "smithy.api#documentation": "

A message that provides a reason for a Failed or Defaulted\n synchronization status.

\n

The following messages are possible:

\n
    \n
  • \n

    \n SYNC_ON_HOLD - The synchronization has not yet happened. This status\n message occurs immediately after you create your first Lightsail bucket. This status\n message should change after the first synchronization happens, approximately 1 hour after\n the first bucket is created.

    \n
  • \n
  • \n

    \n DEFAULTED_FOR_SLR_MISSING - The synchronization failed because the\n required service-linked role is missing from your Amazon Web Services account. The\n account-level BPA configuration for your Lightsail buckets is defaulted to\n active until the synchronization can occur. This means that all\n your buckets are private and not publicly accessible. For more information about how to\n create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

    \n
  • \n
  • \n

    \n DEFAULTED_FOR_SLR_MISSING_ON_HOLD - The synchronization failed because\n the required service-linked role is missing from your Amazon Web Services account.\n Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the\n bucket access permissions and individual object access permissions apply to your\n Lightsail buckets. For more information about how to create the required service-linked\n role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

    \n
  • \n
  • \n

    \n Unknown - The reason that synchronization failed is unknown. Contact\n Amazon Web Services Support for more information.

    \n
  • \n
" } }, "bpaImpactsLightsail": { @@ -5727,7 +5727,7 @@ "smithy.api#documentation": "

Deletes an alarm.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", "smithy.api#http": { "method": "DELETE", - "uri": "/ls/api/2016-11-28/DeleteAlarm", + "uri": "/ls/api/2016-11-28/DeleteAlarm/{alarmName}", "code": 200 } } @@ -5739,6 +5739,7 @@ "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the alarm to delete.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -8907,19 +8908,22 @@ "alarmName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the alarm.

\n

Specify an alarm name to return information about a specific alarm.

" + "smithy.api#documentation": "

The name of the alarm.

\n

Specify an alarm name to return information about a specific alarm.

", + "smithy.api#httpQuery": "alarmName" } }, "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetAlarms request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetAlarms request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

", + "smithy.api#httpQuery": "pageToken" } }, "monitoredResourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the Lightsail resource being monitored by the alarm.

\n

Specify a monitored resource name to return information about all alarms for a specific\n resource.

" + "smithy.api#documentation": "

The name of the Lightsail resource being monitored by the alarm.

\n

Specify a monitored resource name to return information about all alarms for a specific\n resource.

", + "smithy.api#httpQuery": "monitoredResourceName" } } }, @@ -9750,7 +9754,8 @@ "protocols": { "target": "com.amazonaws.lightsail#ContactProtocolsList", "traits": { - "smithy.api#documentation": "

The protocols used to send notifications, such as Email, or SMS\n (text messaging).

\n

Specify a protocol in your request to return information about a specific contact method\n protocol.

" + "smithy.api#documentation": "

The protocols used to send notifications, such as Email, or SMS\n (text messaging).

\n

Specify a protocol in your request to return information about a specific contact method\n protocol.

", + "smithy.api#httpQuery": "protocols" } } }, @@ -16750,17 +16755,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -16774,17 +16768,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -16798,17 +16781,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -16822,17 +16794,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -22756,7 +22717,7 @@ "smithy.api#documentation": "

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification\n trigger is configured for the specified alarm, the test also sends a notification to the\n notification protocol (Email and/or SMS) configured for the\n alarm.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", "smithy.api#http": { "method": "GET", - "uri": "/ls/api/2016-11-28/TestAlarm", + "uri": "/ls/api/2016-11-28/TestAlarm/{alarmName}", "code": 200 } } @@ -22768,6 +22729,7 @@ "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the alarm to test.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -22775,6 +22737,7 @@ "target": "com.amazonaws.lightsail#AlarmState", "traits": { "smithy.api#documentation": "

The alarm state to test.

\n

An alarm has the following possible states that can be tested:

\n
    \n
  • \n

    \n ALARM - The metric is outside of the defined threshold.

    \n
  • \n
  • \n

    \n INSUFFICIENT_DATA - The alarm has just started, the metric is not\n available, or not enough data is available for the metric to determine the alarm\n state.

    \n
  • \n
  • \n

    \n OK - The metric is within the defined threshold.

    \n
  • \n
", + "smithy.api#httpQuery": "state", "smithy.api#required": {} } } diff --git a/codegen/sdk/aws-models/location.json b/codegen/sdk/aws-models/location.json index c1050af8beb..0468ed3ec63 100644 --- a/codegen/sdk/aws-models/location.json +++ b/codegen/sdk/aws-models/location.json @@ -6850,17 +6850,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6874,17 +6863,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -6898,17 +6876,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6922,17 +6889,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/lookoutequipment.json b/codegen/sdk/aws-models/lookoutequipment.json index d65e8fa2e44..8c163fefd14 100644 --- a/codegen/sdk/aws-models/lookoutequipment.json +++ b/codegen/sdk/aws-models/lookoutequipment.json @@ -693,17 +693,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -717,17 +706,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -741,17 +719,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -765,17 +732,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1655,13 +1611,13 @@ "smithy.api#documentation": "

Creates a retraining scheduler on the specified model.

", "smithy.api#examples": [ { - "title": "Creates a retraining scheduler with manual promote mode", + "title": "Creates a retraining scheduler with a specific start date", "documentation": "", "input": { "ModelName": "sample-model", + "RetrainingStartDate": "2024-01-01T00:00:00Z", "RetrainingFrequency": "P1M", "LookbackWindow": "P360D", - "PromoteMode": "MANUAL", "ClientToken": "sample-client-token" }, "output": { @@ -1671,13 +1627,13 @@ } }, { - "title": "Creates a retraining scheduler with a specific start date", + "title": "Creates a retraining scheduler with manual promote mode", "documentation": "", "input": { "ModelName": "sample-model", - "RetrainingStartDate": "2024-01-01T00:00:00Z", "RetrainingFrequency": "P1M", "LookbackWindow": "P360D", + "PromoteMode": "MANUAL", "ClientToken": "sample-client-token" }, "output": { diff --git a/codegen/sdk/aws-models/lookoutmetrics.json b/codegen/sdk/aws-models/lookoutmetrics.json index 6d32e4199ff..4a9c3f0d81e 100644 --- a/codegen/sdk/aws-models/lookoutmetrics.json +++ b/codegen/sdk/aws-models/lookoutmetrics.json @@ -4661,17 +4661,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4685,17 +4674,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4709,17 +4687,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4733,17 +4700,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/lookoutvision.json b/codegen/sdk/aws-models/lookoutvision.json index 50a2f6e2083..bbb3419a5e1 100644 --- a/codegen/sdk/aws-models/lookoutvision.json +++ b/codegen/sdk/aws-models/lookoutvision.json @@ -2691,17 +2691,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2715,17 +2704,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2739,17 +2717,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2763,17 +2730,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/m2.json b/codegen/sdk/aws-models/m2.json index 6ef81399d86..ffb4e969259 100644 --- a/codegen/sdk/aws-models/m2.json +++ b/codegen/sdk/aws-models/m2.json @@ -1024,17 +1024,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1048,17 +1037,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1072,17 +1050,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1096,17 +1063,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/machine-learning.json b/codegen/sdk/aws-models/machine-learning.json index d10095aebd1..0353f6019a0 100644 --- a/codegen/sdk/aws-models/machine-learning.json +++ b/codegen/sdk/aws-models/machine-learning.json @@ -714,17 +714,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -738,17 +727,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -762,17 +740,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -786,17 +753,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/macie2.json b/codegen/sdk/aws-models/macie2.json index f4ca58a1573..6ca2c739be3 100644 --- a/codegen/sdk/aws-models/macie2.json +++ b/codegen/sdk/aws-models/macie2.json @@ -9974,17 +9974,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -9998,17 +9987,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -10022,17 +10000,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -10046,17 +10013,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/mailmanager.json b/codegen/sdk/aws-models/mailmanager.json index 6f0788673dc..51f1f3e905b 100644 --- a/codegen/sdk/aws-models/mailmanager.json +++ b/codegen/sdk/aws-models/mailmanager.json @@ -6321,17 +6321,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6345,17 +6334,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -6369,17 +6347,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6393,17 +6360,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/managedblockchain-query.json b/codegen/sdk/aws-models/managedblockchain-query.json index 012c7b1d211..783a534ed6b 100644 --- a/codegen/sdk/aws-models/managedblockchain-query.json +++ b/codegen/sdk/aws-models/managedblockchain-query.json @@ -2249,17 +2249,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2273,17 +2262,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2297,17 +2275,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2321,17 +2288,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/managedblockchain.json b/codegen/sdk/aws-models/managedblockchain.json index a98e670fd08..e74dff916dd 100644 --- a/codegen/sdk/aws-models/managedblockchain.json +++ b/codegen/sdk/aws-models/managedblockchain.json @@ -4454,17 +4454,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4478,17 +4467,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4502,17 +4480,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4526,17 +4493,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/marketplace-agreement.json b/codegen/sdk/aws-models/marketplace-agreement.json index 215a90dd96a..6ed3a66f0fc 100644 --- a/codegen/sdk/aws-models/marketplace-agreement.json +++ b/codegen/sdk/aws-models/marketplace-agreement.json @@ -549,17 +549,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -573,17 +562,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -597,17 +575,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -621,17 +588,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/marketplace-catalog.json b/codegen/sdk/aws-models/marketplace-catalog.json index 865b1def435..8b7df0af2ca 100644 --- a/codegen/sdk/aws-models/marketplace-catalog.json +++ b/codegen/sdk/aws-models/marketplace-catalog.json @@ -569,17 +569,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -593,17 +582,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -617,17 +595,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -641,17 +608,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/marketplace-commerce-analytics.json b/codegen/sdk/aws-models/marketplace-commerce-analytics.json index 930f2e42346..9d5d74a932a 100644 --- a/codegen/sdk/aws-models/marketplace-commerce-analytics.json +++ b/codegen/sdk/aws-models/marketplace-commerce-analytics.json @@ -815,17 +815,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -839,17 +828,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -863,17 +841,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -887,17 +854,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/marketplace-deployment.json b/codegen/sdk/aws-models/marketplace-deployment.json index 4966e3cae91..511e2011041 100644 --- a/codegen/sdk/aws-models/marketplace-deployment.json +++ b/codegen/sdk/aws-models/marketplace-deployment.json @@ -541,17 +541,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -565,17 +554,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -589,17 +567,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -613,17 +580,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/marketplace-entitlement-service.json b/codegen/sdk/aws-models/marketplace-entitlement-service.json index d9c050c96cf..5997d29b397 100644 --- a/codegen/sdk/aws-models/marketplace-entitlement-service.json +++ b/codegen/sdk/aws-models/marketplace-entitlement-service.json @@ -716,17 +716,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -740,17 +729,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -764,17 +742,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -788,17 +755,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -812,17 +768,6 @@ "UseDualStack": false } }, - { - "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": { @@ -836,17 +781,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -861,49 +795,53 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://entitlement.marketplace-fips.us-isof-south-1.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://entitlement.marketplace-fips.us-isof-south-1.csp.hci.ic.gov" + "url": "https://entitlement.marketplace.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://entitlement.marketplace-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://entitlement.marketplace.us-isof-south-1.csp.hci.ic.gov" + "url": "https://entitlement.marketplace.eusc-de-east-1.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } diff --git a/codegen/sdk/aws-models/marketplace-metering.json b/codegen/sdk/aws-models/marketplace-metering.json index 5fc08ff37e7..21be9efafdd 100644 --- a/codegen/sdk/aws-models/marketplace-metering.json +++ b/codegen/sdk/aws-models/marketplace-metering.json @@ -725,17 +725,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -749,17 +738,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -773,17 +751,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -797,17 +764,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -821,17 +777,6 @@ "UseDualStack": false } }, - { - "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": { @@ -845,17 +790,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -870,49 +804,53 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://metering.marketplace-fips.us-isof-south-1.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://metering.marketplace-fips.us-isof-south-1.csp.hci.ic.gov" + "url": "https://metering.marketplace.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://metering.marketplace-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://metering.marketplace.us-isof-south-1.csp.hci.ic.gov" + "url": "https://metering.marketplace.eusc-de-east-1.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } diff --git a/codegen/sdk/aws-models/marketplace-reporting.json b/codegen/sdk/aws-models/marketplace-reporting.json index 04b79f3f803..45bf8daff7d 100644 --- a/codegen/sdk/aws-models/marketplace-reporting.json +++ b/codegen/sdk/aws-models/marketplace-reporting.json @@ -538,17 +538,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -562,17 +551,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -586,17 +564,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -610,17 +577,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/mediaconnect.json b/codegen/sdk/aws-models/mediaconnect.json index 66bfe85f5fe..98a12e75669 100644 --- a/codegen/sdk/aws-models/mediaconnect.json +++ b/codegen/sdk/aws-models/mediaconnect.json @@ -6448,17 +6448,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6472,17 +6461,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -6496,17 +6474,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6520,17 +6487,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/mediaconvert.json b/codegen/sdk/aws-models/mediaconvert.json index 75b715fd784..c5fb1eedda0 100644 --- a/codegen/sdk/aws-models/mediaconvert.json +++ b/codegen/sdk/aws-models/mediaconvert.json @@ -78,7 +78,7 @@ } }, "traits": { - "smithy.api#documentation": "Specify the AAC profile. For the widest player compatibility and where higher bitrates are acceptable: Keep the default profile, LC (AAC-LC) For improved audio performance at lower bitrates: Choose HEV1 or HEV2. HEV1 (AAC-HE v1) adds spectral band replication to improve speech audio at low bitrates. HEV2 (AAC-HE v2) adds parametric stereo, which optimizes for encoding stereo audio at very low bitrates." + "smithy.api#documentation": "Specify the AAC profile. For the widest player compatibility and where higher bitrates are acceptable: Keep the default profile, LC (AAC-LC) For improved audio performance at lower bitrates: Choose HEV1 or HEV2. HEV1 (AAC-HE v1) adds spectral band replication to improve speech audio at low bitrates. HEV2 (AAC-HE v2) adds parametric stereo, which optimizes for encoding stereo audio at very low bitrates. For improved audio quality at lower bitrates, adaptive audio bitrate switching, and loudness control: Choose XHE." } }, "com.amazonaws.mediaconvert#AacCodingMode": { @@ -199,7 +199,7 @@ "CodecProfile": { "target": "com.amazonaws.mediaconvert#AacCodecProfile", "traits": { - "smithy.api#documentation": "Specify the AAC profile. For the widest player compatibility and where higher bitrates are acceptable: Keep the default profile, LC (AAC-LC) For improved audio performance at lower bitrates: Choose HEV1 or HEV2. HEV1 (AAC-HE v1) adds spectral band replication to improve speech audio at low bitrates. HEV2 (AAC-HE v2) adds parametric stereo, which optimizes for encoding stereo audio at very low bitrates.", + "smithy.api#documentation": "Specify the AAC profile. For the widest player compatibility and where higher bitrates are acceptable: Keep the default profile, LC (AAC-LC) For improved audio performance at lower bitrates: Choose HEV1 or HEV2. HEV1 (AAC-HE v1) adds spectral band replication to improve speech audio at low bitrates. HEV2 (AAC-HE v2) adds parametric stereo, which optimizes for encoding stereo audio at very low bitrates. For improved audio quality at lower bitrates, adaptive audio bitrate switching, and loudness control: Choose XHE.", "smithy.api#jsonName": "codecProfile" } }, @@ -6283,6 +6283,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.mediaconvert#CreateResourceShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediaconvert#CreateResourceShareRequest" + }, + "output": { + "target": "com.amazonaws.mediaconvert#CreateResourceShareResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mediaconvert#BadRequestException" + }, + { + "target": "com.amazonaws.mediaconvert#ConflictException" + }, + { + "target": "com.amazonaws.mediaconvert#ForbiddenException" + }, + { + "target": "com.amazonaws.mediaconvert#InternalServerErrorException" + }, + { + "target": "com.amazonaws.mediaconvert#NotFoundException" + }, + { + "target": "com.amazonaws.mediaconvert#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Create a new resource share request for MediaConvert resources with AWS Support.", + "smithy.api#http": { + "method": "POST", + "uri": "/2017-08-29/resourceShares", + "code": 202 + } + } + }, + "com.amazonaws.mediaconvert#CreateResourceShareRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specify MediaConvert Job ID or ARN to share", + "smithy.api#jsonName": "jobId", + "smithy.api#required": {} + } + }, + "SupportCaseId": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "AWS Support case identifier", + "smithy.api#jsonName": "supportCaseId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mediaconvert#CreateResourceShareResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.mediaconvert#DashAdditionalManifest": { "type": "structure", "members": { @@ -13203,6 +13273,12 @@ "smithy.api#enumValue": "INCLUDE" } }, + "INCLUDE_AS_TS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE_AS_TS" + } + }, "EXCLUDE": { "target": "smithy.api#Unit", "traits": { @@ -13211,7 +13287,7 @@ } }, "traits": { - "smithy.api#documentation": "Choose Include to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude." + "smithy.api#documentation": "Generate a variant manifest that lists only the I-frames for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only variant manifest and the regular variant manifest to the multivariant manifest. To have MediaConvert write a variant manifest that references I-frames from your output content using EXT-X-BYTERANGE tags: Choose Include. To have MediaConvert output I-frames as single frame TS files and a corresponding variant manifest that references them: Choose Include as TS. When you don't need the I-frame only variant manifest: Keep the default value, Exclude." } }, "com.amazonaws.mediaconvert#HlsImageBasedTrickPlay": { @@ -13592,7 +13668,7 @@ "IFrameOnlyManifest": { "target": "com.amazonaws.mediaconvert#HlsIFrameOnlyManifest", "traits": { - "smithy.api#documentation": "Choose Include to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude.", + "smithy.api#documentation": "Generate a variant manifest that lists only the I-frames for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only variant manifest and the regular variant manifest to the multivariant manifest. To have MediaConvert write a variant manifest that references I-frames from your output content using EXT-X-BYTERANGE tags: Choose Include. To have MediaConvert output I-frames as single frame TS files and a corresponding variant manifest that references them: Choose Include as TS. When you don't need the I-frame only variant manifest: Keep the default value, Exclude.", "smithy.api#jsonName": "iFrameOnlyManifest" } }, @@ -14260,7 +14336,7 @@ "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#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 This setting is required when you include TAMS settings in your job.", "smithy.api#jsonName": "authConnectionArn" } }, @@ -14274,14 +14350,14 @@ "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#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 you 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#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 you include TAMS settings in your job.", "smithy.api#jsonName": "timerange" } } @@ -14730,6 +14806,13 @@ "smithy.api#jsonName": "jobTemplate" } }, + "LastShareDetails": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Contains information about the most recent share attempt for the job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/creating-resource-share.html", + "smithy.api#jsonName": "lastShareDetails" + } + }, "Messages": { "target": "com.amazonaws.mediaconvert#JobMessages", "traits": { @@ -14790,6 +14873,13 @@ "smithy.api#required": {} } }, + "ShareStatus": { + "target": "com.amazonaws.mediaconvert#ShareStatus", + "traits": { + "smithy.api#documentation": "A job's share status can be NOT_SHARED, INITIATED, or SHARED", + "smithy.api#jsonName": "shareStatus" + } + }, "SimulateReservedQueue": { "target": "com.amazonaws.mediaconvert#SimulateReservedQueue", "traits": { @@ -18207,6 +18297,9 @@ { "target": "com.amazonaws.mediaconvert#CreateQueue" }, + { + "target": "com.amazonaws.mediaconvert#CreateResourceShare" + }, { "target": "com.amazonaws.mediaconvert#DeleteJobTemplate" }, @@ -19102,17 +19195,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -19126,17 +19208,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -19150,17 +19221,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -19174,17 +19234,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -19617,9 +19666,36 @@ "smithy.api#documentation": "These settings relate to your QuickTime MOV output container." } }, + "com.amazonaws.mediaconvert#Mp2AudioDescriptionMix": { + "type": "enum", + "members": { + "BROADCASTER_MIXED_AD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BROADCASTER_MIXED_AD" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#documentation": "Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains \"broadcaster mixed AD\". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NONE when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType." + } + }, "com.amazonaws.mediaconvert#Mp2Settings": { "type": "structure", "members": { + "AudioDescriptionMix": { + "target": "com.amazonaws.mediaconvert#Mp2AudioDescriptionMix", + "traits": { + "smithy.api#documentation": "Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains \"broadcaster mixed AD\". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NONE when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType.", + "smithy.api#jsonName": "audioDescriptionMix" + } + }, "Bitrate": { "target": "com.amazonaws.mediaconvert#__integerMin32000Max384000", "traits": { @@ -23715,6 +23791,29 @@ "smithy.api#documentation": "A service override applied by MediaConvert to the settings that you have configured. If you see any overrides, we recommend that you contact AWS Support." } }, + "com.amazonaws.mediaconvert#ShareStatus": { + "type": "enum", + "members": { + "NOT_SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_SHARED" + } + }, + "INITIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIATED" + } + }, + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + } + } + }, "com.amazonaws.mediaconvert#SimulateReservedQueue": { "type": "enum", "members": { @@ -26423,12 +26522,46 @@ "smithy.api#documentation": "If the sample range metadata in your input video is accurate, or if you don't know about sample range, keep the default value, Follow, for this setting. When you do, the service automatically detects your input sample range. If your input video has metadata indicating the wrong sample range, specify the accurate sample range here. When you do, MediaConvert ignores any sample range information in the input metadata. Regardless of whether MediaConvert uses the input sample range or the sample range that you specify, MediaConvert uses the sample range for transcoding and also writes it to the output metadata.", "smithy.api#jsonName": "sampleRange" } + }, + "SelectorType": { + "target": "com.amazonaws.mediaconvert#VideoSelectorType", + "traits": { + "smithy.api#documentation": "Choose the video selector type for your HLS input. Use to specify which video rendition MediaConvert uses from your HLS input. To have MediaConvert automatically use the highest bitrate rendition from your HLS input: Keep the default value, Auto. To manually specify a rendition: Choose Stream. Then enter the unique stream number in the Streams array, starting at 1, corresponding to the stream order in the manifest.", + "smithy.api#jsonName": "selectorType" + } + }, + "Streams": { + "target": "com.amazonaws.mediaconvert#__listOf__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "Specify a stream for MediaConvert to use from your HLS input. Enter an integer corresponding to the stream order in your HLS manifest.", + "smithy.api#jsonName": "streams" + } } }, "traits": { "smithy.api#documentation": "Input video selectors contain the video settings for the input. Each of your inputs can have up to one video selector." } }, + "com.amazonaws.mediaconvert#VideoSelectorType": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "STREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAM" + } + } + }, + "traits": { + "smithy.api#documentation": "Choose the video selector type for your HLS input. Use to specify which video rendition MediaConvert uses from your HLS input. To have MediaConvert automatically use the highest bitrate rendition from your HLS input: Keep the default value, Auto. To manually specify a rendition: Choose Stream. Then enter the unique stream number in the Streams array, starting at 1, corresponding to the stream order in the manifest." + } + }, "com.amazonaws.mediaconvert#VideoTimecodeInsertion": { "type": "enum", "members": { diff --git a/codegen/sdk/aws-models/medialive.json b/codegen/sdk/aws-models/medialive.json index 053bf5a5b34..24d35ac1089 100644 --- a/codegen/sdk/aws-models/medialive.json +++ b/codegen/sdk/aws-models/medialive.json @@ -628,6 +628,23 @@ "smithy.api#documentation": "Placeholder documentation for AccountConfiguration" } }, + "com.amazonaws.medialive#AdditionalDestinations": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.medialive#OutputLocationRef", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The destination location", + "smithy.api#jsonName": "destination", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Additional output destinations for a CMAF Ingest output group" + } + }, "com.amazonaws.medialive#AfdSignaling": { "type": "enum", "members": { @@ -1769,7 +1786,7 @@ } }, "BufSize": { - "target": "com.amazonaws.medialive#__integerMin50000Max16000000", + "target": "com.amazonaws.medialive#__integerMin50000Max24000000", "traits": { "smithy.api#documentation": "The size of the buffer (HRD buffer model) in bits.", "smithy.api#jsonName": "bufSize" @@ -1836,7 +1853,7 @@ } }, "MaxBitrate": { - "target": "com.amazonaws.medialive#__integerMin50000Max8000000", + "target": "com.amazonaws.medialive#__integerMin50000Max12000000", "traits": { "smithy.api#documentation": "The maximum bitrate to assign.\nFor recommendations, see the description for qvbrQualityLevel.", "smithy.api#jsonName": "maxBitrate" @@ -1885,7 +1902,7 @@ } }, "Bitrate": { - "target": "com.amazonaws.medialive#__integerMin50000Max8000000", + "target": "com.amazonaws.medialive#__integerMin50000Max12000000", "traits": { "smithy.api#documentation": "Average bitrate in bits/second. Required when the rate control mode is CBR. Not used for QVBR.", "smithy.api#jsonName": "bitrate" @@ -1897,6 +1914,13 @@ "smithy.api#documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates.", "smithy.api#jsonName": "rateControlMode" } + }, + "MinBitrate": { + "target": "com.amazonaws.medialive#__integerMin0Max8000000", + "traits": { + "smithy.api#documentation": "Used for QVBR rate control mode only.\nOptional.\nEnter a minimum bitrate if you want to keep the output bitrate about a threshold, in order to prevent the downstream system from de-allocating network bandwidth for this output.", + "smithy.api#jsonName": "minBitrate" + } } }, "traits": { @@ -2884,12 +2908,45 @@ "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.", "smithy.api#jsonName": "yPosition" } + }, + "SubtitleRows": { + "target": "com.amazonaws.medialive#BurnInDestinationSubtitleRows", + "traits": { + "smithy.api#documentation": "Applies only when the input captions are Teletext and the output captions are DVB-Sub or Burn-In. Choose the number of lines for the captions bitmap. The captions bitmap is 700 wide × 576 high and will be laid over the video. For example, a value of 16 divides the bitmap into 16 lines, with each line 36 pixels high (16 × 36 = 576). The default is 24 (24 pixels high). Enter the same number in every encode in every output that converts the same Teletext source to DVB-Sub or Burn-in.", + "smithy.api#jsonName": "subtitleRows" + } } }, "traits": { "smithy.api#documentation": "Burn In Destination Settings" } }, + "com.amazonaws.medialive#BurnInDestinationSubtitleRows": { + "type": "enum", + "members": { + "ROWS_16": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROWS_16" + } + }, + "ROWS_20": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROWS_20" + } + }, + "ROWS_24": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROWS_24" + } + } + }, + "traits": { + "smithy.api#documentation": "Burn In Destination Subtitle Rows" + } + }, "com.amazonaws.medialive#BurnInFontColor": { "type": "enum", "members": { @@ -4692,6 +4749,13 @@ "smithy.api#documentation": "Set to enabled to pass through ID3 metadata from the input sources.", "smithy.api#jsonName": "timedMetadataPassthrough" } + }, + "AdditionalDestinations": { + "target": "com.amazonaws.medialive#__listOfAdditionalDestinations", + "traits": { + "smithy.api#documentation": "Optional an array of additional destinational HTTP destinations for the OutputGroup outputs", + "smithy.api#jsonName": "additionalDestinations" + } } }, "traits": { @@ -13125,6 +13189,13 @@ "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", "smithy.api#jsonName": "yPosition" } + }, + "SubtitleRows": { + "target": "com.amazonaws.medialive#DvbSubDestinationSubtitleRows", + "traits": { + "smithy.api#documentation": "Applies only when the input captions are Teletext and the output captions are DVB-Sub or Burn-In. Choose the number of lines for the captions bitmap. The captions bitmap is 700 wide × 576 high and will be laid over the video. For example, a value of 16 divides the bitmap into 16 lines, with each line 36 pixels high (16 × 36 = 576). The default is 24 (24 pixels high). Enter the same number in every encode in every output that converts the same Teletext source to DVB-Sub or Burn-in.", + "smithy.api#jsonName": "subtitleRows" + } } }, "traits": { @@ -13157,6 +13228,32 @@ "smithy.api#documentation": "Dvb Sub Destination Shadow Color" } }, + "com.amazonaws.medialive#DvbSubDestinationSubtitleRows": { + "type": "enum", + "members": { + "ROWS_16": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROWS_16" + } + }, + "ROWS_20": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROWS_20" + } + }, + "ROWS_24": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROWS_24" + } + } + }, + "traits": { + "smithy.api#documentation": "Dvb Sub Destination Subtitle Rows" + } + }, "com.amazonaws.medialive#DvbSubDestinationTeletextGridControl": { "type": "enum", "members": { @@ -16658,7 +16755,7 @@ "AdaptiveQuantization": { "target": "com.amazonaws.medialive#H264AdaptiveQuantization", "traits": { - "smithy.api#documentation": "Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization.", + "smithy.api#documentation": "Enables or disables adaptive quantization (AQ), which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: spatial, temporal, and flicker. We recommend that you set the field to Auto. For more information about all the options, see the topic about video adaptive quantization in the MediaLive user guide.", "smithy.api#jsonName": "adaptiveQuantization" } }, @@ -16728,7 +16825,7 @@ "FlickerAq": { "target": "com.amazonaws.medialive#H264FlickerAq", "traits": { - "smithy.api#documentation": "Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ.", + "smithy.api#documentation": "Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field. For more information, see the topic about video adaptive quantization in the MediaLive user guide.", "smithy.api#jsonName": "flickerAq" } }, @@ -16910,7 +17007,7 @@ "SpatialAq": { "target": "com.amazonaws.medialive#H264SpatialAq", "traits": { - "smithy.api#documentation": "Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ.", + "smithy.api#documentation": "Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field. For more information, see the topic about video adaptive quantization in the MediaLive user guide.", "smithy.api#jsonName": "spatialAq" } }, @@ -16931,7 +17028,7 @@ "TemporalAq": { "target": "com.amazonaws.medialive#H264TemporalAq", "traits": { - "smithy.api#documentation": "Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ.", + "smithy.api#documentation": "Temporal makes adjustments within each frame based on variations in content complexity over time. The value to enter in this field depends on the value in the Adaptive quantization field. For more information, see the topic about video adaptive quantization in the MediaLive user guide.", "smithy.api#jsonName": "temporalAq" } }, @@ -16955,6 +17052,13 @@ "smithy.api#documentation": "Sets the minimum QP. If you aren't familiar with quantization adjustment, leave the field empty. MediaLive will\napply an appropriate value.", "smithy.api#jsonName": "minQp" } + }, + "MinBitrate": { + "target": "com.amazonaws.medialive#__integerMin0", + "traits": { + "smithy.api#documentation": "Used for QVBR rate control mode only.\nOptional.\nEnter a minimum bitrate if you want to keep the output bitrate about a threshold, in order to prevent the downstream system from de-allocating network bandwidth for this output.", + "smithy.api#jsonName": "minBitrate" + } } }, "traits": { @@ -17249,6 +17353,26 @@ "smithy.api#documentation": "H265 Flicker Aq" } }, + "com.amazonaws.medialive#H265GopBReference": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "H265 Gop BReference" + } + }, "com.amazonaws.medialive#H265GopSizeUnits": { "type": "enum", "members": { @@ -17519,7 +17643,7 @@ "AdaptiveQuantization": { "target": "com.amazonaws.medialive#H265AdaptiveQuantization", "traits": { - "smithy.api#documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", + "smithy.api#documentation": "Enables or disables adaptive quantization (AQ), which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: spatial, temporal, and flicker. Flicker is the only type that you can customize. We recommend that you set the field to Auto. For more information about all the options, see the topic about video adaptive quantization in the MediaLive user guide.", "smithy.api#jsonName": "adaptiveQuantization" } }, @@ -17582,7 +17706,7 @@ "FlickerAq": { "target": "com.amazonaws.medialive#H265FlickerAq", "traits": { - "smithy.api#documentation": "If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.", + "smithy.api#documentation": "Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field. For more information, see the topic about video adaptive quantization in the MediaLive user guide.", "smithy.api#jsonName": "flickerAq" } }, @@ -17785,12 +17909,60 @@ "smithy.api#documentation": "Enable or disable the deblocking filter for this codec. The filter reduces blocking artifacts at block boundaries,\nwhich improves overall video quality. If the filter is disabled, visible block edges might appear in the output,\nespecially at lower bitrates.", "smithy.api#jsonName": "deblocking" } + }, + "GopBReference": { + "target": "com.amazonaws.medialive#H265GopBReference", + "traits": { + "smithy.api#documentation": "Allows the encoder to use a B-Frame as a reference frame as well.\nENABLED: B-frames will also serve as reference frames.\nDISABLED: B-frames won't be reference frames.\nMust be DISABLED if resolution is greater than 1080p or when using tiled hevc encoding.", + "smithy.api#jsonName": "gopBReference" + } + }, + "GopNumBFrames": { + "target": "com.amazonaws.medialive#__integerMin0Max3", + "traits": { + "smithy.api#documentation": "Sets the number of B-frames between reference frames.\nSet to 2 if resolution is greater than 1080p or when using tiled hevc encoding.", + "smithy.api#jsonName": "gopNumBFrames" + } + }, + "MinBitrate": { + "target": "com.amazonaws.medialive#__integerMin0Max40000000", + "traits": { + "smithy.api#documentation": "Used for QVBR rate control mode only.\nOptional.\nEnter a minimum bitrate if you want to keep the output bitrate about a threshold, in order to prevent the downstream system from de-allocating network bandwidth for this output.", + "smithy.api#jsonName": "minBitrate" + } + }, + "SubgopLength": { + "target": "com.amazonaws.medialive#H265SubGopLength", + "traits": { + "smithy.api#documentation": "Sets the number of B-frames in each sub-GOP.\nFIXED: Use the value in Num B-frames.\nDYNAMIC: Optimizes the number of B-frames in each sub-GOP to improve visual quality.\nMust be FIXED if resolution is greater than 1080p or when using tiled hevc encoding.", + "smithy.api#jsonName": "subgopLength" + } } }, "traits": { "smithy.api#documentation": "H265 Settings" } }, + "com.amazonaws.medialive#H265SubGopLength": { + "type": "enum", + "members": { + "DYNAMIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNAMIC" + } + }, + "FIXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIXED" + } + } + }, + "traits": { + "smithy.api#documentation": "H265 Sub Gop Length" + } + }, "com.amazonaws.medialive#H265Tier": { "type": "enum", "members": { @@ -17996,6 +18168,32 @@ "smithy.api#documentation": "Hls Akamai Settings" } }, + "com.amazonaws.medialive#HlsAutoSelect": { + "type": "enum", + "members": { + "NO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO" + } + }, + "OMIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OMIT" + } + }, + "YES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YES" + } + } + }, + "traits": { + "smithy.api#documentation": "Hls Auto Select" + } + }, "com.amazonaws.medialive#HlsBasicPutSettings": { "type": "structure", "members": { @@ -18136,6 +18334,32 @@ "smithy.api#documentation": "Hls Codec Specification" } }, + "com.amazonaws.medialive#HlsDefault": { + "type": "enum", + "members": { + "NO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO" + } + }, + "OMIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OMIT" + } + }, + "YES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YES" + } + } + }, + "traits": { + "smithy.api#documentation": "Hls Default" + } + }, "com.amazonaws.medialive#HlsDirectoryStructure": { "type": "enum", "members": { @@ -25921,17 +26145,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -25945,28 +26158,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -25980,17 +26171,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -26077,6 +26257,13 @@ "smithy.api#jsonName": "destination", "smithy.api#required": {} } + }, + "MediapackageV2GroupSettings": { + "target": "com.amazonaws.medialive#MediaPackageV2GroupSettings", + "traits": { + "smithy.api#documentation": "Parameters that apply only if the destination parameter (for the output group) specifies a channelGroup and channelName. Use of these two paramters indicates that the output group is for MediaPackage V2 (CMAF Ingest).", + "smithy.api#jsonName": "mediapackageV2GroupSettings" + } } }, "traits": { @@ -26114,11 +26301,70 @@ }, "com.amazonaws.medialive#MediaPackageOutputSettings": { "type": "structure", - "members": {}, + "members": { + "MediaPackageV2DestinationSettings": { + "target": "com.amazonaws.medialive#MediaPackageV2DestinationSettings", + "traits": { + "smithy.api#documentation": "Optional settings for MediaPackage V2 destinations", + "smithy.api#jsonName": "mediaPackageV2DestinationSettings" + } + } + }, "traits": { "smithy.api#documentation": "Media Package Output Settings" } }, + "com.amazonaws.medialive#MediaPackageV2DestinationSettings": { + "type": "structure", + "members": { + "AudioGroupId": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Applies only to an output that contains audio. If you want to put several audio encodes into one audio rendition group, decide on a name (ID) for the group. Then in every audio output that you want to belong to that group, enter that ID in this field. Note that this information is part of the HLS specification (not the CMAF specification), but if you include it then MediaPackage will include it in the manifest it creates for the video player.", + "smithy.api#jsonName": "audioGroupId" + } + }, + "AudioRenditionSets": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Applies only to an output that contains video, and only if you want to associate one or more audio groups to this video. In this field you assign the groups that you create (in the Group ID fields in the various audio outputs). Enter one group ID, or enter a comma-separated list of group IDs. Note that this information is part of the HLS specification (not the CMAF specification), but if you include it then MediaPackage will include it in the manifest it creates for the video player.", + "smithy.api#jsonName": "audioRenditionSets" + } + }, + "HlsAutoSelect": { + "target": "com.amazonaws.medialive#HlsAutoSelect", + "traits": { + "smithy.api#documentation": "Specifies whether MediaPackage should set this output as the auto-select rendition in the HLS manifest. YES means this must be the auto-select. NO means this should never be the auto-select. OMIT means MediaPackage decides what to set on this rendition.\nWhen you consider all the renditions, follow these guidelines. You can set zero or one renditions to YES. You can set zero or more renditions to NO, but you can't set all renditions to NO. You can set zero, some, or all to OMIT.", + "smithy.api#jsonName": "hlsAutoSelect" + } + }, + "HlsDefault": { + "target": "com.amazonaws.medialive#HlsDefault", + "traits": { + "smithy.api#documentation": "Specifies whether MediaPackage should set this output as the default rendition in the HLS manifest. YES means this must be the default. NO means this should never be the default. OMIT means MediaPackage decides what to set on this rendition.\nWhen you consider all the renditions, follow these guidelines. You can set zero or one renditions to YES. You can set zero or more renditions to NO, but you can't set all renditions to NO. You can set zero, some, or all to OMIT.", + "smithy.api#jsonName": "hlsDefault" + } + } + }, + "traits": { + "smithy.api#documentation": "Media Package V2 Destination Settings" + } + }, + "com.amazonaws.medialive#MediaPackageV2GroupSettings": { + "type": "structure", + "members": { + "CaptionLanguageMappings": { + "target": "com.amazonaws.medialive#__listOfCaptionLanguageMapping", + "traits": { + "smithy.api#documentation": "Mapping of up to 4 caption channels to caption languages.", + "smithy.api#jsonName": "captionLanguageMappings" + } + } + }, + "traits": { + "smithy.api#documentation": "Media Package V2 Group Settings" + } + }, "com.amazonaws.medialive#MediaResource": { "type": "structure", "members": { @@ -38017,6 +38263,16 @@ } } }, + "com.amazonaws.medialive#__integerMin0Max3": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __integerMin0Max3", + "smithy.api#range": { + "min": 0, + "max": 3 + } + } + }, "com.amazonaws.medialive#__integerMin0Max30": { "type": "integer", "traits": { @@ -38047,6 +38303,16 @@ } } }, + "com.amazonaws.medialive#__integerMin0Max40000000": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __integerMin0Max40000000", + "smithy.api#range": { + "min": 0, + "max": 40000000 + } + } + }, "com.amazonaws.medialive#__integerMin0Max500": { "type": "integer", "traits": { @@ -38097,6 +38363,16 @@ } } }, + "com.amazonaws.medialive#__integerMin0Max8000000": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Placeholder documentation for __integerMin0Max8000000", + "smithy.api#range": { + "min": 0, + "max": 8000000 + } + } + }, "com.amazonaws.medialive#__integerMin0Max8191": { "type": "integer", "traits": { @@ -38412,23 +38688,23 @@ } } }, - "com.amazonaws.medialive#__integerMin50000Max16000000": { + "com.amazonaws.medialive#__integerMin50000Max12000000": { "type": "integer", "traits": { - "smithy.api#documentation": "Placeholder documentation for __integerMin50000Max16000000", + "smithy.api#documentation": "Placeholder documentation for __integerMin50000Max12000000", "smithy.api#range": { "min": 50000, - "max": 16000000 + "max": 12000000 } } }, - "com.amazonaws.medialive#__integerMin50000Max8000000": { + "com.amazonaws.medialive#__integerMin50000Max24000000": { "type": "integer", "traits": { - "smithy.api#documentation": "Placeholder documentation for __integerMin50000Max8000000", + "smithy.api#documentation": "Placeholder documentation for __integerMin50000Max24000000", "smithy.api#range": { "min": 50000, - "max": 8000000 + "max": 24000000 } } }, @@ -38512,6 +38788,15 @@ } } }, + "com.amazonaws.medialive#__listOfAdditionalDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.medialive#AdditionalDestinations" + }, + "traits": { + "smithy.api#documentation": "Placeholder documentation for __listOfAdditionalDestinations" + } + }, "com.amazonaws.medialive#__listOfAudioChannelMapping": { "type": "list", "member": { diff --git a/codegen/sdk/aws-models/mediapackage-vod.json b/codegen/sdk/aws-models/mediapackage-vod.json index a8b7c94ca36..2ff4e5a8573 100644 --- a/codegen/sdk/aws-models/mediapackage-vod.json +++ b/codegen/sdk/aws-models/mediapackage-vod.json @@ -2085,6 +2085,9 @@ "name": "mediapackage-vod" }, "aws.protocols#restJson1": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], "smithy.api#documentation": "AWS Elemental MediaPackage VOD", "smithy.api#title": "AWS Elemental MediaPackage VOD", "smithy.rules#endpointRuleSet": { @@ -2741,17 +2744,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2765,17 +2757,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2789,17 +2770,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2813,17 +2783,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/mediapackage.json b/codegen/sdk/aws-models/mediapackage.json index f960d3bee5e..24c03f7df27 100644 --- a/codegen/sdk/aws-models/mediapackage.json +++ b/codegen/sdk/aws-models/mediapackage.json @@ -2609,6 +2609,9 @@ "name": "mediapackage" }, "aws.protocols#restJson1": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], "smithy.api#documentation": "AWS Elemental MediaPackage", "smithy.api#title": "AWS Elemental MediaPackage", "smithy.rules#endpointRuleSet": { @@ -3278,17 +3281,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3302,28 +3294,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3337,17 +3307,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/mediapackagev2.json b/codegen/sdk/aws-models/mediapackagev2.json index 96d629b7976..381aa3bebb4 100644 --- a/codegen/sdk/aws-models/mediapackagev2.json +++ b/codegen/sdk/aws-models/mediapackagev2.json @@ -9,7 +9,7 @@ } }, "traits": { - "smithy.api#documentation": "

Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. The user or role that is making the request must have at least \n one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide. Or, if you're using CDN authorization, you will receive this exception\n if MediaPackage receives a throttling error from Secrets Manager.

", + "smithy.api#documentation": "

Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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 in the IAM User Guide. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -39,6 +39,12 @@ "traits": { "smithy.api#enumValue": "DATERANGE" } + }, + "SCTE35_ENHANCED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCTE35_ENHANCED" + } } } }, @@ -343,7 +349,7 @@ "InputType": { "target": "com.amazonaws.mediapackagev2#InputType", "traits": { - "smithy.api#documentation": "

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

\n

The allowed values are:

\n
    \n
  • \n

    \n HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

    \n
  • \n
  • \n

    \n CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

    \n
  • \n
" + "smithy.api#documentation": "

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

The allowed values are:

  • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

  • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

" } } }, @@ -703,7 +709,7 @@ "target": "com.amazonaws.mediapackagev2#TagMap", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

A comma-separated list of tag key:value pairs that you define. For example:

\n

\n \"Key1\": \"Value1\",\n

\n

\n \"Key2\": \"Value2\"\n

", + "smithy.api#documentation": "

A comma-separated list of tag key:value pairs that you define. For example:

\"Key1\": \"Value1\",

\"Key2\": \"Value2\"

", "smithy.api#jsonName": "tags" } } @@ -804,7 +810,7 @@ "InputType": { "target": "com.amazonaws.mediapackagev2#InputType", "traits": { - "smithy.api#documentation": "

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

\n

The allowed values are:

\n
    \n
  • \n

    \n HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

    \n
  • \n
  • \n

    \n CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

    \n
  • \n
" + "smithy.api#documentation": "

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

The allowed values are:

  • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

  • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

" } }, "Description": { @@ -829,7 +835,7 @@ "target": "com.amazonaws.mediapackagev2#TagMap", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

A comma-separated list of tag key:value pairs that you define. For example:

\n

\n \"Key1\": \"Value1\",\n

\n

\n \"Key2\": \"Value2\"\n

", + "smithy.api#documentation": "

A comma-separated list of tag key:value pairs that you define. For example:

\"Key1\": \"Value1\",

\"Key2\": \"Value2\"

", "smithy.api#jsonName": "tags" } } @@ -888,7 +894,7 @@ "InputType": { "target": "com.amazonaws.mediapackagev2#InputType", "traits": { - "smithy.api#documentation": "

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

\n

The allowed values are:

\n
    \n
  • \n

    \n HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

    \n
  • \n
  • \n

    \n CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

    \n
  • \n
" + "smithy.api#documentation": "

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

The allowed values are:

  • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

  • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

" } }, "ETag": { @@ -977,13 +983,13 @@ "SegmentTemplateFormat": { "target": "com.amazonaws.mediapackagev2#DashSegmentTemplateFormat", "traits": { - "smithy.api#documentation": "

Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

\n

Value description:

\n
    \n
  • \n

    \n NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

    \n
  • \n
" + "smithy.api#documentation": "

Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

Value description:

  • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

" } }, "PeriodTriggers": { "target": "com.amazonaws.mediapackagev2#DashPeriodTriggers", "traits": { - "smithy.api#documentation": "

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period.\n For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

" + "smithy.api#documentation": "

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

" } }, "ScteDash": { @@ -1031,7 +1037,7 @@ "Compactness": { "target": "com.amazonaws.mediapackagev2#DashCompactness", "traits": { - "smithy.api#documentation": "

The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.

\n

For information about compactness, see DASH manifest compactness in the Elemental MediaPackage v2 User Guide.

" + "smithy.api#documentation": "

The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.

For information about compactness, see DASH manifest compactness in the Elemental MediaPackage v2 User Guide.

" } }, "SubtitleConfiguration": { @@ -1403,7 +1409,7 @@ "ProgramDateTimeIntervalSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", + "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", "smithy.api#range": { "min": 1, "max": 1209600 @@ -1416,7 +1422,7 @@ "UrlEncodeChildManifest": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol.\n For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.

" + "smithy.api#documentation": "

When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.

" } } }, @@ -1464,7 +1470,7 @@ "ProgramDateTimeIntervalSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", + "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", "smithy.api#range": { "min": 1, "max": 1209600 @@ -1477,7 +1483,7 @@ "UrlEncodeChildManifest": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol.\n For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.

" + "smithy.api#documentation": "

When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.

" } } }, @@ -2384,7 +2390,7 @@ "target": "com.amazonaws.mediapackagev2#TagMap", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

A comma-separated list of tag key:value pairs that you define. For example:

\n

\n \"Key1\": \"Value1\",\n

\n

\n \"Key2\": \"Value2\"\n

" + "smithy.api#documentation": "

A comma-separated list of tag key:value pairs that you define. For example:

\"Key1\": \"Value1\",

\"Key2\": \"Value2\"

" } } }, @@ -2635,7 +2641,7 @@ "MimeType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The mimeType of the resource that's at the font download URL.

\n

For information about font MIME types, see the MPEG-DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document.

", + "smithy.api#documentation": "

The mimeType of the resource that's at the font download URL.

For information about font MIME types, see the MPEG-DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document.

", "smithy.api#length": { "min": 1, "max": 256 @@ -2867,7 +2873,7 @@ "TtmlProfile": { "target": "com.amazonaws.mediapackagev2#DashTtmlProfile", "traits": { - "smithy.api#documentation": "

The profile that MediaPackage uses when signaling subtitles in the manifest. IMSC is the default profile. \n EBU-TT-D produces subtitles that are compliant with the EBU-TT-D TTML profile. \n MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see EBU-TT-D Subtitling Distribution Format.

", + "smithy.api#documentation": "

The profile that MediaPackage uses when signaling subtitles in the manifest. IMSC is the default profile. EBU-TT-D produces subtitles that are compliant with the EBU-TT-D TTML profile. MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see EBU-TT-D Subtitling Distribution Format.

", "smithy.api#required": {} } } @@ -3417,7 +3423,7 @@ "KeyRotationIntervalSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

\n

The following example setting causes the service to rotate keys every thirty minutes: 1800\n

", + "smithy.api#documentation": "

The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

The following example setting causes the service to rotate keys every thirty minutes: 1800

", "smithy.api#range": { "min": 300, "max": 31536000 @@ -3427,7 +3433,7 @@ "CmafExcludeSegmentDrmMetadata": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.

\n

When set to true, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.

\n

Important considerations:

\n
    \n
  • \n

    This setting only affects CMAF container formats

    \n
  • \n
  • \n

    Key rotation can still be handled through media playlist signaling

    \n
  • \n
  • \n

    PSSH and TENC boxes remain unaffected

    \n
  • \n
  • \n

    Default behavior is preserved when this setting is disabled

    \n
  • \n
\n

Valid values: true | false\n

\n

Default: false\n

" + "smithy.api#documentation": "

Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.

When set to true, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.

Important considerations:

  • This setting only affects CMAF container formats

  • Key rotation can still be handled through media playlist signaling

  • PSSH and TENC boxes remain unaffected

  • Default behavior is preserved when this setting is disabled

Valid values: true | false

Default: false

" } }, "SpekeKeyProvider": { @@ -3448,14 +3454,14 @@ "PresetSpeke20Audio": { "target": "com.amazonaws.mediapackagev2#PresetSpeke20Audio", "traits": { - "smithy.api#documentation": "

A collection of audio encryption presets.

\n

Value description:

\n
    \n
  • \n

    PRESET-AUDIO-1 - Use one content key to encrypt all of the\n audio tracks in your stream.

    \n
  • \n
  • \n

    PRESET-AUDIO-2 - Use one content key to encrypt all of the\n stereo audio tracks and one content key to encrypt all of the multichannel\n audio tracks.

    \n
  • \n
  • \n

    PRESET-AUDIO-3 - Use one content key to encrypt all of the\n stereo audio tracks, one content key to encrypt all of the multichannel audio\n tracks with 3 to 6 channels, and one content key to encrypt all of the\n multichannel audio tracks with more than 6 channels.

    \n
  • \n
  • \n

    SHARED - Use the same content key for all of the audio and\n video tracks in your stream.

    \n
  • \n
  • \n

    UNENCRYPTED - Don't encrypt any of the audio tracks in your\n stream.

    \n
  • \n
", + "smithy.api#documentation": "

A collection of audio encryption presets.

Value description:

  • PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.

  • PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.

  • PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.

  • SHARED - Use the same content key for all of the audio and video tracks in your stream.

  • UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.

", "smithy.api#required": {} } }, "PresetSpeke20Video": { "target": "com.amazonaws.mediapackagev2#PresetSpeke20Video", "traits": { - "smithy.api#documentation": "

A collection of video encryption presets.

\n

Value description:

\n
    \n
  • \n

    PRESET-VIDEO-1 - Use one content key to encrypt all of the video\n tracks in your stream.

    \n
  • \n
  • \n

    PRESET-VIDEO-2 - Use one content key to encrypt all of the SD\n video tracks and one content key for all HD and higher resolutions video\n tracks.

    \n
  • \n
  • \n

    PRESET-VIDEO-3 - Use one content key to encrypt all of the SD\n video tracks, one content key for HD video tracks and one content key for all\n UHD video tracks.

    \n
  • \n
  • \n

    PRESET-VIDEO-4 - Use one content key to encrypt all of the SD\n video tracks, one content key for HD video tracks, one content key for all UHD1\n video tracks and one content key for all UHD2 video tracks.

    \n
  • \n
  • \n

    PRESET-VIDEO-5 - Use one content key to encrypt all of the SD\n video tracks, one content key for HD1 video tracks, one content key for HD2\n video tracks, one content key for all UHD1 video tracks and one content key for\n all UHD2 video tracks.

    \n
  • \n
  • \n

    PRESET-VIDEO-6 - Use one content key to encrypt all of the SD\n video tracks, one content key for HD1 video tracks, one content key for HD2\n video tracks and one content key for all UHD video tracks.

    \n
  • \n
  • \n

    PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1\n video tracks, one content key for HD2 video tracks and one content key for all\n UHD video tracks.

    \n
  • \n
  • \n

    PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1\n video tracks, one content key for HD2 video tracks, one content key for all\n UHD1 video tracks and one content key for all UHD2 video tracks.

    \n
  • \n
  • \n

    SHARED - Use the same content key for all of the video and audio\n tracks in your stream.

    \n
  • \n
  • \n

    UNENCRYPTED - Don't encrypt any of the video tracks in your stream.

    \n
  • \n
", + "smithy.api#documentation": "

A collection of video encryption presets.

Value description:

  • PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.

  • PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.

  • PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.

  • PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

  • PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

  • PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

  • PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

  • PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

  • SHARED - Use the same content key for all of the video and audio tracks in your stream.

  • UNENCRYPTED - Don't encrypt any of the video tracks in your stream.

", "smithy.api#required": {} } } @@ -3587,7 +3593,7 @@ "EndpointErrorConditions": { "target": "com.amazonaws.mediapackagev2#EndpointErrorConditions", "traits": { - "smithy.api#documentation": "

The failover conditions for the endpoint. The options are:

\n
    \n
  • \n

    \n STALE_MANIFEST - The manifest stalled and there are no new segments or parts.

    \n
  • \n
  • \n

    \n INCOMPLETE_MANIFEST - There is a gap in the manifest.

    \n
  • \n
  • \n

    \n MISSING_DRM_KEY - Key rotation is enabled but we're unable to fetch the key for the current key period.

    \n
  • \n
  • \n

    \n SLATE_INPUT - The segments which contain slate content are considered to be missing content.

    \n
  • \n
" + "smithy.api#documentation": "

The failover conditions for the endpoint. The options are:

  • STALE_MANIFEST - The manifest stalled and there are no new segments or parts.

  • INCOMPLETE_MANIFEST - There is a gap in the manifest.

  • MISSING_DRM_KEY - Key rotation is enabled but we're unable to fetch the key for the current key period.

  • SLATE_INPUT - The segments which contain slate content are considered to be missing content.

" } } }, @@ -3981,7 +3987,7 @@ "InputType": { "target": "com.amazonaws.mediapackagev2#InputType", "traits": { - "smithy.api#documentation": "

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

\n

The allowed values are:

\n
    \n
  • \n

    \n HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

    \n
  • \n
  • \n

    \n CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

    \n
  • \n
" + "smithy.api#documentation": "

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

The allowed values are:

  • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

  • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

" } }, "ETag": { @@ -4062,13 +4068,13 @@ "SegmentTemplateFormat": { "target": "com.amazonaws.mediapackagev2#DashSegmentTemplateFormat", "traits": { - "smithy.api#documentation": "

Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

\n

Value description:

\n
    \n
  • \n

    \n NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

    \n
  • \n
" + "smithy.api#documentation": "

Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

Value description:

  • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

" } }, "PeriodTriggers": { "target": "com.amazonaws.mediapackagev2#DashPeriodTriggers", "traits": { - "smithy.api#documentation": "

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period.\n For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

" + "smithy.api#documentation": "

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

" } }, "ScteDash": { @@ -4467,7 +4473,7 @@ "ProgramDateTimeIntervalSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

" + "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

" } }, "ScteHls": { @@ -4482,7 +4488,7 @@ "UrlEncodeChildManifest": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol.\n For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.

" + "smithy.api#documentation": "

When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.

" } } }, @@ -4528,7 +4534,7 @@ "ProgramDateTimeIntervalSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

" + "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

" } }, "ScteHls": { @@ -4543,7 +4549,7 @@ "UrlEncodeChildManifest": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol.\n For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.

" + "smithy.api#documentation": "

When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in Identity and Access Management User Guide.

" } } }, @@ -4929,7 +4935,7 @@ "CdnAuthConfiguration": { "target": "com.amazonaws.mediapackagev2#CdnAuthConfiguration", "traits": { - "smithy.api#documentation": "

The settings for using authorization headers between the MediaPackage endpoint and your CDN.

\n

For information about CDN authorization, see CDN authorization\n in Elemental MediaPackage in the MediaPackage user guide.

" + "smithy.api#documentation": "

The settings for using authorization headers between the MediaPackage endpoint and your CDN.

For information about CDN authorization, see CDN authorization in Elemental MediaPackage in the MediaPackage user guide.

" } } }, @@ -7079,7 +7085,7 @@ "CdnAuthConfiguration": { "target": "com.amazonaws.mediapackagev2#CdnAuthConfiguration", "traits": { - "smithy.api#documentation": "

The settings for using authorization headers between the MediaPackage endpoint and your CDN.

\n

For information about CDN authorization, see CDN authorization\n in Elemental MediaPackage in the MediaPackage user guide.

" + "smithy.api#documentation": "

The settings for using authorization headers between the MediaPackage endpoint and your CDN.

For information about CDN authorization, see CDN authorization in Elemental MediaPackage in the MediaPackage user guide.

" } } }, @@ -7124,7 +7130,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Resets a channel", - "smithy.api#documentation": "

Resetting the channel can help to clear errors from misconfigurations in the encoder. A reset refreshes the ingest stream and removes previous content.

\n

Be sure to stop the encoder before you reset the channel, and wait at least 30 seconds before you restart the encoder.

", + "smithy.api#documentation": "

Resetting the channel can help to clear errors from misconfigurations in the encoder. A reset refreshes the ingest stream and removes previous content.

Be sure to stop the encoder before you reset the channel, and wait at least 30 seconds before you restart the encoder.

", "smithy.api#examples": [ { "title": "Reset a Channel", @@ -7237,7 +7243,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to reset an origin endpoint", - "smithy.api#documentation": "

Resetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues. It also helps to preserve special events when you don't want the previous content to be available for viewing. A reset clears out all previous content from the origin endpoint.

\n

MediaPackage might return old content from this endpoint in the first 30 seconds after the endpoint reset. For best results, when possible, wait 30 seconds from endpoint reset to send playback requests to this endpoint.

", + "smithy.api#documentation": "

Resetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues. It also helps to preserve special events when you don't want the previous content to be available for viewing. A reset clears out all previous content from the origin endpoint.

MediaPackage might return old content from this endpoint in the first 30 seconds after the endpoint reset. For best results, when possible, wait 30 seconds from endpoint reset to send playback requests to this endpoint.

", "smithy.api#examples": [ { "title": "Reset an OriginEndpoint", @@ -7465,7 +7471,7 @@ "AdMarkerDash": { "target": "com.amazonaws.mediapackagev2#AdMarkerDash", "traits": { - "smithy.api#documentation": "

Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.

\n

Value description:

\n
    \n
  • \n

    \n Binary - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.

    \n
  • \n
  • \n

    \n XML - The SCTE marker is expressed fully in XML.

    \n
  • \n
" + "smithy.api#documentation": "

Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.

Value description:

  • Binary - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.

  • XML - The SCTE marker is expressed fully in XML.

" } } }, @@ -7550,7 +7556,7 @@ "AdMarkerHls": { "target": "com.amazonaws.mediapackagev2#AdMarkerHls", "traits": { - "smithy.api#documentation": "

Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.

\n

Value description:

\n
    \n
  • \n

    DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

    \n
  • \n
" + "smithy.api#documentation": "

Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.

Value description:

  • DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

" } } }, @@ -7640,7 +7646,7 @@ "ResourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

\n

The following example shows a resource ID: MovieNight20171126093045\n

", + "smithy.api#documentation": "

The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

The following example shows a resource ID: MovieNight20171126093045

", "smithy.api#length": { "min": 1, "max": 256 @@ -7663,7 +7669,7 @@ "RoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

\n

Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess\n

", + "smithy.api#documentation": "

The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess

", "smithy.api#length": { "min": 1, "max": 2048 @@ -7674,7 +7680,7 @@ "Url": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

\n

The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection\n

", + "smithy.api#documentation": "

The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection

", "smithy.api#length": { "min": 1, "max": 1024 @@ -7748,7 +7754,7 @@ "aws:TagKeys", "aws:RequestTag/${TagKey}" ], - "smithy.api#documentation": "

Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions, by granting a user permission to access or change only resources with certain tag values.\n You can use the TagResource operation with a resource that already has tags. If you specify a new tag\n key for the resource, this tag is appended to the list of tags associated with the resource. If you\n specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

", + "smithy.api#documentation": "

Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

", "smithy.api#examples": [ { "title": "Add tags to a resource", @@ -7920,7 +7926,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to update a channel in a channel group", - "smithy.api#documentation": "

Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details.

\n

Any edits you make that impact the video output may not be reflected for a few minutes.

", + "smithy.api#documentation": "

Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details.

Any edits you make that impact the video output may not be reflected for a few minutes.

", "smithy.api#examples": [ { "title": "Updating a Channel", @@ -7993,7 +7999,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to update a channel group", - "smithy.api#documentation": "

Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group.

\n

Any edits you make that impact the video output may not be reflected for a few minutes.

", + "smithy.api#documentation": "

Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group.

Any edits you make that impact the video output may not be reflected for a few minutes.

", "smithy.api#examples": [ { "title": "Updating a Channel Group", @@ -8218,7 +8224,7 @@ "InputType": { "target": "com.amazonaws.mediapackagev2#InputType", "traits": { - "smithy.api#documentation": "

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

\n

The allowed values are:

\n
    \n
  • \n

    \n HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

    \n
  • \n
  • \n

    \n CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

    \n
  • \n
" + "smithy.api#documentation": "

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

The allowed values are:

  • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

  • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

" } }, "ETag": { @@ -8286,7 +8292,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to update an origin endpoint of a channel", - "smithy.api#documentation": "

Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint.

\n

Any edits you make that impact the video output may not be reflected for a few minutes.

", + "smithy.api#documentation": "

Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint.

Any edits you make that impact the video output may not be reflected for a few minutes.

", "smithy.api#examples": [ { "title": "Updating an OriginEndpoint", @@ -9450,7 +9456,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "\n

This guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023.\n To get started with MediaPackage v2, create your MediaPackage resources. There isn't an automated process to\n migrate your resources from MediaPackage v1 to MediaPackage v2.

\n

The names of the entities that you use to access this API, like URLs and ARNs, all have the versioning information\n added, like \"v2\", to distinguish from the prior version. If you used MediaPackage prior to this release, you can't use\n the MediaPackage v2 CLI or the MediaPackage v2 API to access any MediaPackage v1 resources.

\n

If you created resources in MediaPackage v1, use video on demand (VOD) workflows, and aren't looking to migrate to MediaPackage v2 yet,\n see the MediaPackage v1 Live API Reference.

\n
\n

This is the AWS Elemental MediaPackage v2 Live REST API Reference. It describes all the MediaPackage API operations for live content in detail, and provides sample requests, responses, and errors for the supported web services protocols.

\n

We assume that you have the IAM permissions that you need to use MediaPackage via the REST API. We also assume that you are familiar with the features and operations of MediaPackage, as described in the AWS Elemental MediaPackage User Guide.

", + "smithy.api#documentation": "

This guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023. To get started with MediaPackage v2, create your MediaPackage resources. There isn't an automated process to migrate your resources from MediaPackage v1 to MediaPackage v2.

The names of the entities that you use to access this API, like URLs and ARNs, all have the versioning information added, like \"v2\", to distinguish from the prior version. If you used MediaPackage prior to this release, you can't use the MediaPackage v2 CLI or the MediaPackage v2 API to access any MediaPackage v1 resources.

If you created resources in MediaPackage v1, use video on demand (VOD) workflows, and aren't looking to migrate to MediaPackage v2 yet, see the MediaPackage v1 Live API Reference.

This is the AWS Elemental MediaPackage v2 Live REST API Reference. It describes all the MediaPackage API operations for live content in detail, and provides sample requests, responses, and errors for the supported web services protocols.

We assume that you have the IAM permissions that you need to use MediaPackage via the REST API. We also assume that you are familiar with the features and operations of MediaPackage, as described in the AWS Elemental MediaPackage User Guide.

", "smithy.api#title": "AWS Elemental MediaPackage v2", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -9960,17 +9966,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -9984,17 +9979,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -10008,17 +9992,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -10032,17 +10005,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/mediastore-data.json b/codegen/sdk/aws-models/mediastore-data.json index df79af2e7b9..5fdb1f6065d 100644 --- a/codegen/sdk/aws-models/mediastore-data.json +++ b/codegen/sdk/aws-models/mediastore-data.json @@ -1129,17 +1129,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1153,17 +1142,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1177,17 +1155,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1201,17 +1168,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/mediastore.json b/codegen/sdk/aws-models/mediastore.json index 549f33af193..6780399ef3d 100644 --- a/codegen/sdk/aws-models/mediastore.json +++ b/codegen/sdk/aws-models/mediastore.json @@ -1723,17 +1723,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1747,17 +1736,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1771,17 +1749,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1795,17 +1762,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/mediatailor.json b/codegen/sdk/aws-models/mediatailor.json index 17b316e2580..ca025e8c985 100644 --- a/codegen/sdk/aws-models/mediatailor.json +++ b/codegen/sdk/aws-models/mediatailor.json @@ -3327,14 +3327,14 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of alerts that you want MediaTailor to return in response to the current request. If there are more than MaxResults alerts, use the value of NextToken in the response to get the next page of results.

", + "smithy.api#documentation": "

The maximum number of alerts that you want MediaTailor to return in response to the current request. If there are more than MaxResults alerts, use the value of NextToken in the response to get the next page of results.

The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

", + "smithy.api#documentation": "

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

For the first ListAlerts request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

", "smithy.api#httpQuery": "nextToken" } }, @@ -3395,14 +3395,14 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than MaxResults channels, use the value of NextToken in the response to get the next page of results.

", + "smithy.api#documentation": "

The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than MaxResults channels, use the value of NextToken in the response to get the next page of results.

The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

", + "smithy.api#documentation": "

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

For the first ListChannels request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

", "smithy.api#httpQuery": "nextToken" } } @@ -3455,14 +3455,14 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults live sources, use the value of NextToken in the response to get the next page of results.

", + "smithy.api#documentation": "

The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults live sources, use the value of NextToken in the response to get the next page of results.

The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

", + "smithy.api#documentation": "

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

For the first ListLiveSources request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

", "smithy.api#httpQuery": "nextToken" } }, @@ -3523,14 +3523,14 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of playback configurations that you want MediaTailor to return in response to the current request. If there are more than MaxResults playback configurations, use the value of NextToken in the response to get the next page of results.

", + "smithy.api#documentation": "

The maximum number of playback configurations that you want MediaTailor to return in response to the current request. If there are more than MaxResults playback configurations, use the value of NextToken in the response to get the next page of results.

The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

", + "smithy.api#documentation": "

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

For the first ListPlaybackConfigurations request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

", "smithy.api#httpQuery": "NextToken" } } @@ -3609,13 +3609,13 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#__integerMin1Max100", "traits": { - "smithy.api#documentation": "

The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.

" + "smithy.api#documentation": "

The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.

The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.

" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

(Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages of results.

For the first ListPrefetchSchedulesRequest request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

If the previous response didn't include a NextToken element, there are no more prefetch schedules to get.

" + "smithy.api#documentation": "

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

For the first ListPrefetchSchedules request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

" } }, "PlaybackConfigurationName": { @@ -3687,14 +3687,14 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of source locations that you want MediaTailor to return in response to the current request. If there are more than MaxResults source locations, use the value of NextToken in the response to get the next page of results.

", + "smithy.api#documentation": "

The maximum number of source locations that you want MediaTailor to return in response to the current request. If there are more than MaxResults source locations, use the value of NextToken in the response to get the next page of results.

The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

", + "smithy.api#documentation": "

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

For the first ListSourceLocations request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

", "smithy.api#httpQuery": "nextToken" } } @@ -3795,14 +3795,14 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults VOD sources, use the value of NextToken in the response to get the next page of results.

", + "smithy.api#documentation": "

The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults VOD sources, use the value of NextToken in the response to get the next page of results.

The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

", + "smithy.api#documentation": "

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

For the first ListVodSources request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4894,17 +4894,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4918,17 +4907,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4942,17 +4920,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4966,17 +4933,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5355,7 +5311,7 @@ "TrafficShapingType": { "target": "com.amazonaws.mediatailor#TrafficShapingType", "traits": { - "smithy.api#documentation": "

Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.

" + "smithy.api#documentation": "

Indicates the type of traffic shaping used for prefetch traffic shaping and limiting the number of requests to the ADS at one time.

" } }, "TrafficShapingRetrievalWindow": { @@ -5363,6 +5319,12 @@ "traits": { "smithy.api#documentation": "

Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.

" } + }, + "TrafficShapingTpsConfiguration": { + "target": "com.amazonaws.mediatailor#TrafficShapingTpsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for TPS-based traffic shaping that limits the number of requests to the ad decision server (ADS) based on transactions per second instead of time windows.

" + } } }, "traits": { @@ -5878,7 +5840,7 @@ "TrafficShapingType": { "target": "com.amazonaws.mediatailor#TrafficShapingType", "traits": { - "smithy.api#documentation": "

Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.

" + "smithy.api#documentation": "

Indicates the type of traffic shaping used for traffic shaping and limiting the number of requests to the ADS at one time.

" } }, "TrafficShapingRetrievalWindow": { @@ -5886,6 +5848,12 @@ "traits": { "smithy.api#documentation": "

Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.

" } + }, + "TrafficShapingTpsConfiguration": { + "target": "com.amazonaws.mediatailor#TrafficShapingTpsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for TPS-based traffic shaping that limits the number of requests to the ad decision server (ADS) based on transactions per second instead of time windows.

" + } } }, "traits": { @@ -6607,6 +6575,26 @@ "smithy.api#documentation": "

The configuration that tells Elemental MediaTailor how to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.

" } }, + "com.amazonaws.mediatailor#TrafficShapingTpsConfiguration": { + "type": "structure", + "members": { + "PeakTps": { + "target": "com.amazonaws.mediatailor#__integer", + "traits": { + "smithy.api#documentation": "

The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle. MediaTailor uses this value along with concurrent users and headroom multiplier to calculate optimal traffic distribution and prevent ADS overload.

" + } + }, + "PeakConcurrentUsers": { + "target": "com.amazonaws.mediatailor#__integer", + "traits": { + "smithy.api#documentation": "

The expected peak number of concurrent viewers for your content. MediaTailor uses this value along with peak TPS to determine how to distribute prefetch requests across the available capacity without exceeding your ADS limits.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users, providing more intuitive capacity management compared to time-window based traffic shaping.

" + } + }, "com.amazonaws.mediatailor#TrafficShapingType": { "type": "enum", "members": { @@ -6615,6 +6603,12 @@ "traits": { "smithy.api#enumValue": "RETRIEVAL_WINDOW" } + }, + "TPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TPS" + } } } }, diff --git a/codegen/sdk/aws-models/medical-imaging.json b/codegen/sdk/aws-models/medical-imaging.json index 536030ce143..8fa214af4e9 100644 --- a/codegen/sdk/aws-models/medical-imaging.json +++ b/codegen/sdk/aws-models/medical-imaging.json @@ -590,17 +590,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -614,17 +603,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -638,17 +616,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -662,17 +629,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1119,6 +1075,9 @@ { "target": "com.amazonaws.medicalimaging#InternalServerException" }, + { + "target": "com.amazonaws.medicalimaging#ResourceNotFoundException" + }, { "target": "com.amazonaws.medicalimaging#ServiceQuotaExceededException" }, @@ -1170,6 +1129,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.

" } + }, + "lambdaAuthorizerArn": { + "target": "com.amazonaws.medicalimaging#LambdaArn", + "traits": { + "smithy.api#documentation": "

The ARN of the authorizer's Lambda function.

" + } } }, "traits": { @@ -1365,7 +1330,7 @@ "smithy.api#default": 0, "smithy.api#range": { "min": 0, - "max": 10000 + "max": 1000000 } } }, @@ -1436,7 +1401,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "^(?:[0-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*$", + "smithy.api#pattern": "^(?:[0-9][0-9]*|0)(\\.(?:[0-9][0-9]*|0))*$", "smithy.api#sensitive": {} } }, @@ -1496,7 +1461,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 64 + "max": 256 }, "smithy.api#sensitive": {} } @@ -1506,7 +1471,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 16 + "max": 256 }, "smithy.api#sensitive": {} } @@ -1518,7 +1483,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "^(?:[0-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*$", + "smithy.api#pattern": "^(?:[0-9][0-9]*|0)(\\.(?:[0-9][0-9]*|0))*$", "smithy.api#sensitive": {} } }, @@ -1704,6 +1669,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.

" } }, + "lambdaAuthorizerArn": { + "target": "com.amazonaws.medicalimaging#LambdaArn", + "traits": { + "smithy.api#documentation": "

The ARN of the authorizer's Lambda function.

" + } + }, "datastoreArn": { "target": "com.amazonaws.medicalimaging#Arn", "traits": { @@ -2735,6 +2706,24 @@ "traits": { "smithy.api#enumValue": "DELETED" } + }, + "IMPORTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORTING" + } + }, + "IMPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORTED" + } + }, + "IMPORT_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_FAILED" + } } } }, @@ -2866,6 +2855,12 @@ "smithy.api#pattern": "^arn:aws[a-zA-Z-]{0,16}:kms:[a-z]{2}(-[a-z]{1,16}){1,3}-\\d{1}:\\d{12}:((key/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})|(alias/[a-zA-Z0-9:/_-]{1,256}))$" } }, + "com.amazonaws.medicalimaging#LambdaArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, "com.amazonaws.medicalimaging#ListDICOMImportJobs": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/memorydb.json b/codegen/sdk/aws-models/memorydb.json index ff99ddb6033..20a3f7f5898 100644 --- a/codegen/sdk/aws-models/memorydb.json +++ b/codegen/sdk/aws-models/memorydb.json @@ -1111,17 +1111,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1135,17 +1124,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1159,17 +1137,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1183,17 +1150,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/mgn.json b/codegen/sdk/aws-models/mgn.json index 2e10d0a41c4..ff794db18de 100644 --- a/codegen/sdk/aws-models/mgn.json +++ b/codegen/sdk/aws-models/mgn.json @@ -1146,17 +1146,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1170,17 +1159,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1194,17 +1172,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1218,17 +1185,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/migration-hub-refactor-spaces.json b/codegen/sdk/aws-models/migration-hub-refactor-spaces.json index ed11bcaed80..76f6d3016fb 100644 --- a/codegen/sdk/aws-models/migration-hub-refactor-spaces.json +++ b/codegen/sdk/aws-models/migration-hub-refactor-spaces.json @@ -4028,17 +4028,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4052,17 +4041,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4076,17 +4054,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4100,17 +4067,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/migration-hub.json b/codegen/sdk/aws-models/migration-hub.json index a10fc66f2ff..6a9112556e1 100644 --- a/codegen/sdk/aws-models/migration-hub.json +++ b/codegen/sdk/aws-models/migration-hub.json @@ -662,17 +662,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -686,17 +675,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -710,17 +688,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -734,17 +701,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/migrationhub-config.json b/codegen/sdk/aws-models/migrationhub-config.json index 8cc6b4f6fb5..53eda45e9db 100644 --- a/codegen/sdk/aws-models/migrationhub-config.json +++ b/codegen/sdk/aws-models/migrationhub-config.json @@ -532,17 +532,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -556,17 +545,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -580,17 +558,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -604,17 +571,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/migrationhuborchestrator.json b/codegen/sdk/aws-models/migrationhuborchestrator.json index c2586e1e8bb..9147c56055b 100644 --- a/codegen/sdk/aws-models/migrationhuborchestrator.json +++ b/codegen/sdk/aws-models/migrationhuborchestrator.json @@ -591,17 +591,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -615,17 +604,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -639,17 +617,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -663,17 +630,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/migrationhubstrategy.json b/codegen/sdk/aws-models/migrationhubstrategy.json index a731d12e448..d35eeee9bf8 100644 --- a/codegen/sdk/aws-models/migrationhubstrategy.json +++ b/codegen/sdk/aws-models/migrationhubstrategy.json @@ -634,17 +634,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -658,17 +647,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -682,17 +660,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -706,17 +673,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/mpa.json b/codegen/sdk/aws-models/mpa.json index 46083531c2b..9776aeec23b 100644 --- a/codegen/sdk/aws-models/mpa.json +++ b/codegen/sdk/aws-models/mpa.json @@ -321,102 +321,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://mpa-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://mpa.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://mpa-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://mpa.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://mpa-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://mpa.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://mpa-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://mpa.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { diff --git a/codegen/sdk/aws-models/mq.json b/codegen/sdk/aws-models/mq.json index 840adbe8f75..c035a755120 100644 --- a/codegen/sdk/aws-models/mq.json +++ b/codegen/sdk/aws-models/mq.json @@ -65,6 +65,12 @@ "traits": { "smithy.api#enumValue": "LDAP" } + }, + "CONFIG_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFIG_MANAGED" + } } }, "traits": { @@ -758,10 +764,8 @@ "Users": { "target": "com.amazonaws.mq#__listOfUser", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.

", - "smithy.api#jsonName": "users", - "smithy.api#required": {} + "smithy.api#documentation": "

The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ for RabbitMQ brokers, an administrative user is required if using simple authentication and authorization. For brokers using OAuth2, this user is optional. When provided, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.

", + "smithy.api#jsonName": "users" } }, "DataReplicationMode": { @@ -4940,17 +4944,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4964,17 +4957,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4988,17 +4970,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5012,17 +4983,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/mturk.json b/codegen/sdk/aws-models/mturk.json index db2deaa5b3c..440dc27ab7e 100644 --- a/codegen/sdk/aws-models/mturk.json +++ b/codegen/sdk/aws-models/mturk.json @@ -3333,17 +3333,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3357,17 +3346,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3381,17 +3359,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3405,17 +3372,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/mwaa.json b/codegen/sdk/aws-models/mwaa.json index 2b6c8282a54..10853561647 100644 --- a/codegen/sdk/aws-models/mwaa.json +++ b/codegen/sdk/aws-models/mwaa.json @@ -751,17 +751,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -775,17 +764,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -799,17 +777,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -823,17 +790,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/neptune-graph.json b/codegen/sdk/aws-models/neptune-graph.json index f9eadbd8fa3..5fb1fb5a688 100644 --- a/codegen/sdk/aws-models/neptune-graph.json +++ b/codegen/sdk/aws-models/neptune-graph.json @@ -95,7 +95,7 @@ "date" ] }, - "smithy.api#documentation": "

Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to \n insights faster by quickly processing large amounts of graph data, invoking popular graph analytic \n algorithms in low-latency queries, and getting analytics results in seconds.

", + "smithy.api#documentation": "

Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to insights faster by quickly processing large amounts of graph data, invoking popular graph analytic algorithms in low-latency queries, and getting analytics results in seconds.

", "smithy.api#title": "Amazon Neptune Graph", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1628,7 +1628,7 @@ "status": { "target": "com.amazonaws.neptunegraph#ExportTaskStatus", "traits": { - "smithy.api#documentation": "

The current status of the export task. The status is CANCELLING when the \n export task is cancelled.

", + "smithy.api#documentation": "

The current status of the export task. The status is CANCELLING when the export task is cancelled.

", "smithy.api#required": {} } }, @@ -1749,14 +1749,14 @@ "source": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,\n or can point to a Neptune database endpoint or snapshot.

", + "smithy.api#documentation": "

A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.

", "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.neptunegraph#Format", "traits": { - "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format or OPENCYPHER, which identies the openCypher\n load format.

" + "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

" } }, "parquetType": { @@ -1933,20 +1933,20 @@ "graphName": { "target": "com.amazonaws.neptunegraph#GraphName", "traits": { - "smithy.api#documentation": "

A name for the new Neptune Analytics graph to be created.

\n

The name must contain from 1 to 63 letters, numbers, or hyphens, and its\n first character must be a letter. It cannot end with a hyphen or contain two\n consecutive hyphens. Only lowercase letters are allowed.

", + "smithy.api#documentation": "

A name for the new Neptune Analytics graph to be created.

The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.neptunegraph#TagMap", "traits": { - "smithy.api#documentation": "

Adds metadata tags to the new graph.\n These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.

" + "smithy.api#documentation": "

Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.

" } }, "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.\n (true to enable, or false to disable.

" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (true to enable, or false to disable.

" } }, "kmsKeyIdentifier": { @@ -1958,19 +1958,19 @@ "vectorSearchConfiguration": { "target": "com.amazonaws.neptunegraph#VectorSearchConfiguration", "traits": { - "smithy.api#documentation": "

Specifies the number of dimensions for vector embeddings that will be loaded into the graph.\n The value is specified as dimension=value. Max = 65,535

" + "smithy.api#documentation": "

Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as dimension=value. Max = 65,535

" } }, "replicaCount": { "target": "com.amazonaws.neptunegraph#ReplicaCount", "traits": { - "smithy.api#documentation": "

The number of replicas in other AZs. Min =0, Max = 2, Default = 1.

\n \n

\n Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.\n

\n
" + "smithy.api#documentation": "

The number of replicas in other AZs. Min =0, Max = 2, Default = 1.

Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.

" } }, "deletionProtection": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled.\n (true or false).

" + "smithy.api#documentation": "

Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (true or false).

" } }, "provisionedMemory": { @@ -1998,7 +1998,7 @@ "name": { "target": "com.amazonaws.neptunegraph#GraphName", "traits": { - "smithy.api#documentation": "

The graph name. For example: my-graph-1.

\n

The name must contain from 1 to 63 letters, numbers, or hyphens, and its\n first character must be a letter. It cannot end with a hyphen or contain two\n consecutive hyphens. Only lowercase letters are allowed.

", + "smithy.api#documentation": "

The graph name. For example: my-graph-1.

The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.

", "smithy.api#required": {} } }, @@ -2030,7 +2030,7 @@ "provisionedMemory": { "target": "com.amazonaws.neptunegraph#ProvisionedMemory", "traits": { - "smithy.api#documentation": "

The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

\n

Min = 16

" + "smithy.api#documentation": "

The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

Min = 16

" } }, "endpoint": { @@ -2042,19 +2042,19 @@ "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.

\n \n

If enabling public connectivity for the first time, there will be a delay while it is enabled.

\n
" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.

If enabling public connectivity for the first time, there will be a delay while it is enabled.

" } }, "vectorSearchConfiguration": { "target": "com.amazonaws.neptunegraph#VectorSearchConfiguration", "traits": { - "smithy.api#documentation": "

The vector-search configuration for the graph, which specifies the vector dimension\n to use in the vector index, if any.

" + "smithy.api#documentation": "

The vector-search configuration for the graph, which specifies the vector dimension to use in the vector index, if any.

" } }, "replicaCount": { "target": "com.amazonaws.neptunegraph#ReplicaCount", "traits": { - "smithy.api#documentation": "

The number of replicas in other AZs.

\n

Default: If not specified, the default value is 1.

" + "smithy.api#documentation": "

The number of replicas in other AZs.

Default: If not specified, the default value is 1.

" } }, "kmsKeyIdentifier": { @@ -2072,7 +2072,7 @@ "deletionProtection": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether the graph has deletion protection enabled.\n The graph can't be deleted when deletion protection is enabled.

" + "smithy.api#documentation": "

A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

" } }, "buildNumber": { @@ -2142,14 +2142,14 @@ "snapshotName": { "target": "com.amazonaws.neptunegraph#SnapshotName", "traits": { - "smithy.api#documentation": "

The snapshot name. For example: my-snapshot-1.

\n

The name must contain from 1 to 63 letters, numbers, or hyphens, and its\n first character must be a letter. It cannot end with a hyphen or contain two\n consecutive hyphens. Only lowercase letters are allowed.

", + "smithy.api#documentation": "

The snapshot name. For example: my-snapshot-1.

The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.neptunegraph#TagMap", "traits": { - "smithy.api#documentation": "

Adds metadata tags to the new graph.\n These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.

" + "smithy.api#documentation": "

Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.

" } } }, @@ -2237,7 +2237,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "

Creates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database\n or a Neptune database snapshot.

\n

The data can be loaded from files in S3 that in either the Gremlin CSV\n format or the openCypher\n load format.

", + "smithy.api#documentation": "

Creates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database or a Neptune database snapshot.

The data can be loaded from files in S3 that in either the Gremlin CSV format or the openCypher load format.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -2256,20 +2256,20 @@ "graphName": { "target": "com.amazonaws.neptunegraph#GraphName", "traits": { - "smithy.api#documentation": "

A name for the new Neptune Analytics graph to be created.

\n

The name must contain from 1 to 63 letters, numbers, or hyphens, and its\n first character must be a letter. It cannot end with a hyphen or contain two\n consecutive hyphens. Only lowercase letters are allowed.

", + "smithy.api#documentation": "

A name for the new Neptune Analytics graph to be created.

The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.neptunegraph#TagMap", "traits": { - "smithy.api#documentation": "

Adds metadata tags to the new graph. These tags can also be used with cost allocation\n reporting, or used in a Condition statement in an IAM policy.

" + "smithy.api#documentation": "

Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.

" } }, "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.\n (true to enable, or false to disable).

" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (true to enable, or false to disable).

" } }, "kmsKeyIdentifier": { @@ -2281,31 +2281,31 @@ "vectorSearchConfiguration": { "target": "com.amazonaws.neptunegraph#VectorSearchConfiguration", "traits": { - "smithy.api#documentation": "

Specifies the number of dimensions for vector embeddings that will be loaded into the graph.\n The value is specified as dimension=value. Max = 65,535

" + "smithy.api#documentation": "

Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as dimension=value. Max = 65,535

" } }, "replicaCount": { "target": "com.amazonaws.neptunegraph#ReplicaCount", "traits": { - "smithy.api#documentation": "

The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.

\n \n

\n Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.\n

\n
" + "smithy.api#documentation": "

The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.

Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.

" } }, "deletionProtection": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled.\n (true or false).

" + "smithy.api#documentation": "

Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (true or false).

" } }, "importOptions": { "target": "com.amazonaws.neptunegraph#ImportOptions", "traits": { - "smithy.api#documentation": "

Contains options for controlling the import process. For example, if the failOnError key\n is set to false, the import skips problem data and attempts to continue (whereas if set to\n true, the default, or if omitted, the import operation halts immediately when an error is\n encountered.

" + "smithy.api#documentation": "

Contains options for controlling the import process. For example, if the failOnError key is set to false, the import skips problem data and attempts to continue (whereas if set to true, the default, or if omitted, the import operation halts immediately when an error is encountered.

" } }, "maxProvisionedMemory": { "target": "com.amazonaws.neptunegraph#ProvisionedMemory", "traits": { - "smithy.api#documentation": "

The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024,\n or the approved upper limit for your account.

\n

If both the minimum and maximum values are specified, the final\n provisioned-memory will be chosen per the actual size of your imported data. If neither value is specified, \n 128 m-NCUs are used.

" + "smithy.api#documentation": "

The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024, or the approved upper limit for your account.

If both the minimum and maximum values are specified, the final provisioned-memory will be chosen per the actual size of your imported data. If neither value is specified, 128 m-NCUs are used.

" } }, "minProvisionedMemory": { @@ -2317,20 +2317,20 @@ "failOnError": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

If set to true, the task halts when an import error is encountered. If set to false,\n the task skips the data that caused the error and continues if possible.

" + "smithy.api#documentation": "

If set to true, the task halts when an import error is encountered. If set to false, the task skips the data that caused the error and continues if possible.

" } }, "source": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,\n or can point to a Neptune database endpoint or snapshot.

", + "smithy.api#documentation": "

A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.

", "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.neptunegraph#Format", "traits": { - "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format, OPEN_CYPHER, which identifies the openCypher\n load format, or ntriples, which identifies the\n RDF n-triples format.

" + "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format, OPEN_CYPHER, which identifies the openCypher load format, or ntriples, which identifies the RDF n-triples format.

" } }, "parquetType": { @@ -2342,7 +2342,7 @@ "blankNodeHandling": { "target": "com.amazonaws.neptunegraph#BlankNodeHandling", "traits": { - "smithy.api#documentation": "

The method to handle blank nodes in the dataset. Currently, only convertToIri is supported, \n meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is ntriples. \n For more information, see Handling RDF values.

" + "smithy.api#documentation": "

The method to handle blank nodes in the dataset. Currently, only convertToIri is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is ntriples. For more information, see Handling RDF values.

" } }, "roleArn": { @@ -2376,14 +2376,14 @@ "source": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,\n or can point to a Neptune database endpoint or snapshot.

", + "smithy.api#documentation": "

A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.

", "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.neptunegraph#Format", "traits": { - "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format, OPENCYPHER, which identifies the openCypher\n load format, or ntriples, which identifies the\n RDF n-triples format.

" + "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format, OPENCYPHER, which identifies the openCypher load format, or ntriples, which identifies the RDF n-triples format.

" } }, "parquetType": { @@ -2409,7 +2409,7 @@ "importOptions": { "target": "com.amazonaws.neptunegraph#ImportOptions", "traits": { - "smithy.api#documentation": "

Contains options for controlling the import process. For example, if the failOnError key\n is set to false, the import skips problem data and attempts to continue (whereas if set to\n true, the default, or if omitted, the import operation halts immediately when an error is\n encountered.

" + "smithy.api#documentation": "

Contains options for controlling the import process. For example, if the failOnError key is set to false, the import skips problem data and attempts to continue (whereas if set to true, the default, or if omitted, the import operation halts immediately when an error is encountered.

" } } }, @@ -2447,7 +2447,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "

Create a private graph endpoint to allow private access from to the graph from within\n a VPC. You can attach security groups to the private graph endpoint.

\n \n

VPC endpoint charges apply.

\n
", + "smithy.api#documentation": "

Create a private graph endpoint to allow private access from to the graph from within a VPC. You can attach security groups to the private graph endpoint.

VPC endpoint charges apply.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -2583,7 +2583,7 @@ "skipSnapshot": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether a final graph snapshot is created before the graph is deleted.\n If true is specified, no graph snapshot is created. If false\n is specified, a graph snapshot is created before the graph is deleted.

", + "smithy.api#documentation": "

Determines whether a final graph snapshot is created before the graph is deleted. If true is specified, no graph snapshot is created. If false is specified, a graph snapshot is created before the graph is deleted.

", "smithy.api#httpQuery": "skipSnapshot", "smithy.api#required": {} } @@ -2760,7 +2760,7 @@ "name": { "target": "com.amazonaws.neptunegraph#SnapshotName", "traits": { - "smithy.api#documentation": "

The snapshot name. For example: my-snapshot-1.

\n

The name must contain from 1 to 63 letters, numbers, or hyphens, and its\n first character must be a letter. It cannot end with a hyphen or contain two\n consecutive hyphens. Only lowercase letters are allowed.

", + "smithy.api#documentation": "

The snapshot name. For example: my-snapshot-1.

The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.

", "smithy.api#required": {} } }, @@ -2976,7 +2976,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Execute an openCypher query.

\n

\n When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached \n that allows one of the following IAM actions in that cluster, depending on the query:\n

\n
    \n
  • \n

    neptune-graph:ReadDataViaQuery

    \n
  • \n
  • \n

    neptune-graph:WriteDataViaQuery

    \n
  • \n
  • \n

    neptune-graph:DeleteDataViaQuery

    \n
  • \n
", + "smithy.api#documentation": "

Execute an openCypher query.

When invoking this operation in a Neptune Analytics cluster, 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:

  • neptune-graph:ReadDataViaQuery

  • neptune-graph:WriteDataViaQuery

  • neptune-graph:DeleteDataViaQuery

", "smithy.api#endpoint": { "hostPrefix": "{graphIdentifier}." }, @@ -3028,13 +3028,13 @@ "planCache": { "target": "com.amazonaws.neptunegraph#PlanCacheType", "traits": { - "smithy.api#documentation": "

Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. \n This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an \n LRU cache with a 5 minute TTL and a capacity of 1000.

" + "smithy.api#documentation": "

Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.

" } }, "explainMode": { "target": "com.amazonaws.neptunegraph#ExplainMode", "traits": { - "smithy.api#documentation": "

The explain mode parameter returns a query explain instead of the actual query results. A query explain can \n be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions \n flowing etc.

", + "smithy.api#documentation": "

The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.

", "smithy.api#jsonName": "explain" } }, @@ -3088,18 +3088,18 @@ "vertexFilter": { "target": "com.amazonaws.neptunegraph#ExportFilterPerLabelMap", "traits": { - "smithy.api#documentation": "

Used to specify filters on a per-label basis for vertices. This allows you to control which vertex labels \n and properties are included in the export.

" + "smithy.api#documentation": "

Used to specify filters on a per-label basis for vertices. This allows you to control which vertex labels and properties are included in the export.

" } }, "edgeFilter": { "target": "com.amazonaws.neptunegraph#ExportFilterPerLabelMap", "traits": { - "smithy.api#documentation": "

Used to specify filters on a per-label basis for edges. This allows you to control which edge labels \n and properties are included in the export.

" + "smithy.api#documentation": "

Used to specify filters on a per-label basis for edges. This allows you to control which edge labels and properties are included in the export.

" } } }, "traits": { - "smithy.api#documentation": "

This is the top-level field for specifying vertex or edge filters. If the ExportFilter is not provided, \n then all properties for all labels will be exported. If the ExportFilter is provided but is an empty object, \n then no data will be exported.

" + "smithy.api#documentation": "

This is the top-level field for specifying vertex or edge filters. If the ExportFilter is not provided, then all properties for all labels will be exported. If the ExportFilter is provided but is an empty object, then no data will be exported.

" } }, "com.amazonaws.neptunegraph#ExportFilterElement": { @@ -3108,7 +3108,7 @@ "properties": { "target": "com.amazonaws.neptunegraph#ExportFilterPropertyMap", "traits": { - "smithy.api#documentation": "

Each property is defined by a key-value pair, where the key is the desired output property name (e.g. \"name\"), \n and the value is an object.

" + "smithy.api#documentation": "

Each property is defined by a key-value pair, where the key is the desired output property name (e.g. \"name\"), and the value is an object.

" } } }, @@ -3156,25 +3156,25 @@ "outputType": { "target": "com.amazonaws.neptunegraph#ExportFilterOutputDataType", "traits": { - "smithy.api#documentation": "

Specifies the data type to use for the property in the exported data (e.g. \"String\", \"Int\", \"Float\"). \n If a type is not provided, the export process will determine the type. If a given property is present as multiple \n types (e.g. one vertex has \"height\" stored as a double, and another edge has it stored as a string), the type \n will be of Any type, otherwise, it will be the type of the property as present in vertices.

" + "smithy.api#documentation": "

Specifies the data type to use for the property in the exported data (e.g. \"String\", \"Int\", \"Float\"). If a type is not provided, the export process will determine the type. If a given property is present as multiple types (e.g. one vertex has \"height\" stored as a double, and another edge has it stored as a string), the type will be of Any type, otherwise, it will be the type of the property as present in vertices.

" } }, "sourcePropertyName": { "target": "com.amazonaws.neptunegraph#ExportFilterSourcePropertyName", "traits": { - "smithy.api#documentation": "

The name of the property as it exists in the original graph data. If not provided, it is assumed that the key \n matches the desired sourcePropertyName.

" + "smithy.api#documentation": "

The name of the property as it exists in the original graph data. If not provided, it is assumed that the key matches the desired sourcePropertyName.

" } }, "multiValueHandling": { "target": "com.amazonaws.neptunegraph#MultiValueHandlingType", "traits": { "smithy.api#default": "PICK_FIRST", - "smithy.api#documentation": "

Specifies how to handle properties that have multiple values. Can be either TO_LIST to export all \n values as a list, or PICK_FIRST to export the first value encountered. If not specified, the default \n value is PICK_FIRST.

" + "smithy.api#documentation": "

Specifies how to handle properties that have multiple values. Can be either TO_LIST to export all values as a list, or PICK_FIRST to export the first value encountered. If not specified, the default value is PICK_FIRST.

" } } }, "traits": { - "smithy.api#documentation": "

A structure representing a property's attributes. It is a map object of outputType, sourcePropertyName \n and multiValueHandling.

" + "smithy.api#documentation": "

A structure representing a property's attributes. It is a map object of outputType, sourcePropertyName and multiValueHandling.

" } }, "com.amazonaws.neptunegraph#ExportFilterPropertyMap": { @@ -3725,6 +3725,33 @@ } } ] + }, + "GraphStopped": { + "documentation": "Wait until Graph is Stopped", + "minDelay": 20, + "maxDelay": 1800, + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "STOPPED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status != 'STOPPING'", + "expected": "true", + "comparator": "booleanEquals" + } + } + } + ] } } } @@ -3972,7 +3999,7 @@ "name": { "target": "com.amazonaws.neptunegraph#SnapshotName", "traits": { - "smithy.api#documentation": "

The snapshot name. For example: my-snapshot-1.

\n

The name must contain from 1 to 63 letters, numbers, or hyphens, and its\n first character must be a letter. It cannot end with a hyphen or contain two\n consecutive hyphens. Only lowercase letters are allowed.

", + "smithy.api#documentation": "

The snapshot name. For example: my-snapshot-1.

The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.

", "smithy.api#required": {} } }, @@ -4071,7 +4098,7 @@ "mode": { "target": "com.amazonaws.neptunegraph#GraphSummaryMode", "traits": { - "smithy.api#documentation": "

The summary mode can take one of two values: basic (the default), and\n detailed.

", + "smithy.api#documentation": "

The summary mode can take one of two values: basic (the default), and detailed.

", "smithy.api#httpQuery": "mode" } } @@ -4266,14 +4293,14 @@ "source": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,\n or can point to a Neptune database endpoint or snapshot

", + "smithy.api#documentation": "

A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot

", "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.neptunegraph#Format", "traits": { - "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format or OPENCYPHER, which identies the openCypher\n load format.

" + "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

" } }, "parquetType": { @@ -4292,14 +4319,14 @@ "status": { "target": "com.amazonaws.neptunegraph#ImportTaskStatus", "traits": { - "smithy.api#documentation": "

The status of the import task:

\n
    \n
  • \n

    \n INITIALIZING   –  \n The necessary resources needed to create the graph are being prepared.

    \n
  • \n
  • \n

    \n ANALYZING_DATA   –  \n The data is being analyzed to determine the optimal infrastructure configuration\n for the new graph.

    \n
  • \n
  • \n

    \n RE_PROVISIONING   –  \n The data did not fit into the provisioned graph, so it is being re-provisioned\n with more capacity.

    \n
  • \n
  • \n

    \n IMPORTING   –  \n The data is being loaded.

    \n
  • \n
  • \n

    \n ERROR_ENCOUNTERED   –  \n An error has been encountered while trying to create the graph and import the data.

    \n
  • \n
  • \n

    \n ERROR_ENCOUNTERED_ROLLING_BACK   –  \n Because of the error that was encountered, the graph is being rolled back and all\n its resources released.

    \n
  • \n
  • \n

    \n SUCCEEDED   –  \n Graph creation and data loading succeeded.

    \n
  • \n
  • \n

    \n FAILED   –  \n Graph creation or data loading failed. When the status is FAILED,\n you can use get-graphs to get more information about the state of\n the graph.

    \n
  • \n
  • \n

    \n CANCELLING   –  \n Because you cancelled the import task, cancellation is in progress.

    \n
  • \n
  • \n

    \n CANCELLED   –  \n You have successfully cancelled the import task.

    \n
  • \n
", + "smithy.api#documentation": "

The status of the import task:

  • INITIALIZING   –   The necessary resources needed to create the graph are being prepared.

  • ANALYZING_DATA   –   The data is being analyzed to determine the optimal infrastructure configuration for the new graph.

  • RE_PROVISIONING   –   The data did not fit into the provisioned graph, so it is being re-provisioned with more capacity.

  • IMPORTING   –   The data is being loaded.

  • ERROR_ENCOUNTERED   –   An error has been encountered while trying to create the graph and import the data.

  • ERROR_ENCOUNTERED_ROLLING_BACK   –   Because of the error that was encountered, the graph is being rolled back and all its resources released.

  • SUCCEEDED   –   Graph creation and data loading succeeded.

  • FAILED   –   Graph creation or data loading failed. When the status is FAILED, you can use get-graphs to get more information about the state of the graph.

  • CANCELLING   –   Because you cancelled the import task, cancellation is in progress.

  • CANCELLED   –   You have successfully cancelled the import task.

", "smithy.api#required": {} } }, "importOptions": { "target": "com.amazonaws.neptunegraph#ImportOptions", "traits": { - "smithy.api#documentation": "

Contains options for controlling the import process. For example, if the failOnError key\n is set to false, the import skips problem data and attempts to continue (whereas if set to\n true, the default, or if omitted, the import operation halts immediately when an error is\n encountered.

" + "smithy.api#documentation": "

Contains options for controlling the import process. For example, if the failOnError key is set to false, the import skips problem data and attempts to continue (whereas if set to true, the default, or if omitted, the import operation halts immediately when an error is encountered.

" } }, "importTaskDetails": { @@ -4511,7 +4538,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Retrieves the status of a specified query.

\n \n

\n When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the \n neptune-graph:GetQueryStatus IAM action attached.\n

\n
", + "smithy.api#documentation": "

Retrieves the status of a specified query.

When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the neptune-graph:GetQueryStatus IAM action attached.

", "smithy.api#endpoint": { "hostPrefix": "{graphIdentifier}." }, @@ -4651,7 +4678,7 @@ "edgeProperties": { "target": "com.amazonaws.neptunegraph#LongValuedMapList", "traits": { - "smithy.api#documentation": "

A list of the distinct edge properties in the graph, along with the count of edges\n 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": { @@ -4726,6 +4753,12 @@ { "target": "com.amazonaws.neptunegraph#RestoreGraphFromSnapshot" }, + { + "target": "com.amazonaws.neptunegraph#StartGraph" + }, + { + "target": "com.amazonaws.neptunegraph#StopGraph" + }, { "target": "com.amazonaws.neptunegraph#UpdateGraph" } @@ -4744,7 +4777,7 @@ "name": { "target": "com.amazonaws.neptunegraph#SnapshotName", "traits": { - "smithy.api#documentation": "

The snapshot name. For example: my-snapshot-1.

\n

The name must contain from 1 to 63 letters, numbers, or hyphens, and its\n first character must be a letter. It cannot end with a hyphen or contain two\n consecutive hyphens. Only lowercase letters are allowed.

", + "smithy.api#documentation": "

The snapshot name. For example: my-snapshot-1.

The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.

", "smithy.api#required": {} } }, @@ -4840,6 +4873,24 @@ "traits": { "smithy.api#enumValue": "IMPORTING" } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } } } }, @@ -5104,14 +5155,14 @@ "source": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A URL identifying to the location of the data to be imported. This can be an Amazon S3 path,\n or can point to a Neptune database endpoint or snapshot

", + "smithy.api#documentation": "

A URL identifying to the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot

", "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.neptunegraph#Format", "traits": { - "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format or OPENCYPHER, which identies the openCypher\n load format.

" + "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

" } }, "parquetType": { @@ -5324,14 +5375,14 @@ "nextToken": { "target": "com.amazonaws.neptunegraph#PaginationToken", "traits": { - "smithy.api#documentation": "

Pagination token used to paginate output.

\n

When this value is provided as input, the service returns results from where\n the previous response left off. When this value is present in output, it indicates\n that there are more results to retrieve.

", + "smithy.api#documentation": "

Pagination token used to paginate output.

When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.neptunegraph#MaxResults", "traits": { - "smithy.api#documentation": "

The total number of records to return in the command's output.

\n

If the total number of records available is more than the value specified,\n nextToken is provided in the command's output. To resume pagination,\n provide the nextToken output value in the nextToken argument\n of a subsequent command. Do not use the nextToken response element directly\n outside of the Amazon CLI.

", + "smithy.api#documentation": "

The total number of records to return in the command's output.

If the total number of records available is more than the value specified, nextToken is provided in the command's output. To resume pagination, provide the nextToken output value in the nextToken argument of a subsequent command. Do not use the nextToken response element directly outside of the Amazon CLI.

", "smithy.api#httpQuery": "maxResults" } } @@ -5353,7 +5404,7 @@ "nextToken": { "target": "com.amazonaws.neptunegraph#PaginationToken", "traits": { - "smithy.api#documentation": "

Pagination token used to paginate output.

\n

When this value is provided as input, the service returns results from where\n the previous response left off. When this value is present in output, it indicates\n that there are more results to retrieve.

" + "smithy.api#documentation": "

Pagination token used to paginate output.

When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

" } } }, @@ -5408,14 +5459,14 @@ "nextToken": { "target": "com.amazonaws.neptunegraph#PaginationToken", "traits": { - "smithy.api#documentation": "

Pagination token used to paginate output.

\n

When this value is provided as input, the service returns results from where\n the previous response left off. When this value is present in output, it indicates\n that there are more results to retrieve.

", + "smithy.api#documentation": "

Pagination token used to paginate output.

When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.neptunegraph#MaxResults", "traits": { - "smithy.api#documentation": "

The total number of records to return in the command's output.

\n

If the total number of records available is more than the value specified,\n nextToken is provided in the command's output. To resume pagination,\n provide the nextToken output value in the nextToken argument\n of a subsequent command. Do not use the nextToken response element directly\n outside of the Amazon CLI.

", + "smithy.api#documentation": "

The total number of records to return in the command's output.

If the total number of records available is more than the value specified, nextToken is provided in the command's output. To resume pagination, provide the nextToken output value in the nextToken argument of a subsequent command. Do not use the nextToken response element directly outside of the Amazon CLI.

", "smithy.api#httpQuery": "maxResults" } } @@ -5437,7 +5488,7 @@ "nextToken": { "target": "com.amazonaws.neptunegraph#PaginationToken", "traits": { - "smithy.api#documentation": "

Pagination token used to paginate output.

\n

When this value is provided as input, the service returns results from where\n the previous response left off. When this value is present in output, it indicates\n that there are more results to retrieve.

" + "smithy.api#documentation": "

Pagination token used to paginate output.

When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

" } } }, @@ -5495,14 +5546,14 @@ "nextToken": { "target": "com.amazonaws.neptunegraph#PaginationToken", "traits": { - "smithy.api#documentation": "

Pagination token used to paginate output.

\n

When this value is provided as input, the service returns results from where\n the previous response left off. When this value is present in output, it indicates\n that there are more results to retrieve.

", + "smithy.api#documentation": "

Pagination token used to paginate output.

When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.neptunegraph#MaxResults", "traits": { - "smithy.api#documentation": "

The total number of records to return in the command's output.

\n

If the total number of records available is more than the value specified,\n nextToken is provided in the command's output. To resume pagination,\n provide the nextToken output value in the nextToken argument\n of a subsequent command. Do not use the nextToken response element directly\n outside of the Amazon CLI.

", + "smithy.api#documentation": "

The total number of records to return in the command's output.

If the total number of records available is more than the value specified, nextToken is provided in the command's output. To resume pagination, provide the nextToken output value in the nextToken argument of a subsequent command. Do not use the nextToken response element directly outside of the Amazon CLI.

", "smithy.api#httpQuery": "maxResults" } } @@ -5524,7 +5575,7 @@ "nextToken": { "target": "com.amazonaws.neptunegraph#PaginationToken", "traits": { - "smithy.api#documentation": "

Pagination token used to paginate output.

\n

When this value is provided as input, the service returns results from where\n the previous response left off. When this value is present in output, it indicates\n that there are more results to retrieve.

" + "smithy.api#documentation": "

Pagination token used to paginate output.

When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

" } } }, @@ -5590,14 +5641,14 @@ "nextToken": { "target": "com.amazonaws.neptunegraph#PaginationToken", "traits": { - "smithy.api#documentation": "

Pagination token used to paginate output.

\n

When this value is provided as input, the service returns results from where\n the previous response left off. When this value is present in output, it indicates\n that there are more results to retrieve.

", + "smithy.api#documentation": "

Pagination token used to paginate output.

When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.neptunegraph#MaxResults", "traits": { - "smithy.api#documentation": "

The total number of records to return in the command's output.

\n

If the total number of records available is more than the value specified,\n nextToken is provided in the command's output. To resume pagination,\n provide the nextToken output value in the nextToken argument\n of a subsequent command. Do not use the nextToken response element directly\n outside of the Amazon CLI.

", + "smithy.api#documentation": "

The total number of records to return in the command's output.

If the total number of records available is more than the value specified, nextToken is provided in the command's output. To resume pagination, provide the nextToken output value in the nextToken argument of a subsequent command. Do not use the nextToken response element directly outside of the Amazon CLI.

", "smithy.api#httpQuery": "maxResults" } } @@ -5619,7 +5670,7 @@ "nextToken": { "target": "com.amazonaws.neptunegraph#PaginationToken", "traits": { - "smithy.api#documentation": "

Pagination token used to paginate output.

\n

When this value is provided as input, the service returns results from where\n the previous response left off. When this value is present in output, it indicates\n that there are more results to retrieve.

" + "smithy.api#documentation": "

Pagination token used to paginate output.

When this value is provided as input, the service returns results from where the previous response left off. When this value is present in output, it indicates that there are more results to retrieve.

" } } }, @@ -5851,13 +5902,13 @@ "preserveDefaultVertexLabels": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly\n provided. Neptune assigns default labels when none is explicitly provided. When importing the data into\n Neptune Analytics, the default vertex labels can be omitted by setting\n preserveDefaultVertexLabels to false. Note that if the vertex only has default labels,\n and has no other properties or edges, then the vertex will effectively not get\n imported into Neptune Analytics when preserveDefaultVertexLabels is set to false.

" + "smithy.api#documentation": "

Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly provided. Neptune assigns default labels when none is explicitly provided. When importing the data into Neptune Analytics, the default vertex labels can be omitted by setting preserveDefaultVertexLabels to false. Note that if the vertex only has default labels, and has no other properties or edges, then the vertex will effectively not get imported into Neptune Analytics when preserveDefaultVertexLabels is set to false.

" } }, "preserveEdgeIds": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by\n default. They are imported if preserveEdgeIds is set to true, and ids are stored as\n properties on the relationships with the property name neptuneEdgeId.

" + "smithy.api#documentation": "

Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by default. They are imported if preserveEdgeIds is set to true, and ids are stored as properties on the relationships with the property name neptuneEdgeId.

" } } }, @@ -6230,7 +6281,7 @@ "skipSnapshot": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether a final graph snapshot is created before the graph data is deleted.\n If set to true, no graph snapshot is created. If set to false,\n a graph snapshot is created before the data is deleted.

", + "smithy.api#documentation": "

Determines whether a final graph snapshot is created before the graph data is deleted. If set to true, no graph snapshot is created. If set to false, a graph snapshot is created before the data is deleted.

", "smithy.api#required": {} } } @@ -6411,38 +6462,38 @@ "graphName": { "target": "com.amazonaws.neptunegraph#GraphName", "traits": { - "smithy.api#documentation": "

A name for the new Neptune Analytics graph to be created from the snapshot.

\n

The name must contain from 1 to 63 letters, numbers, or hyphens, and its\n first character must be a letter. It cannot end with a hyphen or contain two\n consecutive hyphens. Only lowercase letters are allowed.

", + "smithy.api#documentation": "

A name for the new Neptune Analytics graph to be created from the snapshot.

The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed.

", "smithy.api#required": {} } }, "provisionedMemory": { "target": "com.amazonaws.neptunegraph#ProvisionedMemory", "traits": { - "smithy.api#documentation": "

The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

\n

Min = 16

" + "smithy.api#documentation": "

The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

Min = 16

" } }, "deletionProtection": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether the graph has deletion protection enabled.\n The graph can't be deleted when deletion protection is enabled.

" + "smithy.api#documentation": "

A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

" } }, "tags": { "target": "com.amazonaws.neptunegraph#TagMap", "traits": { - "smithy.api#documentation": "

Adds metadata tags to the snapshot.\n These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.

" + "smithy.api#documentation": "

Adds metadata tags to the snapshot. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.

" } }, "replicaCount": { "target": "com.amazonaws.neptunegraph#ReplicaCount", "traits": { - "smithy.api#documentation": "

The number of replicas in other AZs. Min =0, Max = 2, Default =1

\n \n

\n Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.\n

\n
" + "smithy.api#documentation": "

The number of replicas in other AZs. Min =0, Max = 2, Default =1

Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.

" } }, "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.\n (true to enable, or false to disable).

" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (true to enable, or false to disable).

" } } }, @@ -6865,6 +6916,160 @@ "smithy.api#output": {} } }, + "com.amazonaws.neptunegraph#StartGraph": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunegraph#StartGraphInput" + }, + "output": { + "target": "com.amazonaws.neptunegraph#StartGraphOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunegraph#ConflictException" + }, + { + "target": "com.amazonaws.neptunegraph#InternalServerException" + }, + { + "target": "com.amazonaws.neptunegraph#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunegraph#ThrottlingException" + }, + { + "target": "com.amazonaws.neptunegraph#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Starts the specific graph.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/graphs/{graphIdentifier}/start" + }, + "smithy.rules#staticContextParams": { + "ApiType": { + "value": "ControlPlane" + } + } + } + }, + "com.amazonaws.neptunegraph#StartGraphInput": { + "type": "structure", + "members": { + "graphIdentifier": { + "target": "com.amazonaws.neptunegraph#GraphIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Neptune Analytics graph.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunegraph#StartGraphOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.neptunegraph#GraphId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the graph.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.neptunegraph#GraphName", + "traits": { + "smithy.api#documentation": "

The name of the graph.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN associated with the graph.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.neptunegraph#GraphStatus", + "traits": { + "smithy.api#documentation": "

The status of the graph.

" + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The reason that the graph has this status.

" + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the graph was created.

" + } + }, + "provisionedMemory": { + "target": "com.amazonaws.neptunegraph#ProvisionedMemory", + "traits": { + "smithy.api#documentation": "

The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.

" + } + }, + "endpoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The graph endpoint.

" + } + }, + "publicConnectivity": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

If true, the graph has a public endpoint, otherwise not.

" + } + }, + "vectorSearchConfiguration": { + "target": "com.amazonaws.neptunegraph#VectorSearchConfiguration" + }, + "replicaCount": { + "target": "com.amazonaws.neptunegraph#ReplicaCount", + "traits": { + "smithy.api#documentation": "

The number of replicas for the graph.

" + } + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.neptunegraph#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt and decrypt graph data.

" + } + }, + "sourceSnapshotId": { + "target": "com.amazonaws.neptunegraph#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the snapshot from which the graph was created, if it was created from a snapshot.

" + } + }, + "deletionProtection": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

If true, deletion protection is enabled for the graph.

" + } + }, + "buildNumber": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The build number of the graph.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.neptunegraph#StartImportTask": { "type": "operation", "input": { @@ -6914,20 +7119,20 @@ "failOnError": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

If set to true, the task halts when an import error is encountered. If set to false, the task skips the data that \n caused the error and continues if possible.

" + "smithy.api#documentation": "

If set to true, the task halts when an import error is encountered. If set to false, the task skips the data that caused the error and continues if possible.

" } }, "source": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A URL identifying the location of the data to be imported. This can be an Amazon S3 path, or can point to a \n Neptune database endpoint or snapshot.

", + "smithy.api#documentation": "

A URL identifying the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.

", "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.neptunegraph#Format", "traits": { - "smithy.api#documentation": "

Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or \n OPENCYPHER, which identies the openCypher load format.

" + "smithy.api#documentation": "

Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

" } }, "parquetType": { @@ -6939,7 +7144,7 @@ "blankNodeHandling": { "target": "com.amazonaws.neptunegraph#BlankNodeHandling", "traits": { - "smithy.api#documentation": "

The method to handle blank nodes in the dataset. Currently, only convertToIri is supported, \n meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is ntriples. \n For more information, see Handling RDF values.

" + "smithy.api#documentation": "

The method to handle blank nodes in the dataset. Currently, only convertToIri is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is ntriples. For more information, see Handling RDF values.

" } }, "graphIdentifier": { @@ -6981,14 +7186,14 @@ "source": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A URL identifying the location of the data to be imported. This can be an Amazon S3 path, or can point to a \n Neptune database endpoint or snapshot.

", + "smithy.api#documentation": "

A URL identifying the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.

", "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.neptunegraph#Format", "traits": { - "smithy.api#documentation": "

Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or \n OPENCYPHER, which identies the openCypher load format.

" + "smithy.api#documentation": "

Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

" } }, "parquetType": { @@ -7019,6 +7224,160 @@ "smithy.api#output": {} } }, + "com.amazonaws.neptunegraph#StopGraph": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunegraph#StopGraphInput" + }, + "output": { + "target": "com.amazonaws.neptunegraph#StopGraphOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunegraph#ConflictException" + }, + { + "target": "com.amazonaws.neptunegraph#InternalServerException" + }, + { + "target": "com.amazonaws.neptunegraph#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunegraph#ThrottlingException" + }, + { + "target": "com.amazonaws.neptunegraph#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Stops the specific graph.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/graphs/{graphIdentifier}/stop" + }, + "smithy.rules#staticContextParams": { + "ApiType": { + "value": "ControlPlane" + } + } + } + }, + "com.amazonaws.neptunegraph#StopGraphInput": { + "type": "structure", + "members": { + "graphIdentifier": { + "target": "com.amazonaws.neptunegraph#GraphIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Neptune Analytics graph.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunegraph#StopGraphOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.neptunegraph#GraphId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the graph.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.neptunegraph#GraphName", + "traits": { + "smithy.api#documentation": "

The name of the graph.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN associated with the graph.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.neptunegraph#GraphStatus", + "traits": { + "smithy.api#documentation": "

The status of the graph.

" + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The reason that the graph has this status.

" + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the graph was created.

" + } + }, + "provisionedMemory": { + "target": "com.amazonaws.neptunegraph#ProvisionedMemory", + "traits": { + "smithy.api#documentation": "

The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.

" + } + }, + "endpoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The graph endpoint.

" + } + }, + "publicConnectivity": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

If true, the graph has a public endpoint, otherwise not.

" + } + }, + "vectorSearchConfiguration": { + "target": "com.amazonaws.neptunegraph#VectorSearchConfiguration" + }, + "replicaCount": { + "target": "com.amazonaws.neptunegraph#ReplicaCount", + "traits": { + "smithy.api#documentation": "

The number of replicas for the graph.

" + } + }, + "kmsKeyIdentifier": { + "target": "com.amazonaws.neptunegraph#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt and decrypt graph data.

" + } + }, + "sourceSnapshotId": { + "target": "com.amazonaws.neptunegraph#SnapshotId", + "traits": { + "smithy.api#documentation": "

The ID of the snapshot from which the graph was created, if it was created from a snapshot.

" + } + }, + "deletionProtection": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

If true, deletion protection is enabled for the graph.

" + } + }, + "buildNumber": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The build number of the graph.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.neptunegraph#SubnetId": { "type": "string", "traits": { @@ -7126,7 +7485,7 @@ "tags": { "target": "com.amazonaws.neptunegraph#TagMap", "traits": { - "smithy.api#documentation": "

The tags to be assigned to the Neptune Analytics resource.

\n

The tags are metadata that are specified as a list of key-value pairs:

\n

\n Key (string)   –  \n A key is the required name of the tag. The string value can be\n from 1 to 128 Unicode characters in length. It can't be\n prefixed with aws: and can only contain the\n set of Unicode characters specified by this Java regular expression:\n \"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$\").

\n

\n Value (string)   –  \n A value is the optional value of the tag. The string value can\n be from 1 to 256 Unicode characters in length. It can't be\n prefixed with aws: and can only contain the\n set of Unicode characters specified by this Java regular expression:\n \"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$\").

", + "smithy.api#documentation": "

The tags to be assigned to the Neptune Analytics resource.

The tags are metadata that are specified as a list of key-value pairs:

Key (string)   –   A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length. It can't be prefixed with aws: and can only contain the set of Unicode characters specified by this Java regular expression: \"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$\").

Value (string)   –   A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length. It can't be prefixed with aws: and can only contain the set of Unicode characters specified by this Java regular expression: \"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$\").

", "smithy.api#required": {} } } @@ -7389,19 +7748,19 @@ "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.\n (true to enable, or false to disable.

" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (true to enable, or false to disable.

" } }, "provisionedMemory": { "target": "com.amazonaws.neptunegraph#ProvisionedMemory", "traits": { - "smithy.api#documentation": "

The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

\n

Min = 16

" + "smithy.api#documentation": "

The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

Min = 16

" } }, "deletionProtection": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether the graph has deletion protection enabled.\n The graph can't be deleted when deletion protection is enabled.

" + "smithy.api#documentation": "

A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

" } } }, diff --git a/codegen/sdk/aws-models/neptune.json b/codegen/sdk/aws-models/neptune.json index bf849f115a2..426b970f4f0 100644 --- a/codegen/sdk/aws-models/neptune.json +++ b/codegen/sdk/aws-models/neptune.json @@ -1306,17 +1306,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1330,17 +1319,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1354,17 +1332,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1378,17 +1345,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -1822,7 +1778,7 @@ "target": "com.amazonaws.neptune#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter is not\n case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
  • \n
  • \n

    Specify a valid DB snapshot identifier.

    \n
  • \n
\n

Example: my-cluster-snapshot1\n

", + "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter is not\n case-sensitive. If the source DB cluster snapshot is in a different region or \n owned by another account, specify the snapshot ARN.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
  • \n
  • \n

    Specify a valid DB snapshot identifier.

    \n
  • \n
\n

Example: my-cluster-snapshot1\n

", "smithy.api#required": {} } }, @@ -2710,8 +2666,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This flag should no longer be used.

" + "smithy.api#documentation": "

Indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private \n cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within \n the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is \n ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned \n to the DB cluster doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a \n private IP address.

" } }, "Tags": { @@ -4527,8 +4482,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.neptune#Boolean", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This flag should no longer be used.

" + "smithy.api#documentation": "

Indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private \n cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within \n the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is \n ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned \n to the DB cluster doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a \n private IP address.

" } }, "StatusInfos": { @@ -9018,8 +8972,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.neptune#BooleanOptional", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This flag should no longer be used.

" + "smithy.api#documentation": "

Indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private \n cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within \n the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is \n ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned \n to the DB cluster doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a \n private IP address.

" } }, "MonitoringRoleArn": { diff --git a/codegen/sdk/aws-models/neptunedata.json b/codegen/sdk/aws-models/neptunedata.json index 1b45523f70b..c63bc6dbe54 100644 --- a/codegen/sdk/aws-models/neptunedata.json +++ b/codegen/sdk/aws-models/neptunedata.json @@ -705,17 +705,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -729,17 +718,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -753,17 +731,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -777,17 +744,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/network-firewall.json b/codegen/sdk/aws-models/network-firewall.json index 8ba70e13a4f..3bd9a2a6371 100644 --- a/codegen/sdk/aws-models/network-firewall.json +++ b/codegen/sdk/aws-models/network-firewall.json @@ -1088,7 +1088,7 @@ "AvailabilityZoneMappings": { "target": "com.amazonaws.networkfirewall#AvailabilityZoneMappings", "traits": { - "smithy.api#documentation": "

Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone independence.

\n

You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The AvailabilityZoneChangeProtection setting controls whether you can make these modifications.

" + "smithy.api#documentation": "

Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.

\n

You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The AvailabilityZoneChangeProtection setting controls whether you can make these modifications.

" } }, "AvailabilityZoneChangeProtection": { @@ -1629,7 +1629,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a transit gateway attachment from a Network Firewall. Either the firewall owner or the transit gateway owner can delete the attachment.

\n \n

After you delete a transit gateway attachment, raffic will no longer flow through the firewall endpoints.

\n
\n

After you initiate the delete operation, use DescribeFirewall to monitor the deletion status.

" + "smithy.api#documentation": "

Deletes a transit gateway attachment from a Network Firewall. Either the firewall owner or the transit gateway owner can delete the attachment.

\n \n

After you delete a transit gateway attachment, traffic will no longer flow through the firewall endpoints.

\n
\n

After you initiate the delete operation, use DescribeFirewall to monitor the deletion status.

" } }, "com.amazonaws.networkfirewall#DeleteNetworkFirewallTransitGatewayAttachmentRequest": { @@ -3068,6 +3068,9 @@ "com.amazonaws.networkfirewall#EnableMonitoringDashboard": { "type": "boolean" }, + "com.amazonaws.networkfirewall#EnableTLSSessionHolding": { + "type": "boolean" + }, "com.amazonaws.networkfirewall#EnabledAnalysisType": { "type": "enum", "members": { @@ -3352,6 +3355,12 @@ "traits": { "smithy.api#documentation": "

Contains variables that you can use to override default Suricata settings in your firewall policy.

" } + }, + "EnableTLSSessionHolding": { + "target": "com.amazonaws.networkfirewall#EnableTLSSessionHolding", + "traits": { + "smithy.api#documentation": "

When true, prevents TCP and TLS packets from reaching destination servers until TLS Inspection has evaluated Server Name Indication (SNI) rules. Requires an associated TLS Inspection configuration.

" + } } }, "traits": { @@ -3773,6 +3782,18 @@ "traits": { "smithy.api#enumValue": "DENYLIST" } + }, + "REJECTLIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTLIST" + } + }, + "ALERTLIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALERTLIST" + } } } }, @@ -6176,17 +6197,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6200,17 +6210,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -6224,17 +6223,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6248,17 +6236,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -6661,7 +6638,7 @@ } ], "traits": { - "smithy.api#documentation": "

Rejects a transit gateway attachment request for Network Firewall. When you reject the attachment request, Network Firewall cancels the creation of routing components between the transit gateway and firewall endpoints.

\n

Only the firewall owner can reject the attachment. After rejection, no traffic will flow through the firewall endpoints for this attachment.

\n

Use DescribeFirewall to monitor the rejection status. To accept the attachment instead of rejecting it, use AcceptNetworkFirewallTransitGatewayAttachment.

\n \n

Once rejected, you cannot reverse this action. To establish connectivity, you must create a new transit gateway-attached firewall.

\n
" + "smithy.api#documentation": "

Rejects a transit gateway attachment request for Network Firewall. When you reject the attachment request, Network Firewall cancels the creation of routing components between the transit gateway and firewall endpoints.

\n

Only the transit gateway owner can reject the attachment. After rejection, no traffic will flow through the firewall endpoints for this attachment.

\n

Use DescribeFirewall to monitor the rejection status. To accept the attachment instead of rejecting it, use AcceptNetworkFirewallTransitGatewayAttachment.

\n \n

Once rejected, you cannot reverse this action. To establish connectivity, you must create a new transit gateway-attached firewall.

\n
" } }, "com.amazonaws.networkfirewall#RejectNetworkFirewallTransitGatewayAttachmentRequest": { @@ -7222,7 +7199,7 @@ "GeneratedRulesType": { "target": "com.amazonaws.networkfirewall#GeneratedRulesType", "traits": { - "smithy.api#documentation": "

Whether you want to allow or deny access to the domains in your target list.

", + "smithy.api#documentation": "

Whether you want to apply allow, reject, alert, or drop behavior to the domains in your target list.

\n \n

When logging is enabled and you choose Alert, traffic that matches the domain specifications \n generates an alert in the firewall's logs. Then, traffic either passes, is rejected, or drops based on other rules in the firewall policy.

\n
", "smithy.api#required": {} } } @@ -7696,7 +7673,7 @@ "RuleOrder": { "target": "com.amazonaws.networkfirewall#RuleOrder", "traits": { - "smithy.api#documentation": "

Indicates how to manage the order of stateful rule evaluation for the policy. STRICT_ORDER is the\n recommended option, but DEFAULT_ACTION_ORDER is the default option. \n With STRICT_ORDER, provide your rules in the order that you want them to be evaluated. \n You can then choose one or more default actions for packets that don't match any rules. \n Choose STRICT_ORDER to have the stateful rules engine determine the evaluation order of your rules. \n The default action for this rule order is \n PASS, followed by DROP, REJECT, and ALERT actions. \n Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on your settings. \n For more information, see\n Evaluation order for stateful rules in the Network Firewall Developer Guide.\n

" + "smithy.api#documentation": "

Indicates how to manage the order of stateful rule evaluation for the policy. STRICT_ORDER is the\n recommended option, but DEFAULT_ACTION_ORDER is the default option. With STRICT_ORDER, \n provide your rules in the order that you want them to be evaluated. \n You can then choose one or more default actions for packets that don't match any rules. \n Choose STRICT_ORDER to have the stateful rules engine determine the evaluation order of your rules. \n The default action for this rule order is PASS, followed by DROP, REJECT, and ALERT actions. \n Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on your settings. \n For more information, see\n Evaluation order for stateful rules in the Network Firewall Developer Guide.\n

" } }, "StreamExceptionPolicy": { diff --git a/codegen/sdk/aws-models/networkflowmonitor.json b/codegen/sdk/aws-models/networkflowmonitor.json index 6e05c94139c..a28b23c8012 100644 --- a/codegen/sdk/aws-models/networkflowmonitor.json +++ b/codegen/sdk/aws-models/networkflowmonitor.json @@ -95,7 +95,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to create a monitor" }, - "smithy.api#documentation": "

Create a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your workloads. For each monitor, Network Flow Monitor publishes detailed end-to-end performance metrics and a network health indicators (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose.

", + "smithy.api#documentation": "

Create a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your workloads. For each monitor, Network Flow Monitor publishes detailed end-to-end performance metrics and a network health indicator (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose.

", "smithy.api#http": { "uri": "/monitors", "method": "POST" @@ -116,7 +116,7 @@ "localResources": { "target": "com.amazonaws.networkflowmonitor#MonitorLocalResources", "traits": { - "smithy.api#documentation": "

The local resources to monitor. A local resource, in a bi-directional flow of a workload, is the host where the agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Relational Database Service (RDS)), the EC2 instance hosting the web service, which also runs the agent, is the local resource.

", + "smithy.api#documentation": "

The local resources to monitor. A local resource in a workload is the location of the host, or hosts, where the Network Flow Monitor agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Dynamo DB), the subnet with the EC2 instance that hosts the web service, which also runs the agent, is the local resource.

Be aware that all local resources must belong to the current Region.

", "smithy.api#length": { "min": 1 }, @@ -126,7 +126,7 @@ "remoteResources": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResources", "traits": { - "smithy.api#documentation": "

The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Relational Database Service (RDS) can be a remote resource.

" + "smithy.api#documentation": "

The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.

When you specify remote resources, be aware that specific combinations of resources are allowed and others are not, including the following constraints:

  • All remote resources that you specify must all belong to a single Region.

  • If you specify Amazon Web Services services as remote resources, any other remote resources that you specify must be in the current Region.

  • When you specify a remote resource for another Region, you can only specify the Region resource type. You cannot specify a subnet, VPC, or Availability Zone in another Region.

  • If you leave the RemoteResources parameter empty, the monitor will include all network flows that terminate in the current Region.

" } }, "scopeArn": { @@ -181,14 +181,14 @@ "localResources": { "target": "com.amazonaws.networkflowmonitor#MonitorLocalResources", "traits": { - "smithy.api#documentation": "

The local resources to monitor. A local resource, in a bi-directional flow of a workload, is the host where the agent is installed.

", + "smithy.api#documentation": "

The local resources to monitor. A local resource in a workload is the location of hosts where the Network Flow Monitor agent is installed.

", "smithy.api#required": {} } }, "remoteResources": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResources", "traits": { - "smithy.api#documentation": "

The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Relational Database Service (RDS) can be a remote resource. The remote resource is identified by its ARN or an identifier.

", + "smithy.api#documentation": "

The remote resources to monitor. A remote resource is the other endpoint specified for the network flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.

", "smithy.api#required": {} } }, @@ -253,7 +253,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to create a scope" }, - "smithy.api#documentation": "

Create a scope of resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend. This call returns a scope ID to identify the scope.

When you create a scope, you enable permissions for Network Flow Monitor. The scope is set to the resources for the Amazon Web Services that enables the feature.

", + "smithy.api#documentation": "

In Network Flow Monitor, you specify a scope for the service to generate metrics for. By using the scope, Network Flow Monitor can generate a topology of all the resources to measure performance metrics for. When you create a scope, you enable permissions for Network Flow Monitor.

A scope is a Region-account pair or multiple Region-account pairs. Network Flow Monitor uses your scope to determine all the resources (the topology) where Network Flow Monitor will gather network flow performance metrics for you. To provide performance metrics, Network Flow Monitor uses the data that is sent by the Network Flow Monitor agents you install on the resources.

To define the Region-account pairs for your scope, the Network Flow Monitor API uses the following constucts, which allow for future flexibility in defining scopes:

  • Targets, which are arrays of targetResources.

  • Target resources, which are Region-targetIdentifier pairs.

  • Target identifiers, made up of a targetID (currently always an account ID) and a targetType (currently always an account).

", "smithy.api#http": { "uri": "/scopes", "method": "POST" @@ -267,7 +267,7 @@ "targets": { "target": "com.amazonaws.networkflowmonitor#TargetResourceList", "traits": { - "smithy.api#documentation": "

The targets to define the scope to be monitored. Currently, a target is an Amazon Web Services account.

", + "smithy.api#documentation": "

The targets to define the scope to be monitored. A target is an array of targetResources, which are currently Region-account pairs, defined by targetResource constructs.

", "smithy.api#length": { "min": 1, "max": 100 @@ -340,6 +340,9 @@ { "target": "com.amazonaws.networkflowmonitor#AccessDeniedException" }, + { + "target": "com.amazonaws.networkflowmonitor#ConflictException" + }, { "target": "com.amazonaws.networkflowmonitor#InternalServerException" }, @@ -492,6 +495,12 @@ "traits": { "smithy.api#enumValue": "AMAZON_DYNAMODB" } + }, + "INTER_REGION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTER_REGION" + } } } }, @@ -575,14 +584,14 @@ "localResources": { "target": "com.amazonaws.networkflowmonitor#MonitorLocalResources", "traits": { - "smithy.api#documentation": "

The local resources for this monitor.

", + "smithy.api#documentation": "

The local resources to monitor. A local resource in a workload is the location of the hosts where the Network Flow Monitor agent is installed.

", "smithy.api#required": {} } }, "remoteResources": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResources", "traits": { - "smithy.api#documentation": "

The remote resources for this monitor.

", + "smithy.api#documentation": "

The remote resources to monitor. A remote resource is the other endpoint specified for the network flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.

", "smithy.api#required": {} } }, @@ -1257,7 +1266,7 @@ "targets": { "target": "com.amazonaws.networkflowmonitor#TargetResourceList", "traits": { - "smithy.api#documentation": "

The targets for a scope

", + "smithy.api#documentation": "

The targets to define the scope to be monitored. A target is an array of targetResources, which are currently Region-account pairs, defined by targetResource constructs.

", "smithy.api#required": {} } }, @@ -1822,20 +1831,20 @@ "type": { "target": "com.amazonaws.networkflowmonitor#MonitorLocalResourceType", "traits": { - "smithy.api#documentation": "

The type of the local resource. Valid values are AWS::EC2::VPC AWS::AvailabilityZone or AWS::EC2::Subnet.

", + "smithy.api#documentation": "

The type of the local resource. Valid values are AWS::EC2::VPC AWS::AvailabilityZone, AWS::EC2::Subnet, or AWS::Region.

", "smithy.api#required": {} } }, "identifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The identifier of the local resource, such as an ARN.

", + "smithy.api#documentation": "

The identifier of the local resource. For a VPC or subnet, this identifier is the VPC Amazon Resource Name (ARN) or subnet ARN. For an Availability Zone, this identifier is the AZ name, for example, us-west-2b.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A local resource is the host where the agent is installed. Local resources can be a a subnet, a VPC, or an Availability Zone.

" + "smithy.api#documentation": "

A local resource is the host where the agent is installed. Local resources can be a a subnet, a VPC, an Availability Zone, or an Amazon Web Services service.

" } }, "com.amazonaws.networkflowmonitor#MonitorLocalResourceType": { @@ -1858,6 +1867,12 @@ "traits": { "smithy.api#enumValue": "AWS::EC2::Subnet" } + }, + "AWS_REGION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Region" + } } } }, @@ -1902,20 +1917,20 @@ "type": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResourceType", "traits": { - "smithy.api#documentation": "

The type of the remote resource. Valid values are AWS::EC2::VPC AWS::AvailabilityZone, AWS::EC2::Subnet, or AWS::AWSService.

", + "smithy.api#documentation": "

The type of the remote resource. Valid values are AWS::EC2::VPC AWS::AvailabilityZone, AWS::EC2::Subnet, AWS::AWSService, or AWS::Region.

", "smithy.api#required": {} } }, "identifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The identifier of the remote resource, such as an ARN.

", + "smithy.api#documentation": "

The identifier of the remote resource. For a VPC or subnet, this identifier is the VPC Amazon Resource Name (ARN) or subnet ARN. For an Availability Zone, this identifier is the AZ name, for example, us-west-2b. For an Amazon Web Services Region , this identifier is the Region name, for example, us-west-2.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A remote resource is the other endpoint in a network flow. That is, one endpoint is the local resource and the other is the remote resource. Remote resources can be a a subnet, a VPC, an Availability Zone, or an Amazon Web Services service.

" + "smithy.api#documentation": "

A remote resource is the other endpoint in a network flow. That is, one endpoint is the local resource and the other is the remote resource. Remote resources can be a a subnet, a VPC, an Availability Zone, an Amazon Web Services service, or an Amazon Web Services Region.

When a remote resource is an Amazon Web Services Region, Network Flow Monitor provides network performance measurements up to the edge of the Region that you specify.

" } }, "com.amazonaws.networkflowmonitor#MonitorRemoteResourceType": { @@ -1944,6 +1959,12 @@ "traits": { "smithy.api#enumValue": "AWS::AWSService" } + }, + "AWS_REGION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Region" + } } } }, @@ -2063,7 +2084,7 @@ } }, "traits": { - "smithy.api#documentation": "

A summary of information about a monitor, includ the ARN, the name, and the status.

" + "smithy.api#documentation": "

A summary of information about a monitor, including the ARN, the name, and the status.

" } }, "com.amazonaws.networkflowmonitor#MonitorTopContributorsRow": { @@ -2120,7 +2141,7 @@ "destinationCategory": { "target": "com.amazonaws.networkflowmonitor#DestinationCategory", "traits": { - "smithy.api#documentation": "

The destination category for a top contributors row. Destination categories can be one of the following:

  • INTRA_AZ: Top contributor network flows within a single Availability Zone

  • INTER_AZ: Top contributor network flows between Availability Zones

  • INTER_VPC: Top contributor network flows between VPCs

  • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

  • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

" + "smithy.api#documentation": "

The destination category for a top contributors row. Destination categories can be one of the following:

  • INTRA_AZ: Top contributor network flows within a single Availability Zone

  • INTER_AZ: Top contributor network flows between Availability Zones

  • INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)

  • INTER_VPC: Top contributor network flows between VPCs

  • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

  • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

" } }, "remoteVpcId": { @@ -2528,102 +2549,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://networkflowmonitor-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://networkflowmonitor.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://networkflowmonitor-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://networkflowmonitor.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://networkflowmonitor-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://networkflowmonitor.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://networkflowmonitor-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://networkflowmonitor.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { @@ -2798,7 +2723,7 @@ "scopeId": { "target": "com.amazonaws.networkflowmonitor#ScopeId", "traits": { - "smithy.api#documentation": "

The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

", + "smithy.api#documentation": "

The identifier for the scope that includes the resources that you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for the accounts in a scope.

", "smithy.api#required": {} } }, @@ -2891,7 +2816,7 @@ "startTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.

", + "smithy.api#documentation": "

The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } @@ -2914,7 +2839,7 @@ "destinationCategory": { "target": "com.amazonaws.networkflowmonitor#DestinationCategory", "traits": { - "smithy.api#documentation": "

The category that you want to query top contributors for, for a specific monitor. Destination categories can be one of the following:

  • INTRA_AZ: Top contributor network flows within a single Availability Zone

  • INTER_AZ: Top contributor network flows between Availability Zones

  • INTER_VPC: Top contributor network flows between VPCs

  • AMAZON_S3: Top contributor network flows to or from Amazon S3

  • AMAZON_DYNAMODB: Top contributor network flows to or from Amazon Dynamo DB

  • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

", + "smithy.api#documentation": "

The category that you want to query top contributors for, for a specific monitor. Destination categories can be one of the following:

  • INTRA_AZ: Top contributor network flows within a single Availability Zone

  • INTER_AZ: Top contributor network flows between Availability Zones

  • INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)

  • INTER_VPC: Top contributor network flows between VPCs

  • AMAZON_S3: Top contributor network flows to or from Amazon S3

  • AMAZON_DYNAMODB: Top contributor network flows to or from Amazon Dynamo DB

  • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

", "smithy.api#required": {} } }, @@ -3034,7 +2959,7 @@ "startTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.

", + "smithy.api#documentation": "

The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } @@ -3057,7 +2982,7 @@ "destinationCategory": { "target": "com.amazonaws.networkflowmonitor#DestinationCategory", "traits": { - "smithy.api#documentation": "

The destination category for a top contributors. Destination categories can be one of the following:

  • INTRA_AZ: Top contributor network flows within a single Availability Zone

  • INTER_AZ: Top contributor network flows between Availability Zones

  • INTER_VPC: Top contributor network flows between VPCs

  • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

  • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

", + "smithy.api#documentation": "

The destination category for a top contributors. Destination categories can be one of the following:

  • INTRA_AZ: Top contributor network flows within a single Availability Zone

  • INTER_AZ: Top contributor network flows between Availability Zones

  • INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)

  • INTER_VPC: Top contributor network flows between VPCs

  • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

  • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

", "smithy.api#required": {} } } @@ -3095,7 +3020,7 @@ "startTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.

", + "smithy.api#documentation": "

The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } @@ -3118,7 +3043,7 @@ "destinationCategory": { "target": "com.amazonaws.networkflowmonitor#DestinationCategory", "traits": { - "smithy.api#documentation": "

The destination category for a top contributors row. Destination categories can be one of the following:

  • INTRA_AZ: Top contributor network flows within a single Availability Zone

  • INTER_AZ: Top contributor network flows between Availability Zones

  • INTER_VPC: Top contributor network flows between VPCs

  • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

  • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

", + "smithy.api#documentation": "

The destination category for a top contributors row. Destination categories can be one of the following:

  • INTRA_AZ: Top contributor network flows within a single Availability Zone

  • INTER_AZ: Top contributor network flows between Availability Zones

  • INTER_REGION: Top contributor network flows between Regions (to the edge of another Region)

  • INTER_VPC: Top contributor network flows between VPCs

  • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

  • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

", "smithy.api#required": {} } }, @@ -3518,20 +3443,20 @@ "targetId": { "target": "com.amazonaws.networkflowmonitor#TargetId", "traits": { - "smithy.api#documentation": "

The identifier for a target.

", + "smithy.api#documentation": "

The identifier for a target, which is currently always an account ID .

", "smithy.api#required": {} } }, "targetType": { "target": "com.amazonaws.networkflowmonitor#TargetType", "traits": { - "smithy.api#documentation": "

The type of a target. A target type is currently always ACCOUNT because a target is currently a single Amazon Web Services account.

", + "smithy.api#documentation": "

The type of a target. A target type is currently always ACCOUNT.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A target identifier is a pair of identifying information for a resource that is included in a target. A target identifier includes the target ID and the target type.

" + "smithy.api#documentation": "

A target identifier is a pair of identifying information for a scope that is included in a target. A target identifier is made up of a target ID and a target type. Currently the target ID is always an account ID and the target type is always ACCOUNT.

" } }, "com.amazonaws.networkflowmonitor#TargetResource": { @@ -3540,20 +3465,20 @@ "targetIdentifier": { "target": "com.amazonaws.networkflowmonitor#TargetIdentifier", "traits": { - "smithy.api#documentation": "

A target identifier is a pair of identifying information for a resource that is included in a target. A target identifier includes the target ID and the target type.

", + "smithy.api#documentation": "

A target identifier is a pair of identifying information for a scope. A target identifier is made up of a targetID (currently always an account ID) and a targetType (currently always an account).

", "smithy.api#required": {} } }, "region": { "target": "com.amazonaws.networkflowmonitor#AwsRegion", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region where the target resource is located.

", + "smithy.api#documentation": "

The Amazon Web Services Region for the scope.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A target resource in a scope. The resource is identified by a Region and a target identifier, which includes a target ID and a target type.

" + "smithy.api#documentation": "

A target resource in a scope. The resource is identified by a Region and an account, defined by a target identifier. A target identifier is made up of a target ID (currently always an account ID) and a target type (currently always ACCOUNT).

" } }, "com.amazonaws.networkflowmonitor#TargetResourceList": { @@ -3607,7 +3532,7 @@ "componentArn": { "target": "com.amazonaws.networkflowmonitor#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a tranversed component.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a traversed component.

" } }, "serviceName": { @@ -3767,7 +3692,7 @@ "localResourcesToAdd": { "target": "com.amazonaws.networkflowmonitor#MonitorLocalResources", "traits": { - "smithy.api#documentation": "

The local resources to add, as an array of resources with identifiers and types.

" + "smithy.api#documentation": "

Additional local resources to specify network flows for a monitor, as an array of resources with identifiers and types. A local resource in a workload is the location of hosts where the Network Flow Monitor agent is installed.

" } }, "localResourcesToRemove": { @@ -3779,13 +3704,13 @@ "remoteResourcesToAdd": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResources", "traits": { - "smithy.api#documentation": "

The remove resources to add, as an array of resources with identifiers and types.

" + "smithy.api#documentation": "

The remote resources to add, as an array of resources with identifiers and types.

A remote resource is the other endpoint in the flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.

" } }, "remoteResourcesToRemove": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResources", "traits": { - "smithy.api#documentation": "

The remove resources to remove, as an array of resources with identifiers and types.

" + "smithy.api#documentation": "

The remote resources to remove, as an array of resources with identifiers and types.

A remote resource is the other endpoint specified for the network flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.

" } }, "clientToken": { @@ -3827,14 +3752,14 @@ "localResources": { "target": "com.amazonaws.networkflowmonitor#MonitorLocalResources", "traits": { - "smithy.api#documentation": "

The local resources updated for a monitor, as an array of resources with identifiers and types.

", + "smithy.api#documentation": "

The local resources to monitor. A local resource in a workload is the location of hosts where the Network Flow Monitor agent is installed.

", "smithy.api#required": {} } }, "remoteResources": { "target": "com.amazonaws.networkflowmonitor#MonitorRemoteResources", "traits": { - "smithy.api#documentation": "

The remote resources updated for a monitor, as an array of resources with identifiers and types.

", + "smithy.api#documentation": "

The remote resources updated for a monitor, as an array of resources with identifiers and types.

A remote resource is the other endpoint specified for the network flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.

", "smithy.api#required": {} } }, @@ -4103,7 +4028,7 @@ "remoteIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The identifier of a remote resource.

" + "smithy.api#documentation": "

The identifier of a remote resource. For a VPC or subnet, this identifier is the VPC Amazon Resource Name (ARN) or subnet ARN. For an Availability Zone, this identifier is the AZ name, for example, us-west-2b. For an Amazon Web Services Region , this identifier is the Region name, for example, us-west-2.

" } }, "value": { diff --git a/codegen/sdk/aws-models/networkmanager.json b/codegen/sdk/aws-models/networkmanager.json index c5bfcb475ef..82655b443b3 100644 --- a/codegen/sdk/aws-models/networkmanager.json +++ b/codegen/sdk/aws-models/networkmanager.json @@ -10162,17 +10162,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -10194,17 +10183,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -10226,17 +10204,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -10258,17 +10225,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -10290,17 +10246,6 @@ "UseDualStack": false } }, - { - "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": { @@ -10322,17 +10267,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -10355,18 +10289,28 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://networkmanager-fips.us-isof-south-1.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -10377,43 +10321,53 @@ } ] }, - "url": "https://networkmanager-fips.us-isof-south-1.csp.hci.ic.gov" + "url": "https://networkmanager.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eusc-de-east-1" + } + ] + }, + "url": "https://networkmanager-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingRegion": "us-isof-south-1" + "signingRegion": "eusc-de-east-1" } ] }, - "url": "https://networkmanager.us-isof-south-1.csp.hci.ic.gov" + "url": "https://networkmanager.eusc-de-east-1.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } diff --git a/codegen/sdk/aws-models/networkmonitor.json b/codegen/sdk/aws-models/networkmonitor.json index d1c5ae19bbe..995e8f7dd99 100644 --- a/codegen/sdk/aws-models/networkmonitor.json +++ b/codegen/sdk/aws-models/networkmonitor.json @@ -1707,17 +1707,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1731,17 +1720,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1755,17 +1733,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1779,17 +1746,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/notifications.json b/codegen/sdk/aws-models/notifications.json index 9857e2e027f..7450aefe244 100644 --- a/codegen/sdk/aws-models/notifications.json +++ b/codegen/sdk/aws-models/notifications.json @@ -37,6 +37,12 @@ "traits": { "smithy.api#enumValue": "PENDING" } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } } } }, @@ -253,7 +259,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to associate a new Channel with a particular NotificationConfiguration" }, - "smithy.api#documentation": "

Associates a delivery Channel with a particular NotificationConfiguration. Supported Channels include Chatbot,\nthe Console Mobile Application, and emails (notifications-contacts).

", + "smithy.api#documentation": "

Associates a delivery Channel with a particular NotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

", "smithy.api#http": { "code": 201, "method": "POST", @@ -268,7 +274,7 @@ "arn": { "target": "com.amazonaws.notifications#ChannelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Channel to associate with the NotificationConfiguration.

\n

Supported ARNs include Chatbot, the Console Mobile Application, and notifications-contacts.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Channel to associate with the NotificationConfiguration.

Supported ARNs include Amazon Q Developer in chat applications, the Console Mobile Application, and notifications-contacts.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -276,7 +282,7 @@ "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { - "smithy.api#documentation": "

The ARN of the NotificationConfiguration to associate with the\n Channel.

", + "smithy.api#documentation": "

The ARN of the NotificationConfiguration to associate with the Channel.

", "smithy.api#required": {} } } @@ -403,7 +409,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to associate a Channel\n to a particular Managed Notification Configuration" }, - "smithy.api#documentation": "

Associates an additional Channel with a particular ManagedNotificationConfiguration.

\n

Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).

", + "smithy.api#documentation": "

Associates an additional Channel with a particular ManagedNotificationConfiguration.

Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

", "smithy.api#http": { "code": 201, "method": "PUT", @@ -418,7 +424,7 @@ "channelArn": { "target": "com.amazonaws.notifications#ChannelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Channel to associate with the ManagedNotificationConfiguration.

\n

Supported ARNs include Chatbot, the Console Mobile Application, and email (notifications-contacts).

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Channel to associate with the ManagedNotificationConfiguration.

Supported ARNs include Amazon Q Developer in chat applications, the Console Mobile Application, and email (notifications-contacts).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -442,6 +448,81 @@ "smithy.api#output": {} } }, + "com.amazonaws.notifications#AssociateOrganizationalUnit": { + "type": "operation", + "input": { + "target": "com.amazonaws.notifications#AssociateOrganizationalUnitRequest" + }, + "output": { + "target": "com.amazonaws.notifications#AssociateOrganizationalUnitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.notifications#AccessDeniedException" + }, + { + "target": "com.amazonaws.notifications#ConflictException" + }, + { + "target": "com.amazonaws.notifications#InternalServerException" + }, + { + "target": "com.amazonaws.notifications#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.notifications#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.notifications#ThrottlingException" + }, + { + "target": "com.amazonaws.notifications#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#iamAction": { + "documentation": "Grants permission to associate an Organizational Unit with a particular NotificationConfiguration" + }, + "smithy.api#documentation": "

Associates an organizational unit with a notification configuration.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/organizational-units/associate/{organizationalUnitId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.notifications#AssociateOrganizationalUnitRequest": { + "type": "structure", + "members": { + "organizationalUnitId": { + "target": "com.amazonaws.notifications#OrganizationalUnitId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the organizational unit to associate.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "notificationConfigurationArn": { + "target": "com.amazonaws.notifications#NotificationConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification configuration to associate with the organizational unit.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.notifications#AssociateOrganizationalUnitResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.notifications#Channel": { "type": "resource", "identifiers": { @@ -587,7 +668,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to create a new EventRule, associating it with a NotificationConfiguration" }, - "smithy.api#documentation": "

Creates an \n EventRule\n that\n is associated with a specified NotificationConfiguration.

", + "smithy.api#documentation": "

Creates an EventRule that is associated with a specified NotificationConfiguration.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -602,34 +683,34 @@ "notificationConfigurationArn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the NotificationConfiguration associated\n with this EventRule.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the NotificationConfiguration associated with this EventRule.

", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.notifications#Source", "traits": { - "smithy.api#documentation": "

The matched event source.

\n

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", + "smithy.api#documentation": "

The matched event source.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "smithy.api#required": {} } }, "eventType": { "target": "com.amazonaws.notifications#EventType", "traits": { - "smithy.api#documentation": "

The event type to match.

\n

Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", + "smithy.api#documentation": "

The event type to match.

Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "smithy.api#required": {} } }, "eventPattern": { "target": "com.amazonaws.notifications#EventRuleEventPattern", "traits": { - "smithy.api#documentation": "

An additional event pattern used to further filter the events this\n EventRule receives.

\n

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.\n

" + "smithy.api#documentation": "

An additional event pattern used to further filter the events this EventRule receives.

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

" } }, "regions": { "target": "com.amazonaws.notifications#Regions", "traits": { - "smithy.api#documentation": "

A list of Amazon Web Services Regions that send events to this\n EventRule.

", + "smithy.api#documentation": "

A list of Amazon Web Services Regions that send events to this EventRule.

", "smithy.api#required": {} } } @@ -729,7 +810,7 @@ "aggregationDuration": { "target": "com.amazonaws.notifications#AggregationDuration", "traits": { - "smithy.api#documentation": "

The aggregation preference of the NotificationConfiguration.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n LONG\n

      \n
        \n
      • \n

        Aggregate notifications for long periods of time (12 hours).

        \n
      • \n
      \n
    • \n
    • \n

      \n SHORT\n

      \n
        \n
      • \n

        Aggregate notifications for short periods of time (5 minutes).

        \n
      • \n
      \n
    • \n
    • \n

      \n NONE\n

      \n
        \n
      • \n

        Don't aggregate notifications.

        \n
      • \n
      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The aggregation preference of the NotificationConfiguration.

  • Values:

    • LONG

      • Aggregate notifications for long periods of time (12 hours).

    • SHORT

      • Aggregate notifications for short periods of time (5 minutes).

    • NONE

      • Don't aggregate notifications.

" } }, "tags": { @@ -884,7 +965,7 @@ "arn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the NotificationConfiguration to\n delete.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the NotificationConfiguration to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -934,7 +1015,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to deregister a NotificationHub" }, - "smithy.api#documentation": "

Deregisters a NotificationConfiguration in the specified Region.

\n \n

You can't deregister the last NotificationHub in the account.\n NotificationEvents stored in the deregistered NotificationConfiguration are no\n longer be visible. Recreating a new NotificationConfiguration in the same Region restores access\n to those NotificationEvents.

\n
", + "smithy.api#documentation": "

Deregisters a NotificationConfiguration in the specified Region.

You can't deregister the last NotificationHub in the account. NotificationEvents stored in the deregistered NotificationConfiguration are no longer be visible. Recreating a new NotificationConfiguration in the same Region restores access to those NotificationEvents.

", "smithy.api#http": { "code": 200, "method": "DELETE", @@ -972,7 +1053,7 @@ "statusSummary": { "target": "com.amazonaws.notifications#NotificationHubStatusSummary", "traits": { - "smithy.api#documentation": "

\n NotificationConfiguration status information.

", + "smithy.api#documentation": "

NotificationConfiguration status information.

", "smithy.api#required": {} } } @@ -1106,7 +1187,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to remove a Channel from a NotificationConfiguration" }, - "smithy.api#documentation": "

Disassociates a Channel from a specified NotificationConfiguration. Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).

", + "smithy.api#documentation": "

Disassociates a Channel from a specified NotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1247,7 +1328,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to remove a Channel from a Managed Notification Configuration" }, - "smithy.api#documentation": "

Disassociates an additional Channel from a particular ManagedNotificationConfiguration.

\n

Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).

", + "smithy.api#documentation": "

Disassociates an additional Channel from a particular ManagedNotificationConfiguration.

Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -1286,6 +1367,75 @@ "smithy.api#output": {} } }, + "com.amazonaws.notifications#DisassociateOrganizationalUnit": { + "type": "operation", + "input": { + "target": "com.amazonaws.notifications#DisassociateOrganizationalUnitRequest" + }, + "output": { + "target": "com.amazonaws.notifications#DisassociateOrganizationalUnitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.notifications#AccessDeniedException" + }, + { + "target": "com.amazonaws.notifications#InternalServerException" + }, + { + "target": "com.amazonaws.notifications#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.notifications#ThrottlingException" + }, + { + "target": "com.amazonaws.notifications#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#iamAction": { + "documentation": "Grants permission to remove an Organizational Unit from a NotificationConfiguration" + }, + "smithy.api#documentation": "

Removes the association between an organizational unit and a notification configuration.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/organizational-units/disassociate/{organizationalUnitId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.notifications#DisassociateOrganizationalUnitRequest": { + "type": "structure", + "members": { + "organizationalUnitId": { + "target": "com.amazonaws.notifications#OrganizationalUnitId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the organizational unit to disassociate.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "notificationConfigurationArn": { + "target": "com.amazonaws.notifications#NotificationConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification configuration to disassociate from the organizational unit.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.notifications#DisassociateOrganizationalUnitResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.notifications#EnableNotificationsAccessForOrganization": { "type": "operation", "input": { @@ -1442,7 +1592,7 @@ "status": { "target": "com.amazonaws.notifications#EventRuleStatus", "traits": { - "smithy.api#documentation": "

The status of the EventRule.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n ACTIVE\n

      \n
        \n
      • \n

        The EventRule can process events.

        \n
      • \n
      \n
    • \n
    • \n

      \n INACTIVE\n

      \n
        \n
      • \n

        The EventRule may be unable to process events.

        \n
      • \n
      \n
    • \n
    • \n

      \n CREATING\n

      \n
        \n
      • \n

        The EventRule is being created.

        \n

        Only GET and LIST calls can be run.

        \n
      • \n
      \n
    • \n
    • \n

      \n UPDATING\n

      \n
        \n
      • \n

        The EventRule is being updated.

        \n

        Only GET and LIST calls can be run.

        \n
      • \n
      \n
    • \n
    • \n

      \n DELETING\n

      \n
        \n
      • \n

        The EventRule is being deleted.

        \n

        Only GET and LIST calls can be run.

        \n
      • \n
      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

The status of the EventRule.

  • Values:

    • ACTIVE

      • The EventRule can process events.

    • INACTIVE

      • The EventRule may be unable to process events.

    • CREATING

      • The EventRule is being created.

        Only GET and LIST calls can be run.

    • UPDATING

      • The EventRule is being updated.

        Only GET and LIST calls can be run.

    • DELETING

      • The EventRule is being deleted.

        Only GET and LIST calls can be run.

", "smithy.api#required": {} } }, @@ -1464,7 +1614,7 @@ "arn": { "target": "com.amazonaws.notifications#EventRuleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the EventRule. CloudFormation stack generates this ARN and\n then uses this ARN to associate with the NotificationConfiguration.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the EventRule. CloudFormation stack generates this ARN and then uses this ARN to associate with the NotificationConfiguration.

", "smithy.api#required": {} } }, @@ -1485,21 +1635,21 @@ "source": { "target": "com.amazonaws.notifications#Source", "traits": { - "smithy.api#documentation": "

The event source this rule should match with the EventBridge event sources. It must match with atleast one of the valid EventBridge event sources. Only Amazon Web Services service sourced events are supported. \n For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the \n Amazon EventBridge User Guide.

", + "smithy.api#documentation": "

The event source this rule should match with the EventBridge event sources. It must match with atleast one of the valid EventBridge event sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "smithy.api#required": {} } }, "eventType": { "target": "com.amazonaws.notifications#EventType", "traits": { - "smithy.api#documentation": "

The event type this rule should match with the EventBridge events. It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch State Change. For more information, see Event delivery from Amazon Web Services services in the \n Amazon EventBridge User Guide.

", + "smithy.api#documentation": "

The event type this rule should match with the EventBridge events. It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "smithy.api#required": {} } }, "eventPattern": { "target": "com.amazonaws.notifications#EventRuleEventPattern", "traits": { - "smithy.api#documentation": "

An additional event pattern used to further filter the events this EventRule receives.

\n

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.\n

", + "smithy.api#documentation": "

An additional event pattern used to further filter the events this EventRule receives.

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

", "smithy.api#required": {} } }, @@ -1513,7 +1663,7 @@ "managedRules": { "target": "com.amazonaws.notifications#ManagedRuleArns", "traits": { - "smithy.api#documentation": "

A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.

\n \n

These are created by User Notifications within your account so your EventRules can function.

\n
", + "smithy.api#documentation": "

A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.

These are created by User Notifications within your account so your EventRules can function.

", "smithy.api#required": {} } }, @@ -1642,21 +1792,21 @@ "source": { "target": "com.amazonaws.notifications#Source", "traits": { - "smithy.api#documentation": "

The matched event source.

\n

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", + "smithy.api#documentation": "

The matched event source.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "smithy.api#required": {} } }, "eventType": { "target": "com.amazonaws.notifications#EventType", "traits": { - "smithy.api#documentation": "

The event type to match.

\n

Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", + "smithy.api#documentation": "

The event type to match.

Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "smithy.api#required": {} } }, "eventPattern": { "target": "com.amazonaws.notifications#EventRuleEventPattern", "traits": { - "smithy.api#documentation": "

An additional event pattern used to further filter the events this EventRule receives.

\n

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.\n

", + "smithy.api#documentation": "

An additional event pattern used to further filter the events this EventRule receives.

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

", "smithy.api#required": {} } }, @@ -1670,7 +1820,7 @@ "managedRules": { "target": "com.amazonaws.notifications#ManagedRuleArns", "traits": { - "smithy.api#documentation": "

A list of managed rules from EventBridge that are associated with this\n EventRule.

\n \n

These are created by User Notifications within your account so this EventRule functions.

\n
", + "smithy.api#documentation": "

A list of managed rules from EventBridge that are associated with this EventRule.

These are created by User Notifications within your account so this EventRule functions.

", "smithy.api#required": {} } }, @@ -2076,7 +2226,13 @@ "aggregationDuration": { "target": "com.amazonaws.notifications#AggregationDuration", "traits": { - "smithy.api#documentation": "

The aggregation preference of the NotificationConfiguration.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n LONG\n

      \n
        \n
      • \n

        Aggregate notifications for long periods of time (12 hours).

        \n
      • \n
      \n
    • \n
    • \n

      \n SHORT\n

      \n
        \n
      • \n

        Aggregate notifications for short periods of time (5 minutes).

        \n
      • \n
      \n
    • \n
    • \n

      \n NONE\n

      \n
        \n
      • \n

        Don't aggregate notifications.

        \n
      • \n
      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The aggregation preference of the NotificationConfiguration.

  • Values:

    • LONG

      • Aggregate notifications for long periods of time (12 hours).

    • SHORT

      • Aggregate notifications for short periods of time (5 minutes).

    • NONE

      • Don't aggregate notifications.

" + } + }, + "subtype": { + "target": "com.amazonaws.notifications#NotificationConfigurationSubtype", + "traits": { + "smithy.api#documentation": "

The subtype of the notification configuration returned in the response.

" } } }, @@ -2114,7 +2270,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to get a NotificationEvent" }, - "smithy.api#documentation": "

Returns a specified NotificationEvent.

\n \n

User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. GetNotificationEvent only returns notifications stored in the same Region in which the action is called.\n\t User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. \n\t For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.

\n
", + "smithy.api#documentation": "

Returns a specified NotificationEvent.

User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. GetNotificationEvent only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2333,7 +2489,7 @@ "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { - "smithy.api#documentation": "

The start token for paginated calls. Retrieved from the response of a previous\n ListNotificationEvents call. NextToken uses Base64 encoding.

", + "smithy.api#documentation": "

The start token for paginated calls. Retrieved from the response of a previous ListNotificationEvents call. NextToken uses Base64 encoding.

", "smithy.api#httpQuery": "nextToken" } } @@ -2433,7 +2589,7 @@ "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { - "smithy.api#documentation": "

The start token for paginated calls. Retrieved from the response of a previous\n ListEventRules call. Next token uses Base64 encoding.

", + "smithy.api#documentation": "

The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.

", "smithy.api#httpQuery": "nextToken" } } @@ -2941,6 +3097,127 @@ "smithy.api#output": {} } }, + "com.amazonaws.notifications#ListMemberAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.notifications#ListMemberAccountsRequest" + }, + "output": { + "target": "com.amazonaws.notifications#ListMemberAccountsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.notifications#AccessDeniedException" + }, + { + "target": "com.amazonaws.notifications#InternalServerException" + }, + { + "target": "com.amazonaws.notifications#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.notifications#ThrottlingException" + }, + { + "target": "com.amazonaws.notifications#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#iamAction": { + "documentation": "Grants permission to list MemberAccounts by AdminNotificationConfiguration" + }, + "smithy.api#documentation": "

Returns a list of member accounts associated with a notification configuration.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/list-member-accounts" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "memberAccounts" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.notifications#ListMemberAccountsRequest": { + "type": "structure", + "members": { + "notificationConfigurationArn": { + "target": "com.amazonaws.notifications#NotificationConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification configuration used to filter the member accounts.

", + "smithy.api#httpQuery": "notificationConfigurationArn", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. Valid values are 1-100.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "nextToken": { + "target": "com.amazonaws.notifications#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results. Use the value returned in the previous response.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "memberAccount": { + "target": "com.amazonaws.notifications#AccountId", + "traits": { + "smithy.api#documentation": "

The member account identifier used to filter the results.

", + "smithy.api#httpQuery": "memberAccount" + } + }, + "status": { + "target": "com.amazonaws.notifications#MemberAccountNotificationConfigurationStatus", + "traits": { + "smithy.api#documentation": "

The status used to filter the member accounts.

", + "smithy.api#httpQuery": "status" + } + }, + "organizationalUnitId": { + "target": "com.amazonaws.notifications#OrganizationalUnitId", + "traits": { + "smithy.api#documentation": "

The organizational unit ID used to filter the member accounts.

", + "smithy.api#httpQuery": "organizationalUnitId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.notifications#ListMemberAccountsResponse": { + "type": "structure", + "members": { + "memberAccounts": { + "target": "com.amazonaws.notifications#MemberAccounts", + "traits": { + "smithy.api#documentation": "

The list of member accounts that match the specified criteria.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.notifications#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.notifications#ListNotificationConfigurations": { "type": "operation", "input": { @@ -2968,7 +3245,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to list NotificationConfigurations" }, - "smithy.api#documentation": "

Returns a list of abbreviated NotificationConfigurations according to\n specified filters, in reverse chronological order (newest first).

", + "smithy.api#documentation": "

Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).

", "smithy.api#http": { "code": 200, "method": "GET", @@ -3005,7 +3282,7 @@ "eventRuleSource": { "target": "com.amazonaws.notifications#Source", "traits": { - "smithy.api#documentation": "

The matched event source.

\n

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", + "smithy.api#documentation": "

The matched event source.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "smithy.api#httpQuery": "eventRuleSource" } }, @@ -3019,10 +3296,17 @@ "status": { "target": "com.amazonaws.notifications#NotificationConfigurationStatus", "traits": { - "smithy.api#documentation": "

The NotificationConfiguration status to match.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n ACTIVE\n

      \n
        \n
      • \n

        All EventRules are ACTIVE and any call can be run.

        \n
      • \n
      \n
    • \n
    • \n

      \n PARTIALLY_ACTIVE\n

      \n
        \n
      • \n

        Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

        \n
      • \n
      • \n

        Any call can be run.

        \n
      • \n
      \n
    • \n
    • \n

      \n INACTIVE\n

      \n
        \n
      • \n

        All EventRules are INACTIVE and any call can be run.

        \n
      • \n
      \n
    • \n
    • \n

      \n DELETING\n

      \n
        \n
      • \n

        This NotificationConfiguration is being deleted.

        \n
      • \n
      • \n

        Only GET and LIST calls can be run.

        \n
      • \n
      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

The NotificationConfiguration status to match.

  • Values:

    • ACTIVE

      • All EventRules are ACTIVE and any call can be run.

    • PARTIALLY_ACTIVE

      • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

      • Any call can be run.

    • INACTIVE

      • All EventRules are INACTIVE and any call can be run.

    • DELETING

      • This NotificationConfiguration is being deleted.

      • Only GET and LIST calls can be run.

", "smithy.api#httpQuery": "status" } }, + "subtype": { + "target": "com.amazonaws.notifications#NotificationConfigurationSubtype", + "traits": { + "smithy.api#documentation": "

The subtype used to filter the notification configurations in the request.

", + "smithy.api#httpQuery": "subtype" + } + }, "maxResults": { "target": "smithy.api#Integer", "traits": { @@ -3037,7 +3321,7 @@ "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { - "smithy.api#documentation": "

The start token for paginated calls. Retrieved from the response of a previous\n ListEventRules call. Next token uses Base64 encoding.

", + "smithy.api#documentation": "

The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.

", "smithy.api#httpQuery": "nextToken" } } @@ -3094,7 +3378,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to list NotificationEvents" }, - "smithy.api#documentation": "

Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).

\n \n

User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called.\n\t User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub.\n\t For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.

\n
", + "smithy.api#documentation": "

Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).

User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the Amazon Web Services User Notifications User Guide.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -3154,7 +3438,7 @@ "source": { "target": "com.amazonaws.notifications#Source", "traits": { - "smithy.api#documentation": "

The matched event source.

\n

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", + "smithy.api#documentation": "

The matched event source.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "smithy.api#httpQuery": "source" } }, @@ -3168,7 +3452,7 @@ "aggregateNotificationEventArn": { "target": "com.amazonaws.notifications#NotificationEventArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to\n match.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to match.

", "smithy.api#httpQuery": "aggregateNotificationEventArn" } }, @@ -3186,9 +3470,16 @@ "nextToken": { "target": "com.amazonaws.notifications#NextToken", "traits": { - "smithy.api#documentation": "

The start token for paginated calls. Retrieved from the response of a previous\n ListEventRules call. Next token uses Base64 encoding.

", + "smithy.api#documentation": "

The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.

", "smithy.api#httpQuery": "nextToken" } + }, + "organizationalUnitId": { + "target": "com.amazonaws.notifications#OrganizationalUnitId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the organizational unit used to filter notification events.

", + "smithy.api#httpQuery": "organizationalUnitId" + } } }, "traits": { @@ -3320,6 +3611,106 @@ "smithy.api#output": {} } }, + "com.amazonaws.notifications#ListOrganizationalUnits": { + "type": "operation", + "input": { + "target": "com.amazonaws.notifications#ListOrganizationalUnitsRequest" + }, + "output": { + "target": "com.amazonaws.notifications#ListOrganizationalUnitsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.notifications#AccessDeniedException" + }, + { + "target": "com.amazonaws.notifications#InternalServerException" + }, + { + "target": "com.amazonaws.notifications#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.notifications#ThrottlingException" + }, + { + "target": "com.amazonaws.notifications#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#iamAction": { + "documentation": "Grants permission to list Organizational Units by NotificationConfiguration" + }, + "smithy.api#documentation": "

Returns a list of organizational units associated with a notification configuration.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/organizational-units" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "organizationalUnits" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.notifications#ListOrganizationalUnitsRequest": { + "type": "structure", + "members": { + "notificationConfigurationArn": { + "target": "com.amazonaws.notifications#NotificationConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification configuration used to filter the organizational units.

", + "smithy.api#httpQuery": "notificationConfigurationArn", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of organizational units to return in a single call. Valid values are 1-100.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "nextToken": { + "target": "com.amazonaws.notifications#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results. Use the value returned in the previous response.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.notifications#ListOrganizationalUnitsResponse": { + "type": "structure", + "members": { + "organizationalUnits": { + "target": "com.amazonaws.notifications#OrganizationalUnits", + "traits": { + "smithy.api#documentation": "

The list of organizational units that match the specified criteria.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.notifications#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use for the next page of results. If there are no additional results, this value is null.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.notifications#ListTagsForResource": { "type": "operation", "input": { @@ -3350,7 +3741,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to get tags for a resource" }, - "smithy.api#documentation": "

Returns a list of tags for a specified Amazon Resource Name (ARN).

\n

For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.

\n \n

This is only supported for NotificationConfigurations.

\n
", + "smithy.api#documentation": "

Returns a list of tags for a specified Amazon Resource Name (ARN).

For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.

This is only supported for NotificationConfigurations.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{arn}" @@ -3526,14 +3917,14 @@ "channelType": { "target": "com.amazonaws.notifications#ChannelType", "traits": { - "smithy.api#documentation": "

The type of notification channel used for message delivery.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n ACCOUNT_CONTACT\n

      \n
        \n
      • \n

        Delivers notifications to Account Managed contacts through the User Notification Service.

        \n
      • \n
      \n
    • \n
    • \n

      \n MOBILE\n

      \n
        \n
      • \n

        Delivers notifications through the Amazon Web Services Console Mobile Application to mobile devices.

        \n
      • \n
      \n
    • \n
    • \n

      \n CHATBOT\n

      \n
        \n
      • \n

        Delivers notifications through Chatbot to collaboration platforms (Slack, Chime).

        \n
      • \n
      \n
    • \n
    • \n

      \n EMAIL\n

      \n
        \n
      • \n

        Delivers notifications to email addresses.

        \n
      • \n
      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

The type of notification channel used for message delivery.

  • Values:

    • ACCOUNT_CONTACT

      • Delivers notifications to Account Managed contacts through the User Notification Service.

    • MOBILE

      • Delivers notifications through the Amazon Web Services Console Mobile Application to mobile devices.

    • CHATBOT

      • Delivers notifications through Amazon Q Developer in chat applications to collaboration platforms (Slack, Chime).

    • EMAIL

      • Delivers notifications to email addresses.

", "smithy.api#required": {} } }, "overrideOption": { "target": "com.amazonaws.notifications#ChannelAssociationOverrideOption", "traits": { - "smithy.api#documentation": "

Controls whether users can modify channel associations for a notification configuration.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n ENABLED\n

      \n
        \n
      • \n

        Users can associate or disassociate channels with the notification configuration.

        \n
      • \n
      \n
    • \n
    • \n

      \n DISABLED\n

      \n
        \n
      • \n

        Users cannot associate or disassociate channels with the notification configuration.

        \n
      • \n
      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

Controls whether users can modify channel associations for a notification configuration.

  • Values:

    • ENABLED

      • Users can associate or disassociate channels with the notification configuration.

    • DISABLED

      • Users cannot associate or disassociate channels with the notification configuration.

" } } }, @@ -3585,14 +3976,14 @@ "notificationType": { "target": "com.amazonaws.notifications#NotificationType", "traits": { - "smithy.api#documentation": "

The type of event causing the notification.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n ALERT\n

      \n
        \n
      • \n

        A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

        \n
      • \n
      \n
    • \n
    • \n

      \n WARNING\n

      \n
        \n
      • \n

        A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

        \n
      • \n
      \n
    • \n
    • \n

      \n ANNOUNCEMENT\n

      \n
        \n
      • \n

        A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

        \n
      • \n
      \n
    • \n
    • \n

      \n INFORMATIONAL\n

      \n
        \n
      • \n

        A notification about informational messages. For example, recommendations, service announcements, or reminders.

        \n
      • \n
      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

The type of event causing the notification.

  • Values:

    • ALERT

      • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

    • WARNING

      • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

    • ANNOUNCEMENT

      • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

    • INFORMATIONAL

      • A notification about informational messages. For example, recommendations, service announcements, or reminders.

", "smithy.api#required": {} } }, "eventStatus": { "target": "com.amazonaws.notifications#EventStatus", "traits": { - "smithy.api#documentation": "

The assesed nature of the event.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n HEALTHY\n

      \n
        \n
      • \n

        All EventRules are ACTIVE.

        \n
      • \n
      \n
    • \n
    • \n

      \n UNHEALTHY\n

      \n
        \n
      • \n

        Some EventRules are ACTIVE and some are INACTIVE.

        \n
      • \n
      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The assesed nature of the event.

  • Values:

    • HEALTHY

      • All EventRules are ACTIVE.

    • UNHEALTHY

      • Some EventRules are ACTIVE and some are INACTIVE.

" } }, "aggregateManagedNotificationEventArn": { @@ -3759,14 +4150,14 @@ "eventStatus": { "target": "com.amazonaws.notifications#EventStatus", "traits": { - "smithy.api#documentation": "

The perceived nature of the event.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n HEALTHY\n

      \n
        \n
      • \n

        All EventRules are ACTIVE and any call can be run.

        \n
      • \n
      \n
    • \n
    • \n

      \n UNHEALTHY\n

      \n
        \n
      • \n

        Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

        \n
      • \n
      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

The perceived nature of the event.

  • Values:

    • HEALTHY

      • All EventRules are ACTIVE and any call can be run.

    • UNHEALTHY

      • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

", "smithy.api#required": {} } }, "notificationType": { "target": "com.amazonaws.notifications#NotificationType", "traits": { - "smithy.api#documentation": "

The Type of the event causing this notification.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n ALERT\n

      \n
        \n
      • \n

        A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

        \n
      • \n
      \n
    • \n
    • \n

      \n WARNING\n

      \n
        \n
      • \n

        A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

        \n
      • \n
      \n
    • \n
    • \n

      \n ANNOUNCEMENT\n

      \n
        \n
      • \n

        A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

        \n
      • \n
      \n
    • \n
    • \n

      \n INFORMATIONAL\n

      \n
        \n
      • \n

        A notification about informational messages. For example, recommendations, service announcements, or reminders.

        \n
      • \n
      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

The Type of the event causing this notification.

  • Values:

    • ALERT

      • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

    • WARNING

      • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

    • ANNOUNCEMENT

      • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

    • INFORMATIONAL

      • A notification about informational messages. For example, recommendations, service announcements, or reminders.

", "smithy.api#required": {} } } @@ -3901,14 +4292,14 @@ "notificationType": { "target": "com.amazonaws.notifications#NotificationType", "traits": { - "smithy.api#documentation": "

The nature of the event causing this notification.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n ALERT\n

      \n
        \n
      • \n

        A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

        \n
      • \n
      \n
    • \n
    • \n

      \n WARNING\n

      \n
        \n
      • \n

        A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

        \n
      • \n
      \n
    • \n
    • \n

      \n ANNOUNCEMENT\n

      \n
        \n
      • \n

        A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

        \n
      • \n
      \n
    • \n
    • \n

      \n INFORMATIONAL\n

      \n
        \n
      • \n

        A notification about informational messages. For example, recommendations, service announcements, or reminders.

        \n
      • \n
      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

The nature of the event causing this notification.

  • Values:

    • ALERT

      • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

    • WARNING

      • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

    • ANNOUNCEMENT

      • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

    • INFORMATIONAL

      • A notification about informational messages. For example, recommendations, service announcements, or reminders.

", "smithy.api#required": {} } }, "eventStatus": { "target": "com.amazonaws.notifications#EventStatus", "traits": { - "smithy.api#documentation": "

The status of an event.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n HEALTHY\n

      \n
        \n
      • \n

        All EventRules are ACTIVE and any call can be run.

        \n
      • \n
      \n
    • \n
    • \n

      \n UNHEALTHY\n

      \n
        \n
      • \n

        Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

        \n
      • \n
      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The status of an event.

  • Values:

    • HEALTHY

      • All EventRules are ACTIVE and any call can be run.

    • UNHEALTHY

      • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

" } }, "aggregationEventType": { @@ -3996,13 +4387,14 @@ "notificationEvent": { "target": "com.amazonaws.notifications#ManagedNotificationEventSummary", "traits": { + "smithy.api#documentation": "

", "smithy.api#required": {} } }, "aggregationEventType": { "target": "com.amazonaws.notifications#AggregationEventType", "traits": { - "smithy.api#documentation": "

The notifications aggregation type.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n AGGREGATE\n

      \n
        \n
      • \n

        The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.

        \n
      • \n
      \n
    • \n
    • \n

      \n CHILD\n

      \n
        \n
      • \n

        Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

        \n
      • \n
      \n
    • \n
    • \n

      \n NONE\n

      \n
        \n
      • \n

        The notification isn't aggregated.

        \n
      • \n
      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The notifications aggregation type.

  • Values:

    • AGGREGATE

      • The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.

    • CHILD

      • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

    • NONE

      • The notification isn't aggregated.

" } }, "organizationalUnitId": { @@ -4071,14 +4463,14 @@ "eventStatus": { "target": "com.amazonaws.notifications#EventStatus", "traits": { - "smithy.api#documentation": "

The managed notification event status.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n HEALTHY\n

      \n
        \n
      • \n

        All EventRules are ACTIVE.

        \n
      • \n
      \n
    • \n
    • \n

      \n UNHEALTHY\n

      \n
        \n
      • \n

        Some EventRules are ACTIVE and some are INACTIVE.

        \n
      • \n
      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

The managed notification event status.

  • Values:

    • HEALTHY

      • All EventRules are ACTIVE.

    • UNHEALTHY

      • Some EventRules are ACTIVE and some are INACTIVE.

", "smithy.api#required": {} } }, "notificationType": { "target": "com.amazonaws.notifications#NotificationType", "traits": { - "smithy.api#documentation": "

The Type of event causing the notification.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n ALERT\n

      \n
        \n
      • \n

        A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

        \n
      • \n
      \n
    • \n
    • \n

      \n WARNING\n

      \n
        \n
      • \n

        A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

        \n
      • \n
      \n
    • \n
    • \n

      \n ANNOUNCEMENT\n

      \n
        \n
      • \n

        A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

        \n
      • \n
      \n
    • \n
    • \n

      \n INFORMATIONAL\n

      \n
        \n
      • \n

        A notification about informational messages. For example, recommendations, service announcements, or reminders.

        \n
      • \n
      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

The Type of event causing the notification.

  • Values:

    • ALERT

      • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

    • WARNING

      • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

    • ANNOUNCEMENT

      • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

    • INFORMATIONAL

      • A notification about informational messages. For example, recommendations, service announcements, or reminders.

", "smithy.api#required": {} } } @@ -4121,7 +4513,7 @@ "source": { "target": "com.amazonaws.notifications#Source", "traits": { - "smithy.api#documentation": "

The source service of the notification.

\n

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", + "smithy.api#documentation": "

The source service of the notification.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "smithy.api#required": {} } }, @@ -4203,6 +4595,86 @@ } } }, + "com.amazonaws.notifications#MemberAccount": { + "type": "structure", + "members": { + "notificationConfigurationArn": { + "target": "com.amazonaws.notifications#NotificationConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification configuration associated with the member account.

" + } + }, + "accountId": { + "target": "com.amazonaws.notifications#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID of the member account.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.notifications#MemberAccountNotificationConfigurationStatus", + "traits": { + "smithy.api#documentation": "

The current status of the member account.

", + "smithy.api#required": {} + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The reason for the current status of the member account.

", + "smithy.api#required": {} + } + }, + "organizationalUnitId": { + "target": "com.amazonaws.notifications#OrganizationalUnitId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the organizational unit containing the member account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a member account.

" + } + }, + "com.amazonaws.notifications#MemberAccountNotificationConfigurationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACTIVE", + "value": "ACTIVE", + "documentation": "The member account Notification Configuration status is ACTIVE." + }, + { + "name": "PENDING", + "value": "PENDING", + "documentation": "The member account Notification Configuration status is PENDING." + }, + { + "name": "INACTIVE", + "value": "INACTIVE", + "documentation": "The member account Notification Configuration status is INACTIVE." + }, + { + "name": "CREATING", + "value": "CREATING", + "documentation": "The member account Notification Configuration status is CREATING." + }, + { + "name": "DELETING", + "value": "DELETING", + "documentation": "The member account Notification Configuration status is DELETING." + } + ] + } + }, + "com.amazonaws.notifications#MemberAccounts": { + "type": "list", + "member": { + "target": "com.amazonaws.notifications#MemberAccount" + } + }, "com.amazonaws.notifications#MessageComponents": { "type": "structure", "members": { @@ -4215,7 +4687,7 @@ "paragraphSummary": { "target": "com.amazonaws.notifications#TextPartReference", "traits": { - "smithy.api#documentation": "

A paragraph long or multiple sentence summary. For example, Chatbot notifications.

" + "smithy.api#documentation": "

A paragraph long or multiple sentence summary. For example, Amazon Q Developer in chat applications notifications.

" } }, "completeDescription": { @@ -4227,7 +4699,7 @@ "dimensions": { "target": "com.amazonaws.notifications#Dimensions", "traits": { - "smithy.api#documentation": "

A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.

\n \n

Included dimensions, keys, and values are subject to change.

\n
" + "smithy.api#documentation": "

A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.

Included dimensions, keys, and values are subject to change.

" } } }, @@ -4357,14 +4829,14 @@ "arn": { "target": "com.amazonaws.notifications#NotificationConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the NotificationConfiguration\n resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the NotificationConfiguration resource.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.notifications#NotificationConfigurationName", "traits": { - "smithy.api#documentation": "

The name of the NotificationConfiguration. Supports RFC 3986's\n unreserved characters.

", + "smithy.api#documentation": "

The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.

", "smithy.api#required": {} } }, @@ -4392,7 +4864,13 @@ "aggregationDuration": { "target": "com.amazonaws.notifications#AggregationDuration", "traits": { - "smithy.api#documentation": "

The aggregation preference of the NotificationConfiguration.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n LONG\n

      \n
        \n
      • \n

        Aggregate notifications for long periods of time (12 hours).

        \n
      • \n
      \n
    • \n
    • \n

      \n SHORT\n

      \n
        \n
      • \n

        Aggregate notifications for short periods of time (5 minutes).

        \n
      • \n
      \n
    • \n
    • \n

      \n NONE\n

      \n
        \n
      • \n

        Don't aggregate notifications.

        \n
      • \n
      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The aggregation preference of the NotificationConfiguration.

  • Values:

    • LONG

      • Aggregate notifications for long periods of time (12 hours).

    • SHORT

      • Aggregate notifications for short periods of time (5 minutes).

    • NONE

      • Don't aggregate notifications.

" + } + }, + "subtype": { + "target": "com.amazonaws.notifications#NotificationConfigurationSubtype", + "traits": { + "smithy.api#documentation": "

The subtype of the notification configuration.

" } } }, @@ -4400,6 +4878,23 @@ "smithy.api#documentation": "

Contains the complete list of fields for a NotificationConfiguration.

" } }, + "com.amazonaws.notifications#NotificationConfigurationSubtype": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACCOUNT", + "value": "ACCOUNT", + "documentation": "Notification configuration created by the account" + }, + { + "name": "ADMIN_MANAGED", + "value": "ADMIN_MANAGED", + "documentation": "Notification configuration managed by an administrator account" + } + ] + } + }, "com.amazonaws.notifications#NotificationConfigurations": { "type": "list", "member": { @@ -4456,14 +4951,14 @@ "notificationEvent": { "target": "com.amazonaws.notifications#NotificationEventSummary", "traits": { - "smithy.api#documentation": "

Refers to a NotificationEventSummary object.

\n

Similar in structure to content in the GetNotificationEvent response.

", + "smithy.api#documentation": "

Refers to a NotificationEventSummary object.

Similar in structure to content in the GetNotificationEvent response.

", "smithy.api#required": {} } }, "aggregationEventType": { "target": "com.amazonaws.notifications#AggregationEventType", "traits": { - "smithy.api#documentation": "

The NotificationConfiguration's aggregation type.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n AGGREGATE\n

      \n
        \n
      • \n

        The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.

        \n
      • \n
      \n
    • \n
    • \n

      \n CHILD\n

      \n
        \n
      • \n

        Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

        \n
      • \n
      \n
    • \n
    • \n

      \n NONE\n

      \n
        \n
      • \n

        The notification isn't aggregated.

        \n
      • \n
      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The NotificationConfiguration's aggregation type.

  • Values:

    • AGGREGATE

      • The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.

    • CHILD

      • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

    • NONE

      • The notification isn't aggregated.

" } }, "aggregateNotificationEventArn": { @@ -4477,6 +4972,12 @@ "traits": { "smithy.api#documentation": "

Provides an aggregated summary data for notification events.

" } + }, + "organizationalUnitId": { + "target": "com.amazonaws.notifications#OrganizationalUnitId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the organizational unit in the notification event overview.

" + } } }, "traits": { @@ -4548,26 +5049,26 @@ "notificationType": { "target": "com.amazonaws.notifications#NotificationType", "traits": { - "smithy.api#documentation": "

The type of event causing the notification.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n ALERT\n

      \n
        \n
      • \n

        A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

        \n
      • \n
      \n
    • \n
    • \n

      \n WARNING\n

      \n
        \n
      • \n

        A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

        \n
      • \n
      \n
    • \n
    • \n

      \n ANNOUNCEMENT\n

      \n
        \n
      • \n

        A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

        \n
      • \n
      \n
    • \n
    • \n

      \n INFORMATIONAL\n

      \n
        \n
      • \n

        A notification about informational messages. For example, recommendations, service announcements, or reminders.

        \n
      • \n
      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

The type of event causing the notification.

  • Values:

    • ALERT

      • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

    • WARNING

      • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

    • ANNOUNCEMENT

      • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

    • INFORMATIONAL

      • A notification about informational messages. For example, recommendations, service announcements, or reminders.

", "smithy.api#required": {} } }, "eventStatus": { "target": "com.amazonaws.notifications#EventStatus", "traits": { - "smithy.api#documentation": "

The assessed nature of the event.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n HEALTHY\n

      \n
        \n
      • \n

        All EventRules are ACTIVE and any call can be run.

        \n
      • \n
      \n
    • \n
    • \n

      \n UNHEALTHY\n

      \n
        \n
      • \n

        Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

        \n
      • \n
      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The assessed nature of the event.

  • Values:

    • HEALTHY

      • All EventRules are ACTIVE and any call can be run.

    • UNHEALTHY

      • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

" } }, "aggregationEventType": { "target": "com.amazonaws.notifications#AggregationEventType", "traits": { - "smithy.api#documentation": "

The aggregation type of the NotificationConfiguration.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n AGGREGATE\n

      \n
        \n
      • \n

        The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.

        \n
      • \n
      \n
    • \n
    • \n

      \n CHILD\n

      \n
        \n
      • \n

        Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

        \n
      • \n
      \n
    • \n
    • \n

      \n NONE\n

      \n
        \n
      • \n

        The notification isn't aggregated.

        \n
      • \n
      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The aggregation type of the NotificationConfiguration.

  • Values:

    • AGGREGATE

      • The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.

    • CHILD

      • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

    • NONE

      • The notification isn't aggregated.

" } }, "aggregateNotificationEventArn": { "target": "com.amazonaws.notifications#NotificationEventArn", "traits": { - "smithy.api#documentation": "

If the value of aggregationEventType is not NONE, this is the\n Amazon Resource Event (ARN) of the parent aggregate notification.

\n

This is omitted if notification isn't aggregated.

" + "smithy.api#documentation": "

If the value of aggregationEventType is not NONE, this is the Amazon Resource Event (ARN) of the parent aggregate notification.

This is omitted if notification isn't aggregated.

" } }, "aggregationSummary": { @@ -4603,6 +5104,12 @@ "smithy.api#documentation": "

A list of media elements.

", "smithy.api#required": {} } + }, + "organizationalUnitId": { + "target": "com.amazonaws.notifications#OrganizationalUnitId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the organizational unit associated with the notification event.

" + } } }, "traits": { @@ -4636,14 +5143,14 @@ "eventStatus": { "target": "com.amazonaws.notifications#EventStatus", "traits": { - "smithy.api#documentation": "

Provides additional information about the current status of the NotificationEvent.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n HEALTHY\n

      \n
        \n
      • \n

        All EventRules are ACTIVE.

        \n
      • \n
      \n
    • \n
    • \n

      \n UNHEALTHY\n

      \n
        \n
      • \n

        Some EventRules are ACTIVE and some are INACTIVE.

        \n
      • \n
      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

Provides additional information about the current status of the NotificationEvent.

  • Values:

    • HEALTHY

      • All EventRules are ACTIVE.

    • UNHEALTHY

      • Some EventRules are ACTIVE and some are INACTIVE.

", "smithy.api#required": {} } }, "notificationType": { "target": "com.amazonaws.notifications#NotificationType", "traits": { - "smithy.api#documentation": "

The type of event causing the notification.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n ALERT\n

      \n
        \n
      • \n

        A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

        \n
      • \n
      \n
    • \n
    • \n

      \n WARNING\n

      \n
        \n
      • \n

        A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

        \n
      • \n
      \n
    • \n
    • \n

      \n ANNOUNCEMENT\n

      \n
        \n
      • \n

        A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

        \n
      • \n
      \n
    • \n
    • \n

      \n INFORMATIONAL\n

      \n
        \n
      • \n

        A notification about informational messages. For example, recommendations, service announcements, or reminders.

        \n
      • \n
      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

The type of event causing the notification.

  • Values:

    • ALERT

      • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

    • WARNING

      • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

    • ANNOUNCEMENT

      • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

    • INFORMATIONAL

      • A notification about informational messages. For example, recommendations, service announcements, or reminders.

", "smithy.api#required": {} } } @@ -4712,7 +5219,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an overview of a NotificationHub.

\n

A NotificationConfiguration is an account-level setting used to select the Regions where you want to store, process and replicate your notifications.

" + "smithy.api#documentation": "

Describes an overview of a NotificationHub.

A NotificationConfiguration is an account-level setting used to select the Regions where you want to store, process and replicate your notifications.

" } }, "com.amazonaws.notifications#NotificationHubStatus": { @@ -4751,7 +5258,7 @@ "status": { "target": "com.amazonaws.notifications#NotificationHubStatus", "traits": { - "smithy.api#documentation": "

Status information about the NotificationHub.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n ACTIVE\n

      \n
        \n
      • \n

        Incoming NotificationEvents are replicated to this\n NotificationHub.

        \n
      • \n
      \n
    • \n
    • \n

      \n REGISTERING\n

      \n
        \n
      • \n

        The NotificationConfiguration is initializing. A NotificationConfiguration with this status can't be deregistered.

        \n
      • \n
      \n
    • \n
    • \n

      \n DEREGISTERING\n

      \n
        \n
      • \n

        The NotificationConfiguration is being deleted. You can't register additional\n NotificationHubs in the same Region as a\n NotificationConfiguration with this status.

        \n
      • \n
      \n
    • \n
    \n
  • \n
", + "smithy.api#documentation": "

Status information about the NotificationHub.

  • Values:

    • ACTIVE

      • Incoming NotificationEvents are replicated to this NotificationHub.

    • REGISTERING

      • The NotificationConfiguration is initializing. A NotificationConfiguration with this status can't be deregistered.

    • DEREGISTERING

      • The NotificationConfiguration is being deleted. You can't register additional NotificationHubs in the same Region as a NotificationConfiguration with this status.

", "smithy.api#required": {} } }, @@ -4803,6 +5310,9 @@ { "target": "com.amazonaws.notifications#ListManagedNotificationChannelAssociations" }, + { + "target": "com.amazonaws.notifications#ListMemberAccounts" + }, { "target": "com.amazonaws.notifications#ListTagsForResource" }, @@ -4846,6 +5356,9 @@ }, { "target": "com.amazonaws.notifications#OrganizationAccess" + }, + { + "target": "com.amazonaws.notifications#OrganizationalUnit" } ], "traits": { @@ -4883,7 +5396,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "

The Amazon Web Services User Notifications API Reference provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions.

\n

User Notification control plane APIs are currently available in US East (Virginia) - us-east-1.

\n

\n GetNotificationEvent\n\t and ListNotificationEvents APIs are currently available in\n\t commercial partition Regions and only return notifications stored in the same Region in which they're called.

\n

The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a \n\t notification hub in addition to US East (Virginia).

", + "smithy.api#documentation": "

The User Notifications API Reference provides descriptions, API request parameters, and the JSON response for each of the User Notifications API actions.

User Notification control plane APIs are currently available in US East (Virginia) - us-east-1.

GetNotificationEvent and ListNotificationEvents APIs are currently available in commercial partition Regions and only return notifications stored in the same Region in which they're called.

The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a notification hub in addition to US East (Virginia).

For information about descriptions, API request parameters, and the JSON response for email contact related API actions, see the User Notifications Contacts API Reference Guide.

", "smithy.api#title": "AWS User Notifications", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -5118,102 +5631,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://notifications-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://notifications.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://notifications-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://notifications.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://notifications-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://notifications.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://notifications-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://notifications.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { @@ -5252,10 +5669,36 @@ "target": "com.amazonaws.notifications#DisableNotificationsAccessForOrganization" } }, + "com.amazonaws.notifications#OrganizationalUnit": { + "type": "resource", + "identifiers": { + "notificationConfigurationArn": { + "target": "com.amazonaws.notifications#NotificationConfigurationArn" + }, + "organizationalUnitId": { + "target": "com.amazonaws.notifications#OrganizationalUnitId" + } + }, + "put": { + "target": "com.amazonaws.notifications#AssociateOrganizationalUnit" + }, + "delete": { + "target": "com.amazonaws.notifications#DisassociateOrganizationalUnit" + }, + "list": { + "target": "com.amazonaws.notifications#ListOrganizationalUnits" + } + }, "com.amazonaws.notifications#OrganizationalUnitId": { "type": "string", "traits": { - "smithy.api#pattern": "^Root|ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$" + "smithy.api#pattern": "^(Root|r-[0-9a-z]{4,32}|ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" + } + }, + "com.amazonaws.notifications#OrganizationalUnits": { + "type": "list", + "member": { + "target": "com.amazonaws.notifications#OrganizationalUnitId" } }, "com.amazonaws.notifications#QuotaCode": { @@ -5315,7 +5758,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to register a NotificationHub" }, - "smithy.api#documentation": "

Registers a NotificationConfiguration in the specified Region.

\n

There is a maximum of one NotificationConfiguration per Region. You can have a\n maximum of 3 NotificationHub resources at a time.

", + "smithy.api#documentation": "

Registers a NotificationConfiguration in the specified Region.

There is a maximum of one NotificationConfiguration per Region. You can have a maximum of 3 NotificationHub resources at a time.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -5352,7 +5795,7 @@ "statusSummary": { "target": "com.amazonaws.notifications#NotificationHubStatusSummary", "traits": { - "smithy.api#documentation": "

Provides additional information about the current NotificationConfiguration\n status information.

", + "smithy.api#documentation": "

Provides additional information about the current NotificationConfiguration status information.

", "smithy.api#required": {} } }, @@ -5380,7 +5823,7 @@ "id": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The unique identifier for the resource.

\n

At least one id or ARN is required.

" + "smithy.api#documentation": "

The unique identifier for the resource.

At least one id or ARN is required.

" } }, "arn": { @@ -5597,7 +6040,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the metadata for a source event.

\n

For more information, see Event structure reference in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

Describes the metadata for a source event.

For more information, see Event structure reference in the Amazon EventBridge User Guide.

" } }, "com.amazonaws.notifications#SourceEventMetadataSummary": { @@ -5606,7 +6049,7 @@ "eventOriginRegion": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Region where the notification originated.

\n

Unavailable for aggregated notifications.

", + "smithy.api#documentation": "

The Region where the notification originated.

Unavailable for aggregated notifications.

", "smithy.api#length": { "max": 32 } @@ -5615,14 +6058,14 @@ "source": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The matched event source.

\n

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", + "smithy.api#documentation": "

The matched event source.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "smithy.api#required": {} } }, "eventType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The event type to match.

\n

Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", + "smithy.api#documentation": "

The event type to match.

Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

", "smithy.api#length": { "min": 1, "max": 256 @@ -5632,7 +6075,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains metadata about the event that caused the NotificationEvent. For\n other specific values, see sourceEventMetadata.

" + "smithy.api#documentation": "

Contains metadata about the event that caused the NotificationEvent. For other specific values, see sourceEventMetadata.

" } }, "com.amazonaws.notifications#StatusSummaryByRegion": { @@ -5769,7 +6212,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to tag a resource" }, - "smithy.api#documentation": "

Tags the resource with a tag key and value.

\n

For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.

\n \n

This is only supported for NotificationConfigurations.

\n
", + "smithy.api#documentation": "

Tags the resource with a tag key and value.

For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.

This is only supported for NotificationConfigurations.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{arn}" @@ -5887,7 +6330,7 @@ "displayText": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A short single line description of the link. Must be hyper-linked with the URL itself.

\n

Used for text parts with the type URL.

", + "smithy.api#documentation": "

A short single line description of the link. Must be hyper-linked with the URL itself.

Used for text parts with the type URL.

", "smithy.api#length": { "min": 1, "max": 1024 @@ -5988,7 +6431,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to remove tags from a resource" }, - "smithy.api#documentation": "

Untags a resource with a specified Amazon Resource Name (ARN).

\n

For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.

", + "smithy.api#documentation": "

Untags a resource with a specified Amazon Resource Name (ARN).

For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{arn}" @@ -6083,7 +6526,7 @@ "eventPattern": { "target": "com.amazonaws.notifications#EventRuleEventPattern", "traits": { - "smithy.api#documentation": "

An additional event pattern used to further filter the events this EventRule receives.

\n

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.\n

" + "smithy.api#documentation": "

An additional event pattern used to further filter the events this EventRule receives.

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

" } }, "regions": { @@ -6194,7 +6637,7 @@ "aggregationDuration": { "target": "com.amazonaws.notifications#AggregationDuration", "traits": { - "smithy.api#documentation": "

The aggregation preference of the NotificationConfiguration.

\n
    \n
  • \n

    Values:

    \n
      \n
    • \n

      \n LONG\n

      \n
        \n
      • \n

        Aggregate notifications for long periods of time (12 hours).

        \n
      • \n
      \n
    • \n
    • \n

      \n SHORT\n

      \n
        \n
      • \n

        Aggregate notifications for short periods of time (5 minutes).

        \n
      • \n
      \n
    • \n
    • \n

      \n NONE\n

      \n
        \n
      • \n

        Don't aggregate notifications.

        \n
      • \n
      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The aggregation preference of the NotificationConfiguration.

  • Values:

    • LONG

      • Aggregate notifications for long periods of time (12 hours).

    • SHORT

      • Aggregate notifications for short periods of time (5 minutes).

    • NONE

      • Don't aggregate notifications.

" } } }, diff --git a/codegen/sdk/aws-models/notificationscontacts.json b/codegen/sdk/aws-models/notificationscontacts.json index dd683fae2e6..a4b7c85214d 100644 --- a/codegen/sdk/aws-models/notificationscontacts.json +++ b/codegen/sdk/aws-models/notificationscontacts.json @@ -1031,166 +1031,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://notifications-contacts-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://notifications-contacts.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://notifications-contacts-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://notifications-contacts.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eu-isoe-west-1" - } - ] - }, - "url": "https://notifications-contacts-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "eu-isoe-west-1" - } - ] - }, - "url": "https://notifications-contacts.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isof-south-1" - } - ] - }, - "url": "https://notifications-contacts-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isof-south-1" - } - ] - }, - "url": "https://notifications-contacts.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { diff --git a/codegen/sdk/aws-models/oam.json b/codegen/sdk/aws-models/oam.json index d711fcb022f..be86aa4fc47 100644 --- a/codegen/sdk/aws-models/oam.json +++ b/codegen/sdk/aws-models/oam.json @@ -2343,17 +2343,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2367,17 +2356,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2391,17 +2369,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2415,17 +2382,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/observabilityadmin.json b/codegen/sdk/aws-models/observabilityadmin.json index 375e8720fc4..ee2c559128a 100644 --- a/codegen/sdk/aws-models/observabilityadmin.json +++ b/codegen/sdk/aws-models/observabilityadmin.json @@ -44,6 +44,179 @@ "smithy.api#uniqueItems": {} } }, + "com.amazonaws.observabilityadmin#CentralizationFailureReason": { + "type": "enum", + "members": { + "TRUSTED_ACCESS_NOT_ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRUSTED_ACCESS_NOT_ENABLED" + } + }, + "DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER_ERROR" + } + } + } + }, + "com.amazonaws.observabilityadmin#CentralizationRule": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.observabilityadmin#CentralizationRuleSource", + "traits": { + "smithy.api#documentation": "

Configuration determining the source of the telemetry data to be centralized.

", + "smithy.api#required": {} + } + }, + "Destination": { + "target": "com.amazonaws.observabilityadmin#CentralizationRuleDestination", + "traits": { + "smithy.api#documentation": "

Configuration determining where the telemetry data should be centralized, backed up, as well as encryption configuration for the primary and backup destinations.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines how telemetry data should be centralized across an Amazon Web Services Organization, including source and destination configurations.

" + } + }, + "com.amazonaws.observabilityadmin#CentralizationRuleDestination": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.observabilityadmin#Region", + "traits": { + "smithy.api#documentation": "

The primary destination region to which telemetry data should be centralized.

", + "smithy.api#required": {} + } + }, + "Account": { + "target": "com.amazonaws.observabilityadmin#AccountIdentifier", + "traits": { + "smithy.api#documentation": "

The destination account (within the organization) to which the telemetry data should be centralized.

" + } + }, + "DestinationLogsConfiguration": { + "target": "com.amazonaws.observabilityadmin#DestinationLogsConfiguration", + "traits": { + "smithy.api#documentation": "

Log specific configuration for centralization destination log groups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration specifying the primary destination for centralized telemetry data.

" + } + }, + "com.amazonaws.observabilityadmin#CentralizationRuleSource": { + "type": "structure", + "members": { + "Regions": { + "target": "com.amazonaws.observabilityadmin#Regions", + "traits": { + "smithy.api#documentation": "

The list of source regions from which telemetry data should be centralized.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.observabilityadmin#SourceFilterString", + "traits": { + "smithy.api#documentation": "

The organizational scope from which telemetry data should be centralized, specified using organization id, accounts or organizational unit ids.

" + } + }, + "SourceLogsConfiguration": { + "target": "com.amazonaws.observabilityadmin#SourceLogsConfiguration", + "traits": { + "smithy.api#documentation": "

Log specific configuration for centralization source log groups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration specifying the source of telemetry data to be centralized.

" + } + }, + "com.amazonaws.observabilityadmin#CentralizationRuleSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.observabilityadmin#CentralizationRuleSummary" + } + }, + "com.amazonaws.observabilityadmin#CentralizationRuleSummary": { + "type": "structure", + "members": { + "RuleName": { + "target": "com.amazonaws.observabilityadmin#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the organization centralization rule.

" + } + }, + "RuleArn": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the organization centralization rule.

" + } + }, + "CreatorAccountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Account that created the organization centralization rule.

" + } + }, + "CreatedTimeStamp": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The timestamp when the organization centralization rule was created.

" + } + }, + "CreatedRegion": { + "target": "com.amazonaws.observabilityadmin#Region", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services region where the organization centralization rule was created.

" + } + }, + "LastUpdateTimeStamp": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The timestamp when the organization centralization rule was last updated.

" + } + }, + "RuleHealth": { + "target": "com.amazonaws.observabilityadmin#RuleHealth", + "traits": { + "smithy.api#documentation": "

The health status of the organization centralization rule.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.observabilityadmin#CentralizationFailureReason", + "traits": { + "smithy.api#documentation": "

The reason why an organization centralization rule is marked UNHEALTHY.

" + } + }, + "DestinationAccountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The primary destination account of the organization centralization rule.

" + } + }, + "DestinationRegion": { + "target": "com.amazonaws.observabilityadmin#Region", + "traits": { + "smithy.api#documentation": "

The primary destination region of the organization centralization rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of a centralization rule's key properties and status.

" + } + }, "com.amazonaws.observabilityadmin#ConflictException": { "type": "structure", "members": { @@ -57,6 +230,84 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.observabilityadmin#CreateCentralizationRuleForOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#CreateCentralizationRuleForOrganizationInput" + }, + "output": { + "target": "com.amazonaws.observabilityadmin#CreateCentralizationRuleForOrganizationOutput" + }, + "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": "

Creates a centralization 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.

", + "smithy.api#http": { + "method": "POST", + "uri": "/CreateCentralizationRuleForOrganization" + } + } + }, + "com.amazonaws.observabilityadmin#CreateCentralizationRuleForOrganizationInput": { + "type": "structure", + "members": { + "RuleName": { + "target": "com.amazonaws.observabilityadmin#RuleName", + "traits": { + "smithy.api#documentation": "

A unique name for the organization-wide centralization rule being created.

", + "smithy.api#required": {} + } + }, + "Rule": { + "target": "com.amazonaws.observabilityadmin#CentralizationRule", + "traits": { + "smithy.api#documentation": "

The configuration details for the organization-wide centralization rule, including the source configuration and the destination configuration to centralize telemetry data across the organization.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.observabilityadmin#TagMapInput", + "traits": { + "smithy.api#documentation": "

The key-value pairs to associate with the organization telemetry rule resource for categorization and management purposes.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#CreateCentralizationRuleForOrganizationOutput": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created organization centralization rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.observabilityadmin#CreateTelemetryRule": { "type": "operation", "input": { @@ -213,6 +464,54 @@ "smithy.api#output": {} } }, + "com.amazonaws.observabilityadmin#DeleteCentralizationRuleForOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#DeleteCentralizationRuleForOrganizationInput" + }, + "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": "

Deletes an organization-wide centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteCentralizationRuleForOrganization" + } + } + }, + "com.amazonaws.observabilityadmin#DeleteCentralizationRuleForOrganizationInput": { + "type": "structure", + "members": { + "RuleIdentifier": { + "target": "com.amazonaws.observabilityadmin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier (name or ARN) of the organization centralization rule to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.observabilityadmin#DeleteTelemetryRule": { "type": "operation", "input": { @@ -309,6 +608,26 @@ "smithy.api#input": {} } }, + "com.amazonaws.observabilityadmin#DestinationLogsConfiguration": { + "type": "structure", + "members": { + "LogsEncryptionConfiguration": { + "target": "com.amazonaws.observabilityadmin#LogsEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The encryption configuration for centralization destination log groups.

" + } + }, + "BackupConfiguration": { + "target": "com.amazonaws.observabilityadmin#LogsBackupConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration defining the backup region and an optional KMS key for the backup destination.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for centralization destination log groups, including encryption and backup settings.

" + } + }, "com.amazonaws.observabilityadmin#DestinationType": { "type": "enum", "members": { @@ -320,9 +639,171 @@ } } }, + "com.amazonaws.observabilityadmin#EncryptedLogGroupStrategy": { + "type": "enum", + "members": { + "ALLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOW" + } + }, + "SKIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIP" + } + } + } + }, + "com.amazonaws.observabilityadmin#EncryptionConflictResolutionStrategy": { + "type": "enum", + "members": { + "ALLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOW" + } + }, + "SKIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIP" + } + } + } + }, + "com.amazonaws.observabilityadmin#EncryptionStrategy": { + "type": "enum", + "members": { + "CUSTOMER_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_MANAGED" + } + }, + "AWS_OWNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_OWNED" + } + } + } + }, "com.amazonaws.observabilityadmin#FailureReason": { "type": "string" }, + "com.amazonaws.observabilityadmin#GetCentralizationRuleForOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#GetCentralizationRuleForOrganizationInput" + }, + "output": { + "target": "com.amazonaws.observabilityadmin#GetCentralizationRuleForOrganizationOutput" + }, + "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": "

Retrieves the details of a specific organization centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/GetCentralizationRuleForOrganization" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.observabilityadmin#GetCentralizationRuleForOrganizationInput": { + "type": "structure", + "members": { + "RuleIdentifier": { + "target": "com.amazonaws.observabilityadmin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier (name or ARN) of the organization centralization rule to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#GetCentralizationRuleForOrganizationOutput": { + "type": "structure", + "members": { + "RuleName": { + "target": "com.amazonaws.observabilityadmin#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the organization centralization rule.

" + } + }, + "RuleArn": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the organization centralization rule.

" + } + }, + "CreatorAccountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Account that created the organization centralization rule.

" + } + }, + "CreatedTimeStamp": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The timestamp when the organization centralization rule was created.

" + } + }, + "CreatedRegion": { + "target": "com.amazonaws.observabilityadmin#Region", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services region where the organization centralization rule was created.

" + } + }, + "LastUpdateTimeStamp": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The timestamp when the organization centralization rule was last updated.

" + } + }, + "RuleHealth": { + "target": "com.amazonaws.observabilityadmin#RuleHealth", + "traits": { + "smithy.api#documentation": "

The health status of the organization centralization rule.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.observabilityadmin#CentralizationFailureReason", + "traits": { + "smithy.api#documentation": "

The reason why an organization centralization rule is marked UNHEALTHY.

" + } + }, + "CentralizationRule": { + "target": "com.amazonaws.observabilityadmin#CentralizationRule", + "traits": { + "smithy.api#documentation": "

The configuration details for the organization centralization rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.observabilityadmin#GetTelemetryEvaluationStatus": { "type": "operation", "input": { @@ -586,62 +1067,165 @@ "smithy.api#input": {} } }, - "com.amazonaws.observabilityadmin#GetTelemetryRuleOutput": { + "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#ListCentralizationRulesForOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganizationInput" + }, + "output": { + "target": "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganizationOutput" + }, + "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": "

Lists all centralization rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListCentralizationRulesForOrganization" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "CentralizationRuleSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganizationInput": { "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", + "RuleNamePrefix": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the telemetry rule.\n

" + "smithy.api#documentation": "

A string to filter organization centralization rules whose names begin with the specified prefix.

", + "smithy.api#length": { + "min": 1, + "max": 100 + } } }, - "CreatedTimeStamp": { - "target": "smithy.api#Long", + "AllRegions": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

\n The timestamp when the telemetry rule was created.\n

" + "smithy.api#documentation": "

A flag determining whether to return organization centralization rules from all regions or only the current region.

" } }, - "LastUpdateTimeStamp": { - "target": "smithy.api#Long", + "MaxResults": { + "target": "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganizationMaxResults", "traits": { - "smithy.api#documentation": "

\n The timestamp when the telemetry rule was last updated.\n

" + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of organization centralization rules to return in a single call.

" } }, - "TelemetryRule": { - "target": "com.amazonaws.observabilityadmin#TelemetryRule", + "NextToken": { + "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { - "smithy.api#documentation": "

\n The configuration details of the telemetry rule.\n

" + "smithy.api#documentation": "

The token for the next set of results. A previous call generates this token.

" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#input": {} } }, - "com.amazonaws.observabilityadmin#InternalServerException": { + "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganizationMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganizationOutput": { "type": "structure", "members": { - "Message": { - "target": "smithy.api#String" + "CentralizationRuleSummaries": { + "target": "com.amazonaws.observabilityadmin#CentralizationRuleSummaries", + "traits": { + "smithy.api#documentation": "

A list of centralization rule summaries.

" + } }, - "amznErrorType": { - "target": "smithy.api#String", + "NextToken": { + "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { - "smithy.api#documentation": "

\n The name of the exception.\n

", - "smithy.api#httpHeader": "x-amzn-ErrorType" + "smithy.api#documentation": "

A token to resume pagination of results.

" } } }, "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 + "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#ListResourceTelemetry": { @@ -902,7 +1486,8 @@ "smithy.api#http": { "method": "POST", "uri": "/ListTagsForResource" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#ListTagsForResourceInput": { @@ -1133,6 +1718,63 @@ "smithy.api#output": {} } }, + "com.amazonaws.observabilityadmin#LogsBackupConfiguration": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.observabilityadmin#Region", + "traits": { + "smithy.api#documentation": "

Logs specific backup destination region within the primary destination account to which log data should be centralized.

", + "smithy.api#required": {} + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

KMS Key arn belonging to the primary destination account and backup region, to encrypt newly created central log groups in the backup destination.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for backing up centralized log data to a secondary region.

" + } + }, + "com.amazonaws.observabilityadmin#LogsEncryptionConfiguration": { + "type": "structure", + "members": { + "EncryptionStrategy": { + "target": "com.amazonaws.observabilityadmin#EncryptionStrategy", + "traits": { + "smithy.api#documentation": "

Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.

", + "smithy.api#required": {} + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

KMS Key arn belonging to the primary destination account and region, to encrypt newly created central log groups in the primary destination.

" + } + }, + "EncryptionConflictResolutionStrategy": { + "target": "com.amazonaws.observabilityadmin#EncryptionConflictResolutionStrategy", + "traits": { + "smithy.api#documentation": "

Conflict resolution strategy for centralization if the encryption strategy is set to CUSTOMER_MANAGED and the destination log group is encrypted with an AWS_OWNED KMS Key. ALLOW lets centralization go through while SKIP prevents centralization into the destination log group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for encrypting centralized log groups. This configuration is only applied to destination log groups for which the corresponding source log groups are encrypted using Customer Managed KMS Keys.

" + } + }, + "com.amazonaws.observabilityadmin#LogsFilterString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, "com.amazonaws.observabilityadmin#NextToken": { "type": "string" }, @@ -1140,18 +1782,27 @@ "type": "service", "version": "2018-05-10", "operations": [ + { + "target": "com.amazonaws.observabilityadmin#CreateCentralizationRuleForOrganization" + }, { "target": "com.amazonaws.observabilityadmin#CreateTelemetryRule" }, { "target": "com.amazonaws.observabilityadmin#CreateTelemetryRuleForOrganization" }, + { + "target": "com.amazonaws.observabilityadmin#DeleteCentralizationRuleForOrganization" + }, { "target": "com.amazonaws.observabilityadmin#DeleteTelemetryRule" }, { "target": "com.amazonaws.observabilityadmin#DeleteTelemetryRuleForOrganization" }, + { + "target": "com.amazonaws.observabilityadmin#GetCentralizationRuleForOrganization" + }, { "target": "com.amazonaws.observabilityadmin#GetTelemetryEvaluationStatus" }, @@ -1164,6 +1815,9 @@ { "target": "com.amazonaws.observabilityadmin#GetTelemetryRuleForOrganization" }, + { + "target": "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganization" + }, { "target": "com.amazonaws.observabilityadmin#ListResourceTelemetry" }, @@ -1197,6 +1851,9 @@ { "target": "com.amazonaws.observabilityadmin#UntagResource" }, + { + "target": "com.amazonaws.observabilityadmin#UpdateCentralizationRuleForOrganization" + }, { "target": "com.amazonaws.observabilityadmin#UpdateTelemetryRule" }, @@ -1723,17 +2380,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1747,17 +2393,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1771,17 +2406,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1795,17 +2419,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1899,6 +2512,26 @@ "smithy.api#uniqueItems": {} } }, + "com.amazonaws.observabilityadmin#Region": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.observabilityadmin#Regions": { + "type": "list", + "member": { + "target": "com.amazonaws.observabilityadmin#Region" + }, + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.observabilityadmin#ResourceArn": { "type": "string", "traits": { @@ -1906,7 +2539,7 @@ "min": 1, "max": 1011 }, - "smithy.api#pattern": "^arn:aws:([a-zA-Z0-9\\-]+):([a-z0-9\\-]+)?:([0-9]{12})?:(.+)$" + "smithy.api#pattern": "^arn:aws([a-z0-9\\-]+)?:([a-zA-Z0-9\\-]+):([a-z0-9\\-]+)?:([0-9]{12})?:(.+)$" } }, "com.amazonaws.observabilityadmin#ResourceIdentifier": { @@ -1979,6 +2612,29 @@ } } }, + "com.amazonaws.observabilityadmin#RuleHealth": { + "type": "enum", + "members": { + "HEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Healthy" + } + }, + "UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unhealthy" + } + }, + "PROVISIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Provisioning" + } + } + } + }, "com.amazonaws.observabilityadmin#RuleIdentifier": { "type": "string", "traits": { @@ -1995,7 +2651,7 @@ "min": 1, "max": 100 }, - "smithy.api#pattern": "^[0-9A-Za-z-]+$" + "smithy.api#pattern": "^[0-9A-Za-z-_.#/]+$" } }, "com.amazonaws.observabilityadmin#ServiceQuotaExceededException": { @@ -2018,6 +2674,37 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.observabilityadmin#SourceFilterString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, + "com.amazonaws.observabilityadmin#SourceLogsConfiguration": { + "type": "structure", + "members": { + "LogGroupSelectionCriteria": { + "target": "com.amazonaws.observabilityadmin#LogsFilterString", + "traits": { + "smithy.api#documentation": "

The selection criteria that specifies which source log groups to centralize. The selection criteria uses the same format as OAM link filters.

", + "smithy.api#required": {} + } + }, + "EncryptedLogGroupStrategy": { + "target": "com.amazonaws.observabilityadmin#EncryptedLogGroupStrategy", + "traits": { + "smithy.api#documentation": "

A strategy determining whether to centralize source log groups that are encrypted with customer managed KMS keys (CMK). ALLOW will consider CMK encrypted source log groups for centralization while SKIP will skip CMK encrypted source log groups from centralization.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for selecting and handling source log groups for centralization.

" + } + }, "com.amazonaws.observabilityadmin#StartTelemetryEvaluation": { "type": "operation", "input": { @@ -2595,6 +3282,78 @@ "smithy.api#input": {} } }, + "com.amazonaws.observabilityadmin#UpdateCentralizationRuleForOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#UpdateCentralizationRuleForOrganizationInput" + }, + "output": { + "target": "com.amazonaws.observabilityadmin#UpdateCentralizationRuleForOrganizationOutput" + }, + "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": "

Updates an existing centralization 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.

", + "smithy.api#http": { + "method": "POST", + "uri": "/UpdateCentralizationRuleForOrganization" + } + } + }, + "com.amazonaws.observabilityadmin#UpdateCentralizationRuleForOrganizationInput": { + "type": "structure", + "members": { + "RuleIdentifier": { + "target": "com.amazonaws.observabilityadmin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier (name or ARN) of the organization centralization rule to update.

", + "smithy.api#required": {} + } + }, + "Rule": { + "target": "com.amazonaws.observabilityadmin#CentralizationRule", + "traits": { + "smithy.api#documentation": "

The configuration details for the organization-wide centralization rule, including the source configuration and the destination configuration to centralize telemetry data across the organization.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#UpdateCentralizationRuleForOrganizationOutput": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated organization centralization rule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.observabilityadmin#UpdateTelemetryRule": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/odb.json b/codegen/sdk/aws-models/odb.json index c9e66ff1403..ba6b5a176f5 100644 --- a/codegen/sdk/aws-models/odb.json +++ b/codegen/sdk/aws-models/odb.json @@ -7301,17 +7301,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -7325,17 +7314,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -7349,17 +7327,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -7373,17 +7340,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/omics.json b/codegen/sdk/aws-models/omics.json index 9a948c1e9b7..f5f5a608077 100644 --- a/codegen/sdk/aws-models/omics.json +++ b/codegen/sdk/aws-models/omics.json @@ -37,7 +37,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to abort multipart read set uploads", - "smithy.api#documentation": "

Stops a multipart upload.

", + "smithy.api#documentation": "

Stops a multipart read set upload into a sequence store and returns a response with no body if the operation is successful. To confirm that a multipart read set upload has been stopped, use the ListMultipartReadSetUploads API operation to view all active multipart read set uploads.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -841,7 +841,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to batch delete Read Sets in the given Sequence Store", - "smithy.api#documentation": "

Deletes one or more read sets.

", + "smithy.api#documentation": "

Deletes one or more read sets. If the operation is successful, it returns a response with no body. If there is an error with deleting one of the read sets, the operation returns an error list. If the operation successfully deletes only a subset of files, it will return an error list for the remaining files that fail to be deleted. There is a limit of 100 read sets that can be deleted in each BatchDeleteReadSet API call.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -1147,7 +1147,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to complete a multipart read set upload", - "smithy.api#documentation": "

Concludes a multipart upload once you have uploaded all the components.

", + "smithy.api#documentation": "

Completes a multipart read set upload into a sequence store after you have initiated the upload process with CreateMultipartReadSetUpload and uploaded all read set parts using UploadReadSetPart. You must specify the parts you uploaded using the parts parameter. If the operation is successful, it returns the read set ID(s) of the uploaded read set(s).

For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "storage-" }, @@ -1279,6 +1279,26 @@ "smithy.api#pattern": "^arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+$" } }, + "com.amazonaws.omics#ContainerRegistryMap": { + "type": "structure", + "members": { + "registryMappings": { + "target": "com.amazonaws.omics#RegistryMappingsList", + "traits": { + "smithy.api#documentation": "

Mapping that provides the ECR repository path where upstream container images are pulled and synchronized.

" + } + }, + "imageMappings": { + "target": "com.amazonaws.omics#ImageMappingsList", + "traits": { + "smithy.api#documentation": "

Image mappings specify path mappings between the ECR private repository and their corresponding external repositories.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. For more information, see Container images in the Amazon Web Services HealthOmics User Guide.

" + } + }, "com.amazonaws.omics#CreateAnnotationStore": { "type": "operation", "input": { @@ -1619,7 +1639,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a multipart read set upload", - "smithy.api#documentation": "

Begins a multipart read set upload.

", + "smithy.api#documentation": "

Initiates a multipart read set upload for uploading partitioned source files into a sequence store. You can directly import source files from an EC2 instance and other local compute, or from an S3 bucket. To separate these source files into parts, use the split operation. Each part cannot be larger than 100 MB. If the operation is successful, it provides an uploadId which is required by the UploadReadSetPart API operation to upload parts into a sequence store.

To continue uploading a multipart read set into your sequence store, you must use the UploadReadSetPart API operation to upload each part individually following the steps below:

  • Specify the uploadId obtained from the previous call to CreateMultipartReadSetUpload.

  • Upload parts for that uploadId.

When you have finished uploading parts, use the CompleteMultipartReadSetUpload API to complete the multipart read set upload and to retrieve the final read set IDs in the response.

To learn more about creating parts and the split operation, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -1819,7 +1839,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "

Creates a reference store.

", + "smithy.api#documentation": "

Creates a reference store and returns metadata in JSON format. Reference stores are used to store reference genomes in FASTA format. A reference store is created when the first reference genome is imported. To import additional reference genomes from an Amazon S3 bucket, use the StartReferenceImportJob API operation.

For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -2221,7 +2241,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "

Creates a sequence store.

", + "smithy.api#documentation": "

Creates a sequence store and returns its metadata. Sequence stores are used to store sequence data files called read sets that are saved in FASTQ, BAM, uBAM, or CRAM formats. For aligned formats (BAM and CRAM), a sequence store can only use one reference genome. For unaligned formats (FASTQ and uBAM), a reference genome is not required. You can create multiple sequence stores per region per account.

The following are optional parameters you can specify for your sequence store:

  • Use s3AccessConfig to configure your sequence store with S3 access logs (recommended).

  • Use sseConfig to define your own KMS key for encryption.

  • Use eTagAlgorithmFamily to define which algorithm to use for the HealthOmics eTag on objects.

  • Use fallbackLocation to define a backup location for storing files that have failed a direct upload.

  • Use propagatedSetLevelTags to configure tags that propagate to all objects in your store.

For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -2256,38 +2276,38 @@ "tags": { "target": "com.amazonaws.omics#TagMap", "traits": { - "smithy.api#documentation": "

Tags for the store.

" + "smithy.api#documentation": "

Tags for the store. You can configure up to 50 tags.

" } }, "clientToken": { "target": "com.amazonaws.omics#ClientToken", "traits": { - "smithy.api#documentation": "

To ensure that requests don't run multiple times, specify a unique token for each request.

", + "smithy.api#documentation": "

An idempotency token used to dedupe retry requests so that duplicate runs are not created.

", "smithy.api#idempotencyToken": {} } }, "fallbackLocation": { "target": "com.amazonaws.omics#FallbackLocation", "traits": { - "smithy.api#documentation": "

An S3 location that is used to store files that have failed a direct upload.

" + "smithy.api#documentation": "

An S3 location that is used to store files that have failed a direct upload. You can add or change the fallbackLocation after creating a sequence store. This is not required if you are uploading files from a different S3 bucket.

" } }, "eTagAlgorithmFamily": { "target": "com.amazonaws.omics#ETagAlgorithmFamily", "traits": { - "smithy.api#documentation": "

The ETag algorithm family to use for ingested read sets.

" + "smithy.api#documentation": "

The ETag algorithm family to use for ingested read sets. The default value is MD5up. For more information on ETags, see ETags and data provenance in the Amazon Web Services HealthOmics User Guide.

" } }, "propagatedSetLevelTags": { "target": "com.amazonaws.omics#PropagatedSetLevelTags", "traits": { - "smithy.api#documentation": "

The tags keys to propagate to the S3 objects associated with read sets in the sequence store.

" + "smithy.api#documentation": "

The tags keys to propagate to the S3 objects associated with read sets in the sequence store. These tags can be used as input to add metadata to your read sets.

" } }, "s3AccessConfig": { "target": "com.amazonaws.omics#S3AccessConfig", "traits": { - "smithy.api#documentation": "

S3 access configuration parameters

" + "smithy.api#documentation": "

S3 access configuration parameters. This specifies the parameters needed to access logs stored in S3 buckets. The S3 bucket must be in the same region and account as the sequence store.

" } } }, @@ -2327,7 +2347,7 @@ "sseConfig": { "target": "com.amazonaws.omics#SseConfig", "traits": { - "smithy.api#documentation": "

The store's SSE settings.

" + "smithy.api#documentation": "

Server-side encryption (SSE) settings for the store. This contains the KMS key ARN that is used to encrypt read set objects.

" } }, "creationTime": { @@ -2635,7 +2655,7 @@ } ], "traits": { - "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#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 container images for the workflow in a private ECR repository, or synchronize images from a supported upstream registry with your Amazon ECR private 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-" }, @@ -2728,6 +2748,18 @@ "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.

" } }, + "containerRegistryMap": { + "target": "com.amazonaws.omics#ContainerRegistryMap", + "traits": { + "smithy.api#documentation": "

(Optional) Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. For more information, see Container images in the Amazon Web Services HealthOmics User Guide.

" + } + }, + "containerRegistryMapUri": { + "target": "com.amazonaws.omics#Uri", + "traits": { + "smithy.api#documentation": "

(Optional) URI of the S3 location for the registry mapping file.

" + } + }, "readmeMarkdown": { "target": "com.amazonaws.omics#ReadmeMarkdown", "traits": { @@ -2842,7 +2874,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-" }, @@ -2860,7 +2892,7 @@ "workflowId": { "target": "com.amazonaws.omics#WorkflowId", "traits": { - "smithy.api#documentation": "

The ID of the workflow where you are creating the new version.

", + "smithy.api#documentation": "

The ID of the workflow where you are creating the new version. The workflowId is not the UUID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "id" @@ -2877,13 +2909,13 @@ "target": "smithy.api#Blob", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

A zip archive containing the workflow definition for this workflow version.

" + "smithy.api#documentation": "

A ZIP archive containing the main workflow definition file and dependencies that it imports for this workflow version. 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 specifies the location of the workflow definition for this workflow version.

" + "smithy.api#documentation": "

The S3 URI of a definition for this workflow version. The S3 bucket must be in the same region as this workflow version.

" } }, "accelerators": { @@ -2901,25 +2933,25 @@ "engine": { "target": "com.amazonaws.omics#WorkflowEngine", "traits": { - "smithy.api#documentation": "

The workflow engine for this workflow version.

" + "smithy.api#documentation": "

The workflow engine for this workflow version. 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.

" } }, "main": { "target": "com.amazonaws.omics#WorkflowMain", "traits": { - "smithy.api#documentation": "

The path of the main definition file for this workflow version.

" + "smithy.api#documentation": "

The path of the main definition file for this workflow version. 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": "

The parameter template defines the input parameters for runs that use this workflow version.

" + "smithy.api#documentation": "

A parameter template for this workflow version. 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.

" } }, "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": {} } @@ -2927,13 +2959,13 @@ "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 version. 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.

" } }, "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 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 @@ -2943,7 +2975,7 @@ "tags": { "target": "com.amazonaws.omics#TagMap", "traits": { - "smithy.api#documentation": "

Optional tags to associate with this workflow version.

" + "smithy.api#documentation": "

Tags for this workflow version. 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.

" } }, "workflowBucketOwnerId": { @@ -2952,6 +2984,18 @@ "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.

" } }, + "containerRegistryMap": { + "target": "com.amazonaws.omics#ContainerRegistryMap", + "traits": { + "smithy.api#documentation": "

(Optional) Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. For more information, see Container images in the Amazon Web Services HealthOmics User Guide.

" + } + }, + "containerRegistryMapUri": { + "target": "com.amazonaws.omics#Uri", + "traits": { + "smithy.api#documentation": "

(Optional) URI of the S3 location for the registry mapping file.

" + } + }, "readmeMarkdown": { "target": "com.amazonaws.omics#ReadmeMarkdown", "traits": { @@ -3336,7 +3380,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to delete a Reference in the given Reference Store", - "smithy.api#documentation": "

Deletes a genome reference.

", + "smithy.api#documentation": "

Deletes a reference genome and returns a response with no body if the operation is successful. The read set associated with the reference genome must first be deleted before deleting the reference genome. After the reference genome is deleted, you can delete the reference store using the DeleteReferenceStore API operation.

For more information, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -3412,7 +3456,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to delete a Reference Store", - "smithy.api#documentation": "

Deletes a genome reference store.

", + "smithy.api#documentation": "

Deletes a reference store and returns a response with no body if the operation is successful. You can only delete a reference store when it does not contain any reference genomes. To empty a reference store, use DeleteReference.

For more information about your workflow status, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -3738,7 +3782,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to delete a Sequence Store", - "smithy.api#documentation": "

Deletes a sequence store.

", + "smithy.api#documentation": "

Deletes a sequence store and returns a response with no body if the operation is successful. You can only delete a sequence store when it does not contain any read sets.

Use the BatchDeleteReadSet API operation to ensure that all read sets in the sequence store are deleted. When a sequence store is deleted, all tags associated with the store are also deleted.

For more information, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -3965,7 +4009,7 @@ } ], "traits": { - "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#documentation": "

Deletes a workflow by specifying its ID. This operation returns a response with no body 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-" }, @@ -4162,6 +4206,16 @@ ] } }, + "com.amazonaws.omics#EcrRepositoryPrefix": { + "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#Encoding": { "type": "string", "traits": { @@ -5293,7 +5347,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get a Read Set in the given Sequence Store", - "smithy.api#documentation": "

Gets a file from a read set.

", + "smithy.api#documentation": "

Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded. You must have read sets uploaded to your sequence store in order to run this operation.

", "smithy.api#endpoint": { "hostPrefix": "storage-" }, @@ -5334,7 +5388,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get details about a Read Set activation job for the given Sequence Store", - "smithy.api#documentation": "

Gets information about a read set activation job.

", + "smithy.api#documentation": "

Returns detailed information about the status of a read set activation job in JSON format.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -5534,7 +5588,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get details about a Read Set export job for the given Sequence Store", - "smithy.api#documentation": "

Gets information about a read set export job.

", + "smithy.api#documentation": "

Retrieves status information about a read set export job and returns the data in JSON format. Use this operation to actively monitor the progress of an export job.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -5741,7 +5795,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get details about a Read Set import job for the given Sequence Store", - "smithy.api#documentation": "

Gets information about a read set import job.

", + "smithy.api#documentation": "

Gets detailed and status information about a read set import job and returns the data in JSON format.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -5949,7 +6003,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get details about a Read Set in the given Sequence Store", - "smithy.api#documentation": "

Gets details about a read set.

", + "smithy.api#documentation": "

Retrieves the metadata for a read set from a sequence store in JSON format. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource API operation.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -6195,7 +6249,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get a Reference in the given Reference Store", - "smithy.api#documentation": "

Gets a reference file.

", + "smithy.api#documentation": "

Downloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded.

For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "storage-" }, @@ -6236,7 +6290,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get details about a Reference import job for the given Reference Store", - "smithy.api#documentation": "

Gets information about a reference import job.

", + "smithy.api#documentation": "

Monitors the status of a reference import job. This operation can be called after calling the StartReferenceImportJob operation.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -6444,7 +6498,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get details about a Reference in the given Reference Store", - "smithy.api#documentation": "

Gets information about a genome reference's metadata.

", + "smithy.api#documentation": "

Retrieves metadata for a reference genome. This operation returns the number of parts, part size, and MD5 of an entire file. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource API operation.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -7739,6 +7793,12 @@ "traits": { "smithy.api#documentation": "

The reason a task has failed.

" } + }, + "imageDetails": { + "target": "com.amazonaws.omics#ImageDetails", + "traits": { + "smithy.api#documentation": "

Details about the container image that this task uses.

" + } } }, "traits": { @@ -7880,7 +7940,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get details about a Sequence Store", - "smithy.api#documentation": "

Gets information about a sequence store.

", + "smithy.api#documentation": "

Retrieves metadata for a sequence store using its ID and returns it in JSON format.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -8758,6 +8818,12 @@ "smithy.api#documentation": "

The universally unique identifier (UUID) value for this workflow.

" } }, + "containerRegistryMap": { + "target": "com.amazonaws.omics#ContainerRegistryMap", + "traits": { + "smithy.api#documentation": "

The registry map that this workflow is using.

" + } + }, "readme": { "target": "com.amazonaws.omics#ReadmeS3PresignedUrl", "traits": { @@ -8884,7 +8950,7 @@ "workflowId": { "target": "com.amazonaws.omics#WorkflowId", "traits": { - "smithy.api#documentation": "

The workflow's ID.

", + "smithy.api#documentation": "

The workflow's ID. The workflowId is not the UUID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "id" @@ -8915,7 +8981,7 @@ "workflowOwnerId": { "target": "com.amazonaws.omics#WorkflowOwnerId", "traits": { - "smithy.api#documentation": "

Amazon Web Services Id of the owner of the workflow.

", + "smithy.api#documentation": "

The 12-digit account ID of the workflow owner. 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.

", "smithy.api#httpQuery": "workflowOwnerId" } } @@ -9054,6 +9120,12 @@ "smithy.api#documentation": "

Amazon Web Services Id of the owner of the bucket.

" } }, + "containerRegistryMap": { + "target": "com.amazonaws.omics#ContainerRegistryMap", + "traits": { + "smithy.api#documentation": "

The registry map that this workflow version uses.

" + } + }, "readme": { "target": "com.amazonaws.omics#ReadmeS3PresignedUrl", "traits": { @@ -9090,6 +9162,58 @@ "target": "com.amazonaws.omics#ResourceIdentifier" } }, + "com.amazonaws.omics#ImageDetails": { + "type": "structure", + "members": { + "image": { + "target": "com.amazonaws.omics#Uri", + "traits": { + "smithy.api#documentation": "

The URI of the container image.

" + } + }, + "imageDigest": { + "target": "com.amazonaws.omics#TaskImageDigest", + "traits": { + "smithy.api#documentation": "

The container image digest. If the image URI was transformed, this will be the digest of the container image referenced by the transformed URI.

" + } + }, + "sourceImage": { + "target": "com.amazonaws.omics#Uri", + "traits": { + "smithy.api#documentation": "

URI of the source registry. If the URI is from a third-party registry, Amazon Web Services HealthOmics transforms the URI to the corresponding ECR path, using the pull-through cache mapping rules.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the container image used for a task.

" + } + }, + "com.amazonaws.omics#ImageMapping": { + "type": "structure", + "members": { + "sourceImage": { + "target": "com.amazonaws.omics#Uri", + "traits": { + "smithy.api#documentation": "

Specifies the URI of the source image in the upstream registry.

" + } + }, + "destinationImage": { + "target": "com.amazonaws.omics#Uri", + "traits": { + "smithy.api#documentation": "

Specifies the URI of the corresponding image in the private ECR registry.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies image mappings that workflow tasks can use. For example, you can replace all the task references of a public image to use an equivalent image in your private ECR repository. You can use image mappings with upstream registries that don't support pull through cache. You need to manually synchronize the upstream registry with your private repository.

" + } + }, + "com.amazonaws.omics#ImageMappingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#ImageMapping" + } + }, "com.amazonaws.omics#ImportJobId": { "type": "string", "traits": { @@ -9909,7 +10033,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list multipart read set uploads", - "smithy.api#documentation": "

Lists multipart read set uploads and for in progress uploads. Once the upload is completed, a read set is created and the upload will no longer be returned in the response.

", + "smithy.api#documentation": "

Lists in-progress multipart read set uploads for a sequence store and returns it in a JSON formatted output. Multipart read set uploads are initiated by the CreateMultipartReadSetUploads API operation. This operation returns a response with no body when the upload is complete.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -10010,7 +10134,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list Read Set activation jobs for the given Sequence Store", - "smithy.api#documentation": "

Retrieves a list of read set activation jobs.

", + "smithy.api#documentation": "

Retrieves a list of read set activation jobs and returns the metadata in a JSON formatted output. To extract metadata from a read set activation job, use the GetReadSetActivationJob API operation.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -10117,7 +10241,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list Read Set export jobs for the given Sequence Store", - "smithy.api#documentation": "

Retrieves a list of read set export jobs.

", + "smithy.api#documentation": "

Retrieves a list of read set export jobs in a JSON formatted response. This API operation is used to check the status of a read set export job initiated by the StartReadSetExportJob API operation.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -10224,7 +10348,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list Read Set import jobs for the given Sequence Store", - "smithy.api#documentation": "

Retrieves a list of read set import jobs.

", + "smithy.api#documentation": "

Retrieves a list of read set import jobs and returns the data in JSON format.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -10337,7 +10461,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list read set upload parts", - "smithy.api#documentation": "

This operation will list all parts in a requested multipart upload for a sequence store.

", + "smithy.api#documentation": "

Lists all parts in a multipart read set upload for a sequence store and returns the metadata in a JSON formatted output.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -10459,7 +10583,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list Read Sets in the given Sequence Store", - "smithy.api#documentation": "

Retrieves a list of read sets.

", + "smithy.api#documentation": "

Retrieves a list of read sets from a sequence store ID and returns the metadata in JSON format.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -10567,7 +10691,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list Reference import jobs for the given Reference Store", - "smithy.api#documentation": "

Retrieves a list of reference import jobs.

", + "smithy.api#documentation": "

Retrieves the metadata of one or more reference import jobs for a reference store.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -10671,7 +10795,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list Reference Stores", - "smithy.api#documentation": "

Retrieves a list of reference stores.

", + "smithy.api#documentation": "

Retrieves a list of reference stores linked to your account and returns their metadata in JSON format.

For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -10771,7 +10895,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list References in the given Reference Store", - "smithy.api#documentation": "

Retrieves a list of references.

", + "smithy.api#documentation": "

Retrieves the metadata of one or more reference genomes in a reference store.

For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -11315,7 +11439,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list Sequence Stores", - "smithy.api#documentation": "

Retrieves a list of sequence stores.

", + "smithy.api#documentation": "

Retrieves a list of sequence stores and returns each sequence store's metadata.

For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -11895,7 +12019,7 @@ "workflowId": { "target": "com.amazonaws.omics#WorkflowId", "traits": { - "smithy.api#documentation": "

The workflow's ID.

", + "smithy.api#documentation": "

The workflow's ID. The workflowId is not the UUID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "id" @@ -11911,7 +12035,7 @@ "workflowOwnerId": { "target": "com.amazonaws.omics#WorkflowOwnerId", "traits": { - "smithy.api#documentation": "

Amazon Web Services Id of the owner of the workflow.

", + "smithy.api#documentation": "

The 12-digit account ID of the workflow owner. 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.

", "smithy.api#httpQuery": "workflowOwnerId" } }, @@ -12804,17 +12928,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -12828,17 +12941,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -12852,17 +12954,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -12876,17 +12967,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -14423,6 +14503,44 @@ "smithy.api#streaming": {} } }, + "com.amazonaws.omics#RegistryMapping": { + "type": "structure", + "members": { + "upstreamRegistryUrl": { + "target": "com.amazonaws.omics#Uri", + "traits": { + "smithy.api#documentation": "

The URI of the upstream registry.

" + } + }, + "ecrRepositoryPrefix": { + "target": "com.amazonaws.omics#EcrRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The repository prefix to use in the ECR private repository.

" + } + }, + "upstreamRepositoryPrefix": { + "target": "com.amazonaws.omics#UpstreamRepositoryPrefix", + "traits": { + "smithy.api#documentation": "

The repository prefix of the corresponding repository in the upstream registry.

" + } + }, + "ecrAccountId": { + "target": "com.amazonaws.omics#AwsAccountId", + "traits": { + "smithy.api#documentation": "

Account ID of the account that owns the upstream container image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

If you are using the ECR pull through cache feature, the registry mapping maps between the ECR repository and the upstream registry where container images are pulled and synchronized.

" + } + }, + "com.amazonaws.omics#RegistryMappingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#RegistryMapping" + } + }, "com.amazonaws.omics#RequestTimeoutException": { "type": "structure", "members": { @@ -16162,7 +16280,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to start a Read Set activation job from the given Sequence Store", - "smithy.api#documentation": "

Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read sets after 30 days.

", + "smithy.api#documentation": "

Activates an archived read set and returns its metadata in a JSON formatted output. AWS HealthOmics automatically archives unused read sets after 30 days. To monitor the status of your read set activation job, use the GetReadSetActivationJob operation.

To learn more, see Activating read sets in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -16296,7 +16414,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to start a Read Set export job from the given Sequence Store", - "smithy.api#documentation": "

Exports a read set to Amazon S3.

", + "smithy.api#documentation": "

Starts a read set export job. When the export job is finished, the read set is exported to an Amazon S3 bucket which can be retrieved using the GetReadSetExportJob API operation.

To monitor the status of the export job, use the ListReadSetExportJobs API operation.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -16430,7 +16548,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to start a Read Set import job into the given Sequence Store", - "smithy.api#documentation": "

Starts a read set import job.

", + "smithy.api#documentation": "

Imports a read set from the sequence store. Read set import jobs support a maximum of 100 read sets of different types. Monitor the progress of your read set import job by calling the GetReadSetImportJob API operation.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -16629,7 +16747,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to start a Reference import job into the given Reference Store", - "smithy.api#documentation": "

Starts a reference import job.

", + "smithy.api#documentation": "

Imports a reference genome from Amazon S3 into a specified reference store. You can have multiple reference genomes in a reference store. You can only import reference genomes one at a time into each reference store. Monitor the status of your reference import job by using the GetReferenceImportJob API operation.

", "smithy.api#endpoint": { "hostPrefix": "control-storage-" }, @@ -16890,7 +17008,8 @@ "outputUri": { "target": "com.amazonaws.omics#RunOutputUri", "traits": { - "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.

" + "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.

", + "smithy.api#required": {} } }, "logLevel": { @@ -17413,6 +17532,16 @@ "smithy.api#pattern": "^[0-9]+$" } }, + "com.amazonaws.omics#TaskImageDigest": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^sha[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" + } + }, "com.amazonaws.omics#TaskInstanceType": { "type": "string", "traits": { @@ -18698,7 +18827,7 @@ "workflowId": { "target": "com.amazonaws.omics#WorkflowId", "traits": { - "smithy.api#documentation": "

The workflow's ID.

", + "smithy.api#documentation": "

The workflow's ID. The workflowId is not the UUID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "id" @@ -18721,13 +18850,13 @@ "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 version. 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 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 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 @@ -18792,7 +18921,7 @@ "traits": { "aws.auth#unsignedPayload": {}, "aws.iam#actionPermissionDescription": "Grants permission to upload read set parts", - "smithy.api#documentation": "

This operation uploads a specific part of a read set. If you upload a new part using a previously used part number, the previously uploaded part will be overwritten.

", + "smithy.api#documentation": "

Uploads a specific part of a read set into a sequence store. When you a upload a read set part with a part number that already exists, the new part replaces the existing one. This operation returns a JSON formatted response containing a string identifier that is used to confirm that parts are being added to the intended upload.

For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "storage-" }, @@ -18869,6 +18998,26 @@ "smithy.api#output": {} } }, + "com.amazonaws.omics#UpstreamRepositoryPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 30 + }, + "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" + } + }, + "com.amazonaws.omics#Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 750 + }, + "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" + } + }, "com.amazonaws.omics#UserCustomDescription": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/opensearch.json b/codegen/sdk/aws-models/opensearch.json index bca4a29825a..81e0f08b757 100644 --- a/codegen/sdk/aws-models/opensearch.json +++ b/codegen/sdk/aws-models/opensearch.json @@ -1917,17 +1917,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1941,17 +1930,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1965,17 +1943,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1989,17 +1956,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/opensearchserverless.json b/codegen/sdk/aws-models/opensearchserverless.json index 25cd8a5c8e3..6b70f43c3cd 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\n data.

" + "smithy.api#documentation": "

The type of access policy. Currently, the only available type is data.

" } }, "name": { @@ -195,7 +195,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns attributes for one or more collections, including the collection endpoint and\n the OpenSearch Dashboards endpoint. For more information, see Creating and\n managing Amazon OpenSearch Serverless collections.

", + "smithy.api#documentation": "

Returns attributes for one or more collections, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

", "smithy.api#readonly": {} } }, @@ -205,13 +205,13 @@ "ids": { "target": "com.amazonaws.opensearchserverless#CollectionIds", "traits": { - "smithy.api#documentation": "

A list of collection IDs. You can't provide names and IDs in the same request. The ID\n is part of the collection endpoint. You can also retrieve it using the ListCollections API.

" + "smithy.api#documentation": "

A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

" } }, "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\n request.

" + "smithy.api#documentation": "

A list of collection names. You can't provide names and IDs in the same request.

" } } } @@ -250,7 +250,7 @@ } ], "traits": { - "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#documentation": "

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more 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\n Viewing data lifecycle policies.

", + "smithy.api#documentation": "

Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see 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 Access\n Amazon OpenSearch Serverless using an interface endpoint.

", + "smithy.api#documentation": "

Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

", "smithy.api#readonly": {} } }, @@ -412,7 +412,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units\n (OCUs). These limits are used to scale your collections based on the current workload.\n For more information, see Managing\n capacity limits for Amazon OpenSearch Serverless.

" + "smithy.api#documentation": "

The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.

" } }, "com.amazonaws.opensearchserverless#ClientToken": { @@ -518,7 +518,7 @@ "collectionEndpoint": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Collection-specific endpoint used to submit index, search, and data upload requests to\n an OpenSearch Serverless collection.

" + "smithy.api#documentation": "

Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

" } }, "dashboardEndpoint": { @@ -527,6 +527,12 @@ "smithy.api#documentation": "

Collection-specific endpoint used to access OpenSearch Dashboards.

" } }, + "fipsEndpoints": { + "target": "com.amazonaws.opensearchserverless#FipsEndpoints", + "traits": { + "smithy.api#documentation": "

FIPS-compliant endpoints for the collection. These endpoints use FIPS 140-3 validated cryptographic modules and are required for federal government workloads that must comply with FedRAMP security standards.

" + } + }, "failureCode": { "target": "smithy.api#String", "traits": { @@ -541,7 +547,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about each OpenSearch Serverless collection, including the collection endpoint and the\n OpenSearch Dashboards endpoint.

" + "smithy.api#documentation": "

Details about each OpenSearch Serverless collection, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints for federal government workloads.

" } }, "com.amazonaws.opensearchserverless#CollectionDetails": { @@ -556,19 +562,19 @@ "id": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { - "smithy.api#documentation": "

If the request contains collection IDs, the response includes the IDs provided in the\n request.

" + "smithy.api#documentation": "

If the request contains collection IDs, the response includes the IDs provided in the request.

" } }, "name": { "target": "com.amazonaws.opensearchserverless#CollectionName", "traits": { - "smithy.api#documentation": "

If the request contains collection names, the response includes the names provided in\n the request.

" + "smithy.api#documentation": "

If the request contains collection names, the response includes the names provided in the request.

" } }, "errorMessage": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A description of the error. For example, The specified Collection is not\n found.\n

" + "smithy.api#documentation": "

A description of the error. For example, The specified Collection is not found.

" } }, "errorCode": { @@ -605,7 +611,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless\n collections.

" + "smithy.api#documentation": "

A list of filter keys that you can use for LIST, UPDATE, and DELETE requests to OpenSearch Serverless collections.

" } }, "com.amazonaws.opensearchserverless#CollectionId": { @@ -766,7 +772,7 @@ } }, "traits": { - "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#documentation": "

When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -794,7 +800,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\n access control for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -818,7 +824,7 @@ "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { - "smithy.api#documentation": "

A description of the policy. Typically used to store information about the permissions\n defined in the policy.

" + "smithy.api#documentation": "

A description of the policy. Typically used to store information about the permissions defined in the policy.

" } }, "policy": { @@ -875,7 +881,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new OpenSearch Serverless collection. For more information, see Creating and\n managing Amazon OpenSearch Serverless collections.

", + "smithy.api#documentation": "

Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

", "smithy.api#idempotent": {} } }, @@ -921,7 +927,7 @@ "kmsKeyArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the\n collection.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.

" } }, "standbyReplicas": { @@ -975,7 +981,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\n collection.

" + "smithy.api#documentation": "

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

" } }, "standbyReplicas": { @@ -1011,25 +1017,87 @@ "instanceArn": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterInstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance used to integrate with OpenSearch\n Serverless.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance used to integrate with OpenSearch 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\n UserId.

" + "smithy.api#documentation": "

The user attribute for this IAM Identity Center integration. Defaults to UserId.

" } }, "groupAttribute": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterGroupAttribute", "traits": { - "smithy.api#documentation": "

The group attribute for this IAM Identity Center integration. Defaults to\n GroupId.

" + "smithy.api#documentation": "

The group attribute for this IAM Identity Center integration. Defaults to GroupId.

" } } }, "traits": { - "smithy.api#documentation": "

Describes IAM Identity Center options for creating an OpenSearch Serverless security\n configuration in the form of a key-value map.

" + "smithy.api#documentation": "

Describes IAM Identity Center options for creating an OpenSearch Serverless security configuration in the form of a key-value map.

" + } + }, + "com.amazonaws.opensearchserverless#CreateIndex": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearchserverless#CreateIndexRequest" + }, + "output": { + "target": "com.amazonaws.opensearchserverless#CreateIndexResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearchserverless#ConflictException" + }, + { + "target": "com.amazonaws.opensearchserverless#InternalServerException" + }, + { + "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearchserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an index within an OpenSearch Serverless collection. Unlike other OpenSearch indexes, indexes created by this API are automatically configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment in the OpenSearch User Guide.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.opensearchserverless#CreateIndexRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.opensearchserverless#CollectionId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the collection in which to create the index.

", + "smithy.api#required": {} + } + }, + "indexName": { + "target": "com.amazonaws.opensearchserverless#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the index to create. Index names must be lowercase and can't begin with underscores (_) or hyphens (-).

", + "smithy.api#required": {} + } + }, + "indexSchema": { + "target": "com.amazonaws.opensearchserverless#IndexSchema", + "traits": { + "smithy.api#documentation": "

The JSON schema definition for the index, including field mappings and settings.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearchserverless#CreateIndexResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#CreateLifecyclePolicy": { @@ -1055,7 +1123,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,\n see Creating data lifecycle policies.

", + "smithy.api#documentation": "

Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define 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#idempotent": {} } }, @@ -1139,7 +1207,7 @@ } ], "traits": { - "smithy.api#documentation": "

Specifies a security configuration for OpenSearch Serverless. For more information, see SAML\n authentication for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -1169,19 +1237,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 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\n 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 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.

" + "smithy.api#documentation": "

Describes IAM federation options in the form of a key-value map. This field is required if you specify iamFederation for the type parameter.

" } }, "clientToken": { @@ -1228,7 +1296,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\n access for Amazon OpenSearch Serverless and Encryption\n at rest for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -1252,7 +1320,7 @@ "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { - "smithy.api#documentation": "

A description of the policy. Typically used to store information about the permissions\n defined in the policy.

" + "smithy.api#documentation": "

A description of the policy. Typically used to store information about the permissions defined in the policy.

" } }, "policy": { @@ -1306,7 +1374,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access\n Amazon OpenSearch Serverless using an interface endpoint.

", + "smithy.api#documentation": "

Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

", "smithy.api#idempotent": {} } }, @@ -1333,7 +1401,7 @@ } }, "traits": { - "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.

" + "smithy.api#documentation": "

Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

" } }, "com.amazonaws.opensearchserverless#CreateVpcEndpointRequest": { @@ -1363,7 +1431,7 @@ "securityGroupIds": { "target": "com.amazonaws.opensearchserverless#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

The unique identifiers of the security groups that define the ports, protocols, and\n sources for inbound traffic that you are authorizing into your endpoint.

" + "smithy.api#documentation": "

The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

" } }, "clientToken": { @@ -1410,7 +1478,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an OpenSearch Serverless access policy. For more information, see Data\n access control for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -1468,7 +1536,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an OpenSearch Serverless collection. For more information, see Creating and\n managing Amazon OpenSearch Serverless collections.

", + "smithy.api#documentation": "

Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

", "smithy.api#idempotent": {} } }, @@ -1504,7 +1572,7 @@ "id": { "target": "com.amazonaws.opensearchserverless#CollectionId", "traits": { - "smithy.api#documentation": "

The unique identifier of the collection. For example, 1iu5usc406kd. The\n ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

", + "smithy.api#documentation": "

The unique identifier of the collection. For example, 1iu5usc406kd. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

", "smithy.api#required": {} } }, @@ -1528,6 +1596,59 @@ } } }, + "com.amazonaws.opensearchserverless#DeleteIndex": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearchserverless#DeleteIndexRequest" + }, + "output": { + "target": "com.amazonaws.opensearchserverless#DeleteIndexResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearchserverless#InternalServerException" + }, + { + "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearchserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an index from an OpenSearch Serverless collection. Be aware that the index might be configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.opensearchserverless#DeleteIndexRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.opensearchserverless#CollectionId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the collection containing the index to delete.

", + "smithy.api#required": {} + } + }, + "indexName": { + "target": "com.amazonaws.opensearchserverless#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the index to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearchserverless#DeleteIndexResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.opensearchserverless#DeleteLifecyclePolicy": { "type": "operation", "input": { @@ -1615,7 +1736,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a security configuration for OpenSearch Serverless. For more information, see SAML\n authentication for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -1625,7 +1746,7 @@ "id": { "target": "com.amazonaws.opensearchserverless#SecurityConfigId", "traits": { - "smithy.api#documentation": "

The security configuration identifier. For SAML the ID will be\n saml/<accountId>/<idpProviderName>. For example,\n saml/123456789123/OKTADev.

", + "smithy.api#documentation": "

The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.

", "smithy.api#required": {} } }, @@ -1724,7 +1845,7 @@ } ], "traits": { - "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#documentation": "

Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

", "smithy.api#idempotent": {} } }, @@ -1809,19 +1930,19 @@ "resourceType": { "target": "com.amazonaws.opensearchserverless#ResourceType", "traits": { - "smithy.api#documentation": "

The type of OpenSearch Serverless resource. Currently, the only supported resource is\n index.

" + "smithy.api#documentation": "

The type of OpenSearch Serverless resource. Currently, the only supported resource is 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\n 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 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\n return as true if the minimum number of days or hours is not set to a index\n resource.

" + "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 hours is not set to a index resource.

" } } }, @@ -1853,7 +1974,7 @@ "errorMessage": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A description of the error. For example, The specified Index resource is not\n found.

" + "smithy.api#documentation": "

A description of the error. For example, The specified Index resource is not found.

" } }, "errorCode": { @@ -1873,6 +1994,26 @@ "target": "com.amazonaws.opensearchserverless#EffectiveLifecyclePolicyErrorDetail" } }, + "com.amazonaws.opensearchserverless#FipsEndpoints": { + "type": "structure", + "members": { + "collectionEndpoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

FIPS-compliant collection endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection. This endpoint uses FIPS 140-3 validated cryptography and is required for federal government workloads.

" + } + }, + "dashboardEndpoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

FIPS-compliant endpoint used to access OpenSearch Dashboards. This endpoint uses FIPS 140-3 validated cryptography and is required for federal government workloads that need dashboard visualization capabilities.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

FIPS-compliant endpoint URLs for an OpenSearch Serverless collection. These endpoints ensure all data transmission uses FIPS 140-3 validated cryptographic implementations, meeting federal security requirements for government workloads.

" + } + }, "com.amazonaws.opensearchserverless#GetAccessPolicy": { "type": "operation", "input": { @@ -1893,7 +2034,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 access control for Amazon OpenSearch Serverless.

", "smithy.api#readonly": {} } }, @@ -1963,6 +2104,66 @@ } } }, + "com.amazonaws.opensearchserverless#GetIndex": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearchserverless#GetIndexRequest" + }, + "output": { + "target": "com.amazonaws.opensearchserverless#GetIndexResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearchserverless#InternalServerException" + }, + { + "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearchserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about an index in an OpenSearch Serverless collection, including its schema definition. The index might be configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.opensearchserverless#GetIndexRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.opensearchserverless#CollectionId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the collection containing the index.

", + "smithy.api#required": {} + } + }, + "indexName": { + "target": "com.amazonaws.opensearchserverless#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the index to retrieve information about.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearchserverless#GetIndexResponse": { + "type": "structure", + "members": { + "indexSchema": { + "target": "com.amazonaws.opensearchserverless#IndexSchema", + "traits": { + "smithy.api#documentation": "

The JSON schema definition for the index, including field mappings and settings.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.opensearchserverless#GetPoliciesStats": { "type": "operation", "input": { @@ -1977,7 +2178,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns statistical information about your OpenSearch Serverless access policies, security\n configurations, and security policies.

", + "smithy.api#documentation": "

Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.

", "smithy.api#readonly": {} } }, @@ -2015,7 +2216,7 @@ "TotalPolicyCount": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

The total number of OpenSearch Serverless security policies and configurations in your\n account.

" + "smithy.api#documentation": "

The total number of OpenSearch Serverless security policies and configurations in your account.

" } } } @@ -2040,7 +2241,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about an OpenSearch Serverless security configuration. For more information, see\n SAML\n authentication for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.

", "smithy.api#readonly": {} } }, @@ -2087,7 +2288,7 @@ } ], "traits": { - "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#documentation": "

Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

", "smithy.api#readonly": {} } }, @@ -2127,18 +2328,18 @@ "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.

" + "smithy.api#documentation": "

The group attribute for this IAM federation integration. This attribute is used to map 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.

" + "smithy.api#documentation": "

The user attribute for this IAM federation integration. This attribute is used to 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.

" + "smithy.api#documentation": "

Describes IAM federation options for an OpenSearch Serverless security configuration in the form of a key-value map. These options define how OpenSearch Serverless integrates with external identity providers using federation.

" } }, "com.amazonaws.opensearchserverless#IamIdentityCenterApplicationArn": { @@ -2157,42 +2358,42 @@ "instanceArn": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterInstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance used to integrate with OpenSearch\n Serverless.

" + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

" } }, "applicationArn": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterApplicationArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center application used to integrate with OpenSearch\n Serverless.

" + "smithy.api#documentation": "

The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.

" } }, "applicationName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the IAM Identity Center application used to integrate with OpenSearch\n Serverless.

" + "smithy.api#documentation": "

The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.

" } }, "applicationDescription": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The description of the IAM Identity Center application used to integrate with\n OpenSearch Serverless.

" + "smithy.api#documentation": "

The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.

" } }, "userAttribute": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterUserAttribute", "traits": { - "smithy.api#documentation": "

The user attribute for this IAM Identity Center integration. Defaults to\n UserId\n

" + "smithy.api#documentation": "

The user attribute for this IAM Identity Center integration. Defaults to UserId

" } }, "groupAttribute": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterGroupAttribute", "traits": { - "smithy.api#documentation": "

The group attribute for this IAM Identity Center integration. Defaults to\n GroupId.

" + "smithy.api#documentation": "

The group attribute for this IAM Identity Center integration. Defaults to GroupId.

" } } }, "traits": { - "smithy.api#documentation": "

Describes IAM Identity Center options for an OpenSearch Serverless security\n configuration in the form of a key-value map.

" + "smithy.api#documentation": "

Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.

" } }, "com.amazonaws.opensearchserverless#IamIdentityCenterGroupAttribute": { @@ -2244,6 +2445,40 @@ ] } }, + "com.amazonaws.opensearchserverless#Index": { + "type": "resource", + "identifiers": { + "id": { + "target": "com.amazonaws.opensearchserverless#CollectionId" + }, + "indexName": { + "target": "com.amazonaws.opensearchserverless#IndexName" + } + }, + "put": { + "target": "com.amazonaws.opensearchserverless#CreateIndex" + }, + "read": { + "target": "com.amazonaws.opensearchserverless#GetIndex" + }, + "update": { + "target": "com.amazonaws.opensearchserverless#UpdateIndex" + }, + "delete": { + "target": "com.amazonaws.opensearchserverless#DeleteIndex" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Index" + } + } + }, + "com.amazonaws.opensearchserverless#IndexName": { + "type": "string" + }, + "com.amazonaws.opensearchserverless#IndexSchema": { + "type": "document" + }, "com.amazonaws.opensearchserverless#IndexingCapacityValue": { "type": "integer", "traits": { @@ -2364,7 +2599,7 @@ "errorMessage": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A description of the error. For example, The specified Lifecycle Policy is not\n found.

" + "smithy.api#documentation": "

A description of the error. For example, The specified Lifecycle Policy is not found.

" } }, "errorCode": { @@ -2586,13 +2821,13 @@ "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 nextToken, you can include the returned nextToken in subsequent ListAccessPolicies operations, which returns results in the 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\n use nextToken to get the next page of results. The default is 20.

", + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

", "smithy.api#range": { "min": 1, "max": 100 @@ -2613,7 +2848,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "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.

" + "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.

" } } } @@ -2635,7 +2870,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all OpenSearch Serverless collections. For more information, see Creating and\n managing Amazon OpenSearch Serverless collections.

\n \n

Make sure to include an empty request body {} if you don't include any collection\n filters in the request.

\n
", + "smithy.api#documentation": "

Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Make sure to include an empty request body {} if you don't include any collection filters in the request.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2650,19 +2885,19 @@ "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\n nextToken, you can include the returned nextToken in\n subsequent ListCollections operations, which returns results in the next\n page.

" + "smithy.api#documentation": "

If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.

" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of results to return. Default is 20. You can use\n nextToken to get the next page of results.

", + "smithy.api#documentation": "

The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

", "smithy.api#range": { "min": 1, "max": 100 @@ -2683,7 +2918,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "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.

" + "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.

" } } } @@ -2727,7 +2962,7 @@ "resources": { "target": "com.amazonaws.opensearchserverless#LifecycleResourceFilter", "traits": { - "smithy.api#documentation": "

Resource filters that policies can apply to. Currently, the only supported resource\n type is index.

", + "smithy.api#documentation": "

Resource filters that policies can apply to. Currently, the only supported resource type is index.

", "smithy.api#length": { "min": 1, "max": 1000 @@ -2737,13 +2972,13 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "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.

" + "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.

" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "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#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#range": { "min": 1, "max": 100 @@ -2767,7 +3002,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "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.

" + "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.

" } } }, @@ -2792,7 +3027,7 @@ } ], "traits": { - "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#documentation": "

Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2814,13 +3049,13 @@ "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 nextToken, you can include the returned nextToken in subsequent ListSecurityConfigs operations, which returns results in the 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\n use nextToken to get the next page of results. The default is 20.

", + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

", "smithy.api#range": { "min": 1, "max": 100 @@ -2841,7 +3076,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "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.

" + "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.

" } } } @@ -2885,7 +3120,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 @@ -2895,13 +3130,13 @@ "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 nextToken, you can include the returned nextToken in subsequent ListSecurityPolicies operations, which returns results in the 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\n use nextToken to get the next page of results. The default is 20.

", + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

", "smithy.api#range": { "min": 1, "max": 100 @@ -2922,7 +3157,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "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.

" + "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.

" } } } @@ -2947,7 +3182,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging\n Amazon OpenSearch Serverless collections.

" + "smithy.api#documentation": "

Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

" } }, "com.amazonaws.opensearchserverless#ListTagsForResourceRequest": { @@ -2956,7 +3191,7 @@ "resourceArn": { "target": "com.amazonaws.opensearchserverless#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource. The resource must be active (not in\n the DELETING state), and must be owned by the account ID included in the\n request.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.

", "smithy.api#required": {} } } @@ -2990,7 +3225,7 @@ } ], "traits": { - "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#documentation": "

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3005,19 +3240,19 @@ "vpcEndpointFilters": { "target": "com.amazonaws.opensearchserverless#VpcEndpointFilters", "traits": { - "smithy.api#documentation": "

Filter the results according to the current status of the VPC endpoint. Possible\n statuses are CREATING, DELETING, UPDATING,\n ACTIVE, and FAILED.

" + "smithy.api#documentation": "

Filter the results according to the current status of the VPC endpoint. Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED.

" } }, "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 nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the 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\n use nextToken to get the next page of results. The default is 20.

", + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

", "smithy.api#range": { "min": 1, "max": 100 @@ -3038,7 +3273,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "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.

" + "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.

" } } } @@ -3055,7 +3290,7 @@ } }, "traits": { - "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#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#error": "client", "smithy.api#httpError": 402 } @@ -3111,6 +3346,9 @@ { "target": "com.amazonaws.opensearchserverless#Collection" }, + { + "target": "com.amazonaws.opensearchserverless#Index" + }, { "target": "com.amazonaws.opensearchserverless#LifecyclePolicy" }, @@ -3134,7 +3372,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 security policies.

OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management.

To learn more about OpenSearch Serverless, see What is Amazon OpenSearch Serverless?

", "smithy.api#title": "OpenSearch Service Serverless", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -3644,17 +3882,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3668,17 +3895,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3692,17 +3908,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3716,17 +3921,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3906,7 +4100,7 @@ "openSearchServerlessEntityId": { "target": "com.amazonaws.opensearchserverless#openSearchServerlessEntityId", "traits": { - "smithy.api#documentation": "

Custom entity ID attribute to override the default entity ID for this SAML\n integration.

" + "smithy.api#documentation": "

Custom entity ID attribute to override the default entity ID for this SAML integration.

" } }, "sessionTimeout": { @@ -3921,7 +4115,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value\n map.

" + "smithy.api#documentation": "

Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.

" } }, "com.amazonaws.opensearchserverless#SearchCapacityValue": { @@ -4002,7 +4196,7 @@ "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.

" + "smithy.api#documentation": "

Describes IAM federation options in the form of a key-value map. Contains configuration details about how OpenSearch Serverless integrates with external identity providers through federation.

" } }, "createdDate": { @@ -4341,7 +4535,7 @@ } }, "traits": { - "smithy.api#documentation": "

Thrown when you attempt to create more resources than the service allows based on\n service quotas.

", + "smithy.api#documentation": "

Thrown when you attempt to create more resources than the service allows based on service quotas.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -4380,8 +4574,7 @@ }, "traits": { "smithy.api#length": { - "min": 1, - "max": 6 + "min": 1 } } }, @@ -4454,7 +4647,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates tags with an OpenSearch Serverless resource. For more information, see Tagging\n Amazon OpenSearch Serverless collections.

" + "smithy.api#documentation": "

Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

" } }, "com.amazonaws.opensearchserverless#TagResourceRequest": { @@ -4463,14 +4656,14 @@ "resourceArn": { "target": "com.amazonaws.opensearchserverless#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource. The resource must be active (not in\n the DELETING state), and must be owned by the account ID included in the\n request.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.opensearchserverless#Tags", "traits": { - "smithy.api#documentation": "

A list of tags (key-value pairs) to add to the resource. All tag keys in the request\n must be unique.

", + "smithy.api#documentation": "

A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique.

", "smithy.api#required": {} } } @@ -4524,7 +4717,7 @@ } ], "traits": { - "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.

" + "smithy.api#documentation": "

Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

" } }, "com.amazonaws.opensearchserverless#UntagResourceRequest": { @@ -4533,14 +4726,14 @@ "resourceArn": { "target": "com.amazonaws.opensearchserverless#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must\n be active (not in the DELETING state), and must be owned by the account ID\n included in the request.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.

", "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.opensearchserverless#TagKeys", "traits": { - "smithy.api#documentation": "

The tag or set of tags to remove from the resource. All tag keys in the request must\n be unique.

", + "smithy.api#documentation": "

The tag or set of tags to remove from the resource. All tag keys in the request must be unique.

", "smithy.api#required": {} } } @@ -4573,7 +4766,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 access control for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -4604,7 +4797,7 @@ "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { - "smithy.api#documentation": "

A description of the policy. Typically used to store information about the permissions\n defined in the policy.

" + "smithy.api#documentation": "

A description of the policy. Typically used to store information about the permissions defined in the policy.

" } }, "policy": { @@ -4651,7 +4844,7 @@ } ], "traits": { - "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.

" + "smithy.api#documentation": "

Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.

" } }, "com.amazonaws.opensearchserverless#UpdateAccountSettingsRequest": { @@ -4799,18 +4992,77 @@ "userAttribute": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterUserAttribute", "traits": { - "smithy.api#documentation": "

The user attribute for this IAM Identity Center integration. Defaults to\n UserId.

" + "smithy.api#documentation": "

The user attribute for this IAM Identity Center integration. Defaults to UserId.

" } }, "groupAttribute": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterGroupAttribute", "traits": { - "smithy.api#documentation": "

The group attribute for this IAM Identity Center integration. Defaults to\n GroupId.

" + "smithy.api#documentation": "

The group attribute for this IAM Identity Center integration. Defaults to 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.

" + } + }, + "com.amazonaws.opensearchserverless#UpdateIndex": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearchserverless#UpdateIndexRequest" + }, + "output": { + "target": "com.amazonaws.opensearchserverless#UpdateIndexResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearchserverless#InternalServerException" + }, + { + "target": "com.amazonaws.opensearchserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearchserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing index in an OpenSearch Serverless collection. This operation allows you to modify the index schema, including adding new fields or changing field mappings. You can also enable automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.opensearchserverless#UpdateIndexRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.opensearchserverless#CollectionId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the collection containing the index to update.

", + "smithy.api#required": {} + } + }, + "indexName": { + "target": "com.amazonaws.opensearchserverless#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the index to update.

", + "smithy.api#required": {} + } + }, + "indexSchema": { + "target": "com.amazonaws.opensearchserverless#IndexSchema", + "traits": { + "smithy.api#documentation": "

The updated JSON schema definition for the index, including field mappings and settings.

" } } }, "traits": { - "smithy.api#documentation": "

Describes IAM Identity Center options for updating an OpenSearch Serverless security\n configuration in the form of a key-value map.

" + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearchserverless#UpdateIndexResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.opensearchserverless#UpdateLifecyclePolicy": { @@ -4849,7 +5101,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": {} } }, @@ -4929,7 +5181,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a security configuration for OpenSearch Serverless. For more information, see SAML\n authentication for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -4939,14 +5191,14 @@ "id": { "target": "com.amazonaws.opensearchserverless#SecurityConfigId", "traits": { - "smithy.api#documentation": "

The security configuration identifier. For SAML the ID will be\n saml/<accountId>/<idpProviderName>. For example,\n saml/123456789123/OKTADev.

", + "smithy.api#documentation": "

The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.

", "smithy.api#required": {} } }, "configVersion": { "target": "com.amazonaws.opensearchserverless#PolicyVersion", "traits": { - "smithy.api#documentation": "

The version of the security configuration to be updated. You can find the most recent\n version of a security configuration using the GetSecurityPolicy\n command.

", + "smithy.api#documentation": "

The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.

", "smithy.api#required": {} } }, @@ -4971,7 +5223,7 @@ "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.

" + "smithy.api#documentation": "

Describes IAM federation options in the form of a key-value map for updating an existing security configuration. Use this field to modify IAM federation settings for the security configuration.

" } }, "clientToken": { @@ -4990,7 +5242,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.

" } } } @@ -5021,7 +5273,7 @@ } ], "traits": { - "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#documentation": "

Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -5052,7 +5304,7 @@ "description": { "target": "com.amazonaws.opensearchserverless#PolicyDescription", "traits": { - "smithy.api#documentation": "

A description of the policy. Typically used to store information about the permissions\n defined in the policy.

" + "smithy.api#documentation": "

A description of the policy. Typically used to store information about the permissions defined in the policy.

" } }, "policy": { @@ -5102,7 +5354,7 @@ } ], "traits": { - "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#documentation": "

Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

", "smithy.api#idempotent": {} } }, @@ -5136,7 +5388,7 @@ "securityGroupIds": { "target": "com.amazonaws.opensearchserverless#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

The unique identifiers of the security groups that define the ports, protocols, and\n sources for inbound traffic that you are authorizing into your endpoint.

" + "smithy.api#documentation": "

The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

" } }, "lastModifiedDate": { @@ -5175,7 +5427,7 @@ "addSecurityGroupIds": { "target": "com.amazonaws.opensearchserverless#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

The unique identifiers of the security groups to add to the endpoint. Security groups\n define the ports, protocols, and sources for inbound traffic that you are authorizing\n into your endpoint.

" + "smithy.api#documentation": "

The unique identifiers of the security groups to add to the endpoint. Security groups define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

" } }, "removeSecurityGroupIds": { @@ -5213,7 +5465,7 @@ } }, "traits": { - "smithy.api#documentation": "

Thrown when the HTTP request contains invalid input or is missing required\n input.

", + "smithy.api#documentation": "

Thrown when the HTTP request contains invalid input or is missing required input.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -5270,7 +5522,7 @@ "securityGroupIds": { "target": "com.amazonaws.opensearchserverless#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

The unique identifiers of the security groups that define the ports, protocols, and\n sources for inbound traffic that you are authorizing into your endpoint.

" + "smithy.api#documentation": "

The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

" } }, "status": { diff --git a/codegen/sdk/aws-models/opsworks.json b/codegen/sdk/aws-models/opsworks.json deleted file mode 100644 index 042be462c60..00000000000 --- a/codegen/sdk/aws-models/opsworks.json +++ /dev/null @@ -1,9603 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.opsworks#AgentVersion": { - "type": "structure", - "members": { - "Version": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The agent version.

" - } - }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", - "traits": { - "smithy.api#documentation": "

The configuration manager.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an agent version.

" - } - }, - "com.amazonaws.opsworks#AgentVersions": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#AgentVersion" - } - }, - "com.amazonaws.opsworks#App": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app stack ID.

" - } - }, - "Shortname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app's short name.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app name.

" - } - }, - "Description": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A description of the app.

" - } - }, - "DataSources": { - "target": "com.amazonaws.opsworks#DataSources", - "traits": { - "smithy.api#documentation": "

The app's data sources.

" - } - }, - "Type": { - "target": "com.amazonaws.opsworks#AppType", - "traits": { - "smithy.api#documentation": "

The app type.

" - } - }, - "AppSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

A Source object that describes the app repository.

" - } - }, - "Domains": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The app vhost settings with multiple domains separated by commas. For example:\n 'www.example.com, example.com'\n

" - } - }, - "EnableSsl": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to enable SSL for the app.

" - } - }, - "SslConfiguration": { - "target": "com.amazonaws.opsworks#SslConfiguration", - "traits": { - "smithy.api#documentation": "

An SslConfiguration object with the SSL configuration.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#AppAttributes", - "traits": { - "smithy.api#documentation": "

The stack attributes.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

When the app was created.

" - } - }, - "Environment": { - "target": "com.amazonaws.opsworks#EnvironmentVariables", - "traits": { - "smithy.api#documentation": "

An array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n associated app server instances. For more information, see Environment Variables.

\n \n

There is no specific limit on the number of environment variables. \n However, the size of the associated data structure - which includes the variable names, values, and protected flag \n values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you \n will cause an exception (API) with an \"Environment: is too large (maximum is 20 KB)\" message.

\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "

A description of the app.

" - } - }, - "com.amazonaws.opsworks#AppAttributes": { - "type": "map", - "key": { - "target": "com.amazonaws.opsworks#AppAttributesKeys" - }, - "value": { - "target": "com.amazonaws.opsworks#String" - } - }, - "com.amazonaws.opsworks#AppAttributesKeys": { - "type": "enum", - "members": { - "DocumentRoot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DocumentRoot" - } - }, - "RailsEnv": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RailsEnv" - } - }, - "AutoBundleOnDeploy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AutoBundleOnDeploy" - } - }, - "AwsFlowRubySettings": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AwsFlowRubySettings" - } - } - } - }, - "com.amazonaws.opsworks#AppType": { - "type": "enum", - "members": { - "aws_flow_ruby": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "aws-flow-ruby" - } - }, - "java": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "java" - } - }, - "rails": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rails" - } - }, - "php": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "php" - } - }, - "nodejs": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "nodejs" - } - }, - "static": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "static" - } - }, - "other": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "other" - } - } - } - }, - "com.amazonaws.opsworks#Apps": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#App" - } - }, - "com.amazonaws.opsworks#Architecture": { - "type": "enum", - "members": { - "x86_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x86_64" - } - }, - "i386": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i386" - } - } - } - }, - "com.amazonaws.opsworks#AssignInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#AssignInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Assign a registered instance to a layer.

\n
    \n
  • \n

    You can assign registered on-premises instances to any layer type.

    \n
  • \n
  • \n

    You can assign registered Amazon EC2 instances only to custom layers.

    \n
  • \n
  • \n

    You cannot use this action with instances that were created with OpsWorks Stacks.

    \n
  • \n
\n

\n Required Permissions: To use this action, an Identity and Access Management\n (IAM) user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#AssignInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#AssignVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#AssignVolumeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must\n first be registered with the stack by calling RegisterVolume. After you register the\n volume, you must call UpdateVolume to specify a mount point before calling\n AssignVolume. For more information, see Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage \n permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#AssignVolumeRequest": { - "type": "structure", - "members": { - "VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume ID.

", - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#AssociateElasticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#AssociateElasticIpRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Associates one of the stack's registered Elastic IP addresses with a specified instance. The\n address must first be registered with the stack by calling RegisterElasticIp. For more\n information, see Resource\n Management.

\n

\n Required Permissions: To use this action, an IAM user must have a \n Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#AssociateElasticIpRequest": { - "type": "structure", - "members": { - "ElasticIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#AttachElasticLoadBalancer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#AttachElasticLoadBalancerRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Attaches an Elastic Load Balancing load balancer to a specified layer. OpsWorks Stacks does not support \n Application Load Balancer. You can only use Classic Load Balancer with OpsWorks Stacks. \n For more information, see Elastic Load\n Balancing.

\n \n

You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For\n more information, see the Elastic Load Balancing Developer Guide.

\n
\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#AttachElasticLoadBalancerRequest": { - "type": "structure", - "members": { - "ElasticLoadBalancerName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic Load Balancing instance's name.

", - "smithy.api#required": {} - } - }, - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the layer to which the Elastic Load Balancing instance is to be attached.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#AutoScalingThresholds": { - "type": "structure", - "members": { - "InstanceCount": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances to add or remove when the load exceeds a threshold.

" - } - }, - "ThresholdsWaitTime": { - "target": "com.amazonaws.opsworks#Minute", - "traits": { - "smithy.api#documentation": "

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

" - } - }, - "IgnoreMetricsTime": { - "target": "com.amazonaws.opsworks#Minute", - "traits": { - "smithy.api#documentation": "

The amount of time (in minutes) after a scaling event occurs that OpsWorks Stacks should ignore metrics\n and suppress additional scaling events. For example, OpsWorks Stacks adds new instances following\n an upscaling event but the instances won't start reducing the load until they have been booted\n and configured. There is no point in raising additional scaling events during that operation,\n which typically takes several minutes. IgnoreMetricsTime allows you to direct\n OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

" - } - }, - "CpuThreshold": { - "target": "com.amazonaws.opsworks#Double", - "traits": { - "smithy.api#documentation": "

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

" - } - }, - "MemoryThreshold": { - "target": "com.amazonaws.opsworks#Double", - "traits": { - "smithy.api#documentation": "

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

" - } - }, - "LoadThreshold": { - "target": "com.amazonaws.opsworks#Double", - "traits": { - "smithy.api#documentation": "

The load threshold. A value of -1 disables the threshold. For more information about how load is computed, \n see Load (computing).

" - } - }, - "Alarms": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

Custom CloudWatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names,\n which are case sensitive and must be in the same region as the stack.

\n \n

To use custom alarms, you must update your service role to allow\n cloudwatch:DescribeAlarms. You can either have OpsWorks Stacks update the role for\n you when you first use this feature or you can edit the role manually. For more information,\n see Allowing OpsWorks Stacks to Act on Your Behalf.

\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when OpsWorks Stacks starts or \n stops load-based instances.

" - } - }, - "com.amazonaws.opsworks#AutoScalingType": { - "type": "enum", - "members": { - "load": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "load" - } - }, - "timer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "timer" - } - } - } - }, - "com.amazonaws.opsworks#BlockDeviceMapping": { - "type": "structure", - "members": { - "DeviceName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The device name that is exposed to the instance, such as /dev/sdh. For the root\n device, you can use the explicit device name or you can set this parameter to\n ROOT_DEVICE and OpsWorks Stacks will provide the correct device name.

" - } - }, - "NoDevice": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Suppresses the specified device included in the AMI's block device mapping.

" - } - }, - "VirtualName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The virtual device name. For more information, see BlockDeviceMapping.

" - } - }, - "Ebs": { - "target": "com.amazonaws.opsworks#EbsBlockDevice", - "traits": { - "smithy.api#documentation": "

An EBSBlockDevice that defines how to configure an Amazon EBS volume when the\n instance is launched.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.

" - } - }, - "com.amazonaws.opsworks#BlockDeviceMappings": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#BlockDeviceMapping" - } - }, - "com.amazonaws.opsworks#Boolean": { - "type": "boolean" - }, - "com.amazonaws.opsworks#ChefConfiguration": { - "type": "structure", - "members": { - "ManageBerkshelf": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to enable Berkshelf.

" - } - }, - "BerkshelfVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Berkshelf version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Chef configuration.

" - } - }, - "com.amazonaws.opsworks#CloneStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#CloneStackRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#CloneStackResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a clone of a specified stack. For more information, see Clone a\n Stack. By default, all parameters are set to the values used by the parent stack.

\n

\n Required Permissions: To use this action, an IAM user must have an attached policy\n that explicitly grants permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#CloneStackRequest": { - "type": "structure", - "members": { - "SourceStackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The source stack ID.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cloned stack name. Stack names can be a maximum of 64 characters.

" - } - }, - "Region": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cloned stack Amazon Web Services Region, such as ap-northeast-2. For more information \n about Amazon Web Services Regions, see\n Regions and Endpoints.

" - } - }, - "VpcId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All\n instances are launched into this VPC, and you cannot change the ID later.

\n
    \n
  • \n

    If your account supports EC2 Classic, the default value is no VPC.

    \n
  • \n
  • \n

    If your account does not support EC2 Classic, the default value is the default VPC for the specified region.

    \n
  • \n
\n

If the VPC ID corresponds to a default VPC and you have specified either the\n DefaultAvailabilityZone or the DefaultSubnetId parameter only,\n OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, OpsWorks Stacks sets\n these parameters to the first valid Availability Zone for the specified region and the\n corresponding default VPC subnet ID, respectively.

\n

If you specify a nondefault VPC ID, note the following:

\n
    \n
  • \n

    It must belong to a VPC in your account that is in the specified region.

    \n
  • \n
  • \n

    You must specify a value for DefaultSubnetId.

    \n
  • \n
\n

For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a\n VPC. For more information about default VPC and EC2 Classic, see Supported\n Platforms.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#StackAttributes", - "traits": { - "smithy.api#documentation": "

A list of stack attributes and values as key/value pairs to be added to the cloned stack.

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack Identity and Access Management (IAM) role, which allows OpsWorks Stacks to work with Amazon Web Services\n resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an\n existing IAM role. If you create a stack by using the OpsWorkss Stacks console, it creates the role for\n you. You can obtain an existing stack's IAM ARN programmatically by calling\n DescribePermissions. For more information about IAM ARNs, see \n Using\n Identifiers.

\n \n

You must set this parameter to a valid service role ARN or the action will fail; there is no default value. \n You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.

\n
", - "smithy.api#required": {} - } - }, - "DefaultInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's \n EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

" - } - }, - "DefaultOs": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's operating system, which must be set to one of the following.

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux\n 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    \n
  • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
  • \n
  • \n

    \n CentOS Linux 7\n

    \n
  • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
  • \n
  • \n

    \n Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
  • \n
  • \n

    A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more information about how to use custom AMIs with OpsWorks, see Using\n Custom AMIs.

    \n
  • \n
\n

The default option is the parent stack's operating system.\n Not all operating systems are supported with all versions of Chef. For more information about supported operating systems,\n see OpsWorks Stacks Operating Systems.

\n \n

You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to \n Windows or Windows to Linux.

\n
" - } - }, - "HostnameTheme": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's host name theme, with spaces are replaced by underscores. The theme is used to\n generate host names for the stack's instances. By default, HostnameTheme is set\n to Layer_Dependent, which creates host names by appending integers to the layer's\n short name. The other themes are:

\n
    \n
  • \n

    \n Baked_Goods\n

    \n
  • \n
  • \n

    \n Clouds\n

    \n
  • \n
  • \n

    \n Europe_Cities\n

    \n
  • \n
  • \n

    \n Fruits\n

    \n
  • \n
  • \n

    \n Greek_Deities_and_Titans\n

    \n
  • \n
  • \n

    \n Legendary_creatures_from_Japan\n

    \n
  • \n
  • \n

    \n Planets_and_Moons\n

    \n
  • \n
  • \n

    \n Roman_Deities\n

    \n
  • \n
  • \n

    \n Scottish_Islands\n

    \n
  • \n
  • \n

    \n US_Cities\n

    \n
  • \n
  • \n

    \n Wild_Cats\n

    \n
  • \n
\n

To obtain a generated host name, call GetHostNameSuggestion, which returns a\n host name based on the current theme.

" - } - }, - "DefaultAvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cloned stack's default Availability Zone, which must be in the specified region. For more\n information, see Regions and\n Endpoints. If you also specify a value for DefaultSubnetId, the subnet must\n be in the same zone. For more information, see the VpcId parameter description.\n

" - } - }, - "DefaultSubnetId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default VPC subnet ID. This parameter is required if you specify a value for the\n VpcId parameter. All instances are launched into this subnet unless you specify\n otherwise when you create the instance. If you also specify a value for\n DefaultAvailabilityZone, the subnet must be in that zone. For information on\n default values and when this parameter is required, see the VpcId parameter\n description.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration \n JSON values. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes\n

" - } - }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", - "traits": { - "smithy.api#documentation": "

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the \n Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

" - } - }, - "ChefConfiguration": { - "target": "com.amazonaws.opsworks#ChefConfiguration", - "traits": { - "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" - } - }, - "UseCustomCookbooks": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to use custom cookbooks.

" - } - }, - "UseOpsworksSecurityGroups": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

\n

OpsWorks Stacks provides a standard set of security groups, one for each layer, which are\n associated with layers by default. With UseOpsworksSecurityGroups you can instead\n provide your own custom security groups. UseOpsworksSecurityGroups has the\n following settings:

\n
    \n
  • \n

    True - OpsWorks Stacks automatically associates the appropriate built-in security group with \n each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot \n delete the built-in security group.

    \n
  • \n
  • \n

    False - OpsWorks Stacks does not associate built-in security groups with layers. \n You must create appropriate Amazon EC2 security groups and associate a security group with each \n layer that you create. However, you can still manually associate a built-in security group with a layer on creation; \n custom security groups are required only for those layers that need custom settings.

    \n
  • \n
\n

For more information, see Create a New\n Stack.

" - } - }, - "CustomCookbooksSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or \n Cookbooks and Recipes.

" - } - }, - "DefaultSshKeyName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, \n OpsWorks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.

" - } - }, - "ClonePermissions": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to clone the source stack's permissions.

" - } - }, - "CloneAppIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

A list of source stack app IDs to be included in the cloned stack.

" - } - }, - "DefaultRootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", - "traits": { - "smithy.api#documentation": "

The default root device type. This value is used by default for all instances in the cloned\n stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" - } - }, - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The default OpsWorks Stacks agent version. You have the following options:

\n
    \n
  • \n

    Auto-update - Set this parameter to LATEST. OpsWorks Stacks\n automatically installs new agent versions on the stack's instances as soon as\n they are available.

    \n
  • \n
  • \n

    Fixed version - Set this parameter to your preferred agent version. To update \n the agent version, you must edit the stack configuration and specify a new version. \n OpsWorks Stacks automatically installs that version on the stack's instances.

    \n
  • \n
\n

The default setting is LATEST. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

\n \n

You can also specify an agent version when you create or update an instance, which overrides the stack's \n default setting.

\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#CloneStackResult": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cloned stack ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a CloneStack request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#CloudWatchLogsConfiguration": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether CloudWatch Logs is enabled for a layer.

" - } - }, - "LogStreams": { - "target": "com.amazonaws.opsworks#CloudWatchLogsLogStreams", - "traits": { - "smithy.api#documentation": "

A list of configuration options for CloudWatch Logs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Amazon CloudWatch Logs configuration for a layer.

" - } - }, - "com.amazonaws.opsworks#CloudWatchLogsEncoding": { - "type": "enum", - "members": { - "ascii": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ascii" - } - }, - "big5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "big5" - } - }, - "big5hkscs": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "big5hkscs" - } - }, - "cp037": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp037" - } - }, - "cp424": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp424" - } - }, - "cp437": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp437" - } - }, - "cp500": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp500" - } - }, - "cp720": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp720" - } - }, - "cp737": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp737" - } - }, - "cp775": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp775" - } - }, - "cp850": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp850" - } - }, - "cp852": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp852" - } - }, - "cp855": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp855" - } - }, - "cp856": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp856" - } - }, - "cp857": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp857" - } - }, - "cp858": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp858" - } - }, - "cp860": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp860" - } - }, - "cp861": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp861" - } - }, - "cp862": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp862" - } - }, - "cp863": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp863" - } - }, - "cp864": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp864" - } - }, - "cp865": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp865" - } - }, - "cp866": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp866" - } - }, - "cp869": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp869" - } - }, - "cp874": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp874" - } - }, - "cp875": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp875" - } - }, - "cp932": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp932" - } - }, - "cp949": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp949" - } - }, - "cp950": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp950" - } - }, - "cp1006": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1006" - } - }, - "cp1026": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1026" - } - }, - "cp1140": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1140" - } - }, - "cp1250": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1250" - } - }, - "cp1251": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1251" - } - }, - "cp1252": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1252" - } - }, - "cp1253": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1253" - } - }, - "cp1254": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1254" - } - }, - "cp1255": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1255" - } - }, - "cp1256": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1256" - } - }, - "cp1257": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1257" - } - }, - "cp1258": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1258" - } - }, - "euc_jp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "euc_jp" - } - }, - "euc_jis_2004": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "euc_jis_2004" - } - }, - "euc_jisx0213": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "euc_jisx0213" - } - }, - "euc_kr": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "euc_kr" - } - }, - "gb2312": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gb2312" - } - }, - "gbk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gbk" - } - }, - "gb18030": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gb18030" - } - }, - "hz": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hz" - } - }, - "iso2022_jp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso2022_jp" - } - }, - "iso2022_jp_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso2022_jp_1" - } - }, - "iso2022_jp_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso2022_jp_2" - } - }, - "iso2022_jp_2004": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso2022_jp_2004" - } - }, - "iso2022_jp_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso2022_jp_3" - } - }, - "iso2022_jp_ext": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso2022_jp_ext" - } - }, - "iso2022_kr": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso2022_kr" - } - }, - "latin_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "latin_1" - } - }, - "iso8859_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_2" - } - }, - "iso8859_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_3" - } - }, - "iso8859_4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_4" - } - }, - "iso8859_5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_5" - } - }, - "iso8859_6": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_6" - } - }, - "iso8859_7": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_7" - } - }, - "iso8859_8": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_8" - } - }, - "iso8859_9": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_9" - } - }, - "iso8859_10": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_10" - } - }, - "iso8859_13": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_13" - } - }, - "iso8859_14": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_14" - } - }, - "iso8859_15": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_15" - } - }, - "iso8859_16": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_16" - } - }, - "johab": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "johab" - } - }, - "koi8_r": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "koi8_r" - } - }, - "koi8_u": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "koi8_u" - } - }, - "mac_cyrillic": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mac_cyrillic" - } - }, - "mac_greek": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mac_greek" - } - }, - "mac_iceland": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mac_iceland" - } - }, - "mac_latin2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mac_latin2" - } - }, - "mac_roman": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mac_roman" - } - }, - "mac_turkish": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mac_turkish" - } - }, - "ptcp154": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ptcp154" - } - }, - "shift_jis": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "shift_jis" - } - }, - "shift_jis_2004": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "shift_jis_2004" - } - }, - "shift_jisx0213": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "shift_jisx0213" - } - }, - "utf_32": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_32" - } - }, - "utf_32_be": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_32_be" - } - }, - "utf_32_le": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_32_le" - } - }, - "utf_16": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_16" - } - }, - "utf_16_be": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_16_be" - } - }, - "utf_16_le": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_16_le" - } - }, - "utf_7": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_7" - } - }, - "utf_8": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_8" - } - }, - "utf_8_sig": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_8_sig" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the encoding of the log file so that the file can be read correctly. \n The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

" - } - }, - "com.amazonaws.opsworks#CloudWatchLogsInitialPosition": { - "type": "enum", - "members": { - "start_of_file": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "start_of_file" - } - }, - "end_of_file": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "end_of_file" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. It's only used if there is no state persisted for that log stream.

" - } - }, - "com.amazonaws.opsworks#CloudWatchLogsLogStream": { - "type": "structure", - "members": { - "LogGroupName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Specifies the destination log group. A log group is created automatically if it doesn't already exist. \n Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), \n '-' (hyphen), '/' (forward slash), and '.' (period).

" - } - }, - "DatetimeFormat": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Specifies how the time stamp is extracted from logs. For more information, see the \n CloudWatch Logs Agent Reference.

" - } - }, - "TimeZone": { - "target": "com.amazonaws.opsworks#CloudWatchLogsTimeZone", - "traits": { - "smithy.api#documentation": "

Specifies the time zone of log event time stamps.

" - } - }, - "File": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Specifies log files that you want to push to CloudWatch Logs.

\n

\n File can point to a specific file or multiple files (by using wild card characters such \n as /var/log/system.log*).\n Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use \n wild card characters to specify a series\n of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on\n by using a pattern like access_log.*. Don't use a wildcard to match multiple file types,\n such as access_log_80 and access_log_443. To specify multiple, different file types, add another\n log stream entry to the configuration file, so that each log file type is stored in a different log group.

\n

Zipped files are not supported.

" - } - }, - "FileFingerprintLines": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, \n such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. \n Fingerprint lines are \n not sent to CloudWatch Logs unless all specified lines are available.

" - } - }, - "MultiLineStartPattern": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Specifies the pattern for identifying the start of a log message.

" - } - }, - "InitialPosition": { - "target": "com.amazonaws.opsworks#CloudWatchLogsInitialPosition", - "traits": { - "smithy.api#documentation": "

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. \n This setting is only used if there is no state persisted for that log stream.

" - } - }, - "Encoding": { - "target": "com.amazonaws.opsworks#CloudWatchLogsEncoding", - "traits": { - "smithy.api#documentation": "

Specifies the encoding of the log file so that the file can be read correctly. \n The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

" - } - }, - "BufferDuration": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.

" - } - }, - "BatchCount": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

Specifies the max number of log events in a batch, up to 10000. The default value is 1000.

" - } - }, - "BatchSize": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. \n The default value is 32768 bytes. This size is calculated as the sum of all event messages \n in UTF-8, plus 26 bytes for each log event.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the CloudWatch Logs configuration for a layer. For detailed information about members of this data type, \n see the CloudWatch Logs Agent Reference.

" - } - }, - "com.amazonaws.opsworks#CloudWatchLogsLogStreams": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#CloudWatchLogsLogStream" - }, - "traits": { - "smithy.api#documentation": "

Describes the Amazon CloudWatch Logs configuration for a layer.

" - } - }, - "com.amazonaws.opsworks#CloudWatchLogsTimeZone": { - "type": "enum", - "members": { - "LOCAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOCAL" - } - }, - "UTC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UTC" - } - } - }, - "traits": { - "smithy.api#documentation": "

The preferred time zone for logs streamed to CloudWatch Logs. \n Valid values are LOCAL and UTC, for Coordinated Universal Time.

" - } - }, - "com.amazonaws.opsworks#Command": { - "type": "structure", - "members": { - "CommandId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The command ID.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the instance where the command was executed.

" - } - }, - "DeploymentId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The command deployment ID.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

Date and time when the command was run.

" - } - }, - "AcknowledgedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

Date and time when the command was acknowledged.

" - } - }, - "CompletedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

Date when the command completed.

" - } - }, - "Status": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The command status:

\n
    \n
  • \n

    failed

    \n
  • \n
  • \n

    successful

    \n
  • \n
  • \n

    skipped

    \n
  • \n
  • \n

    pending

    \n
  • \n
" - } - }, - "ExitCode": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The command exit code.

" - } - }, - "LogUrl": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The URL of the command log.

" - } - }, - "Type": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The command type:

\n
    \n
  • \n

    \n configure\n

    \n
  • \n
  • \n

    \n deploy\n

    \n
  • \n
  • \n

    \n execute_recipes\n

    \n
  • \n
  • \n

    \n install_dependencies\n

    \n
  • \n
  • \n

    \n restart\n

    \n
  • \n
  • \n

    \n rollback\n

    \n
  • \n
  • \n

    \n setup\n

    \n
  • \n
  • \n

    \n start\n

    \n
  • \n
  • \n

    \n stop\n

    \n
  • \n
  • \n

    \n undeploy\n

    \n
  • \n
  • \n

    \n update_custom_cookbooks\n

    \n
  • \n
  • \n

    \n update_dependencies\n

    \n
  • \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a command.

" - } - }, - "com.amazonaws.opsworks#Commands": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#Command" - } - }, - "com.amazonaws.opsworks#CreateApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#CreateAppRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#CreateAppResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an app for a specified stack. For more information, see Creating\n Apps.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#CreateAppRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - }, - "Shortname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app's short name.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app name.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A description of the app.

" - } - }, - "DataSources": { - "target": "com.amazonaws.opsworks#DataSources", - "traits": { - "smithy.api#documentation": "

The app's data source.

" - } - }, - "Type": { - "target": "com.amazonaws.opsworks#AppType", - "traits": { - "smithy.api#documentation": "

The app type. Each supported type is associated with a particular layer. For example, PHP\n applications are associated with a PHP layer. OpsWorks Stacks deploys an application to those instances\n that are members of the corresponding layer. If your app isn't one of the standard types, or\n you prefer to implement your own Deploy recipes, specify other.

", - "smithy.api#required": {} - } - }, - "AppSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

A Source object that specifies the app repository.

" - } - }, - "Domains": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The app virtual host settings, with multiple domains separated by commas. For example:\n 'www.example.com, example.com'\n

" - } - }, - "EnableSsl": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to enable SSL for the app.

" - } - }, - "SslConfiguration": { - "target": "com.amazonaws.opsworks#SslConfiguration", - "traits": { - "smithy.api#documentation": "

An SslConfiguration object with the SSL configuration.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#AppAttributes", - "traits": { - "smithy.api#documentation": "

One or more user-defined key/value pairs to be added to the stack attributes.

" - } - }, - "Environment": { - "target": "com.amazonaws.opsworks#EnvironmentVariables", - "traits": { - "smithy.api#documentation": "

An array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n associated app server instance. For more information, see Environment Variables.

\n

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 20KB).\"

\n \n

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#CreateAppResult": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a CreateApp request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#CreateDeployment": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#CreateDeploymentRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#CreateDeploymentResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Runs deployment or stack commands. For more information, see Deploying\n Apps and Run Stack Commands.

\n

\n Required Permissions: To use this action, an IAM user must have a Deploy or Manage\n permissions level for the stack, or an attached policy that explicitly grants permissions. For\n more information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#CreateDeploymentRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - }, - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID. This parameter is required for app deployments, but not for other deployment commands.

" - } - }, - "InstanceIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The instance IDs for the deployment targets.

" - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The layer IDs for the deployment targets.

" - } - }, - "Command": { - "target": "com.amazonaws.opsworks#DeploymentCommand", - "traits": { - "smithy.api#documentation": "

A DeploymentCommand object that specifies the deployment command and any\n associated arguments.

", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A user-defined comment.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default \n stack configuration JSON values. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes and \n Overriding Attributes With Custom \n JSON.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#CreateDeploymentResult": { - "type": "structure", - "members": { - "DeploymentId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The deployment ID, which can be used with other requests to identify the deployment.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a CreateDeployment request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#CreateInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#CreateInstanceRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#CreateInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an instance in a specified stack. For more information, see Adding an\n Instance to a Layer.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#CreateInstanceRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array that contains the instance's layer IDs.

", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance type, such as t2.micro. For a list of supported instance types,\n open the stack in the console, choose Instances, and choose + Instance.\n The Size list contains the currently supported types. \n For more information, see Instance\n Families and Types. The parameter values that you use to specify the various types are\n in the API Name column of the Available Instance Types table.

", - "smithy.api#required": {} - } - }, - "AutoScalingType": { - "target": "com.amazonaws.opsworks#AutoScalingType", - "traits": { - "smithy.api#documentation": "

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

" - } - }, - "Hostname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance host name. The following are character limits for instance host names.

\n
    \n
  • \n

    Linux-based instances: 63 characters

    \n
  • \n
  • \n

    Windows-based instances: 15 characters

    \n
  • \n
" - } - }, - "Os": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's operating system, which must be set to one of the following.

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, \n Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    \n
  • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
  • \n
  • \n

    \n CentOS Linux 7\n

    \n
  • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
  • \n
  • \n

    A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n\t\t\t Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
  • \n
  • \n

    A custom AMI: Custom.

    \n
  • \n
\n

Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems,\n see OpsWorks Stacks Operating Systems.

\n

The default option is the current Amazon Linux version. If you set this parameter to\n Custom, you must use the CreateInstance action's AmiId parameter to\n specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. \n For more information about how to use custom AMIs with OpsWorks Stacks, see Using\n Custom AMIs.

" - } - }, - "AmiId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A custom AMI ID to be used to create the instance. The AMI should be based on one of the\n supported operating systems.\n For more information, see\n Using Custom AMIs.

\n \n

If you specify a custom AMI, you must set Os to Custom.

\n
" - } - }, - "SshKeyName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's Amazon EC2 key-pair name.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance Availability Zone. For more information, see Regions and Endpoints.

" - } - }, - "VirtualizationType": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's virtualization type, paravirtual or hvm.

" - } - }, - "SubnetId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's \n default subnet ID value and direct OpsWorks Stacks to launch the instance in a different subnet.

" - } - }, - "Architecture": { - "target": "com.amazonaws.opsworks#Architecture", - "traits": { - "smithy.api#documentation": "

The instance architecture. The default option is x86_64. Instance types do not\n necessarily support both architectures. For a list of the architectures that are supported by\n the different instance types, see Instance Families and\n Types.

" - } - }, - "RootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", - "traits": { - "smithy.api#documentation": "

The instance root device type. For more information, see Storage for the Root Device.

" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.opsworks#BlockDeviceMappings", - "traits": { - "smithy.api#documentation": "

An array of BlockDeviceMapping objects that specify the instance's block\n devices. For more information, see Block\n Device Mapping. Note that block device mappings are not supported for custom AMIs.

" - } - }, - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

We strongly recommend using the default value of true to ensure that your\n instances have the latest security updates.

\n
" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to create an Amazon EBS-optimized instance.

" - } - }, - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The default OpsWorks Stacks agent version. You have the following options:

\n
    \n
  • \n

    \n INHERIT - Use the stack's default agent version setting.

    \n
  • \n
  • \n

    \n version_number - Use the specified agent version.\n This value overrides the stack's default setting.\n To update the agent version, edit the instance configuration and specify a\n new version.\n OpsWorks Stacks installs that version on the instance.

    \n
  • \n
\n

The default setting is INHERIT. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. \n AgentVersion cannot be set to Chef 12.2.

" - } - }, - "Tenancy": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, \n inherit tenancy settings from the VPC. The following are valid values for this parameter: \n dedicated, default, or host. Because there are costs associated with changes \n in tenancy options, we recommend that you research tenancy options before choosing them for your instances. \n For more information about dedicated hosts, see \n Dedicated Hosts Overview and \n Amazon EC2 Dedicated Hosts. \n For more information about dedicated instances, see \n Dedicated Instances and \n Amazon EC2 Dedicated Instances.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#CreateInstanceResult": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a CreateInstance request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#CreateLayer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#CreateLayerRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#CreateLayerResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a layer. For more information, see How to\n Create a Layer.

\n \n

You should use CreateLayer for noncustom layer types such as \n PHP App Server only if the stack\n does not have an existing layer of that type. A stack can have at most one instance of each\n noncustom layer; if you attempt to create a second instance, CreateLayer fails. A\n stack can have an arbitrary number of custom layers, so you can call CreateLayer as\n many times as you like for that layer type.

\n
\n

\n Required Permissions: To use this action, an IAM user must \n have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#CreateLayerRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer stack ID.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.opsworks#LayerType", - "traits": { - "smithy.api#documentation": "

The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. \n Built-in layers are not available in Chef 12 stacks.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer name, which is used by the console. Layer names can be a maximum of 32 characters.

", - "smithy.api#required": {} - } - }, - "Shortname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

For custom layers only, use this parameter to specify the layer's short name, which is used internally by \n OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your \n app files are installed. It can have a maximum of 32 characters, which are limited to the alphanumeric \n characters, '-', '_', and '.'.

\n

Built-in layer short names are defined by OpsWorks Stacks. For more information, see the \n Layer Reference.

", - "smithy.api#required": {} - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#LayerAttributes", - "traits": { - "smithy.api#documentation": "

One or more user-defined key-value pairs to be added to the stack attributes.

\n

To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

" - } - }, - "CloudWatchLogsConfiguration": { - "target": "com.amazonaws.opsworks#CloudWatchLogsConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies CloudWatch Logs configuration options for the layer. For more information, \n see CloudWatchLogsLogStream.

" - } - }, - "CustomInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM profile to be used for the layer's EC2 instances. For more information\n about IAM ARNs, see Using Identifiers.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A JSON-formatted string containing custom stack configuration and deployment attributes\n to be installed on the layer's instances. For more information, see\n \n Using Custom JSON. This feature is supported as of version 1.7.42 of the CLI. \n

" - } - }, - "CustomSecurityGroupIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the layer custom security group IDs.

" - } - }, - "Packages": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of Package objects that describes the layer packages.

" - } - }, - "VolumeConfigurations": { - "target": "com.amazonaws.opsworks#VolumeConfigurations", - "traits": { - "smithy.api#documentation": "

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" - } - }, - "EnableAutoHealing": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to disable auto healing for the layer.

" - } - }, - "AutoAssignElasticIps": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to automatically assign an Elastic IP\n address to the layer's instances. For more information, see How to Edit\n a Layer.

" - } - }, - "AutoAssignPublicIps": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

For stacks that are running in a VPC, whether to automatically assign a public IP address to\n the layer's instances. For more information, see How to Edit\n a Layer.

" - } - }, - "CustomRecipes": { - "target": "com.amazonaws.opsworks#Recipes", - "traits": { - "smithy.api#documentation": "

A LayerCustomRecipes object that specifies the layer custom recipes.

" - } - }, - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

To ensure that your\n instances have the latest security updates, we strongly recommend using the default value of true.

\n
" - } - }, - "UseEbsOptimizedInstances": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to use Amazon EBS-optimized instances.

" - } - }, - "LifecycleEventConfiguration": { - "target": "com.amazonaws.opsworks#LifecycleEventConfiguration", - "traits": { - "smithy.api#documentation": "

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to\n specify an execution timeout and enable or disable Elastic Load Balancer connection\n draining.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#CreateLayerResult": { - "type": "structure", - "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a CreateLayer request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#CreateStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#CreateStackRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#CreateStackResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new stack. For more information, see Create a New\n Stack.

\n

\n Required Permissions: To use this action, an IAM user must have an attached policy\n that explicitly grants permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#CreateStackRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack name. Stack names can be a maximum of 64 characters.

", - "smithy.api#required": {} - } - }, - "Region": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's Amazon Web Services Region, such as ap-south-1. For more information about\n Amazon Web Services Regions, see Regions and Endpoints.

\n \n

In the CLI, this API maps to the --stack-region parameter. If the\n --stack-region parameter and the CLI common parameter\n --region are set to the same value, the stack uses a\n regional endpoint. If the --stack-region\n parameter is not set, but the CLI --region parameter is, this also\n results in a stack with a regional endpoint. However, if the\n --region parameter is set to us-east-1, and the\n --stack-region parameter is set to one of the following, then the\n stack uses a legacy or classic region: us-west-1,\n us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1,\n ap-southeast-2. In this case, the actual API endpoint of the stack is in\n us-east-1. Only the preceding regions are supported as classic\n regions in the us-east-1 API endpoint. Because it is a best practice to\n choose the regional endpoint that is closest to where you manage Amazon Web Services, we recommend\n that you use regional endpoints for new stacks. The CLI common\n --region parameter always specifies a regional API endpoint; it\n cannot be used to specify a classic OpsWorks Stacks region.

\n
", - "smithy.api#required": {} - } - }, - "VpcId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched \n into this VPC. You cannot change the ID later.

\n
    \n
  • \n

    If your account supports EC2-Classic, the default value is no VPC.

    \n
  • \n
  • \n

    If your account does not support EC2-Classic, the default value is the default VPC for the specified region.

    \n
  • \n
\n

If the VPC ID corresponds to a default VPC and you have specified either the\n DefaultAvailabilityZone or the DefaultSubnetId parameter only,\n OpsWorks Stacks infers the value of the \n other parameter. If you specify neither parameter, OpsWorks Stacks sets\n these parameters to the first valid Availability Zone for the specified region and the\n corresponding default VPC subnet ID, respectively.

\n

If you specify a nondefault VPC ID, note the following:

\n
    \n
  • \n

    It must belong to a VPC in your account that is in the specified region.

    \n
  • \n
  • \n

    You must specify a value for DefaultSubnetId.

    \n
  • \n
\n

For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a\n VPC. For more information about default VPC and EC2-Classic, see Supported\n Platforms.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#StackAttributes", - "traits": { - "smithy.api#documentation": "

One or more user-defined key-value pairs to be added to the stack attributes.

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services\n resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an\n existing IAM role. For more information about IAM ARNs, see \n Using\n Identifiers.

", - "smithy.api#required": {} - } - }, - "DefaultInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

", - "smithy.api#required": {} - } - }, - "DefaultOs": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default operating system, which is installed on every instance unless you specify a different operating \n system when you create the instance. You can specify one of the following.

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, \n Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    \n
  • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
  • \n
  • \n

    \n CentOS Linux 7\n

    \n
  • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
  • \n
  • \n

    A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, \n Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or \n Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
  • \n
  • \n

    A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more\n information, see \n Using Custom AMIs.

    \n
  • \n
\n

The default option is the current Amazon Linux version.\n Not all operating systems are supported with all versions of Chef. For more information about supported operating systems,\n see OpsWorks Stacks Operating Systems.

" - } - }, - "HostnameTheme": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's host name theme, with spaces replaced by underscores. The theme is used to\n generate host names for the stack's instances. By default, HostnameTheme is set\n to Layer_Dependent, which creates host names by appending integers to the layer's\n short name. The other themes are:

\n
    \n
  • \n

    \n Baked_Goods\n

    \n
  • \n
  • \n

    \n Clouds\n

    \n
  • \n
  • \n

    \n Europe_Cities\n

    \n
  • \n
  • \n

    \n Fruits\n

    \n
  • \n
  • \n

    \n Greek_Deities_and_Titans\n

    \n
  • \n
  • \n

    \n Legendary_creatures_from_Japan\n

    \n
  • \n
  • \n

    \n Planets_and_Moons\n

    \n
  • \n
  • \n

    \n Roman_Deities\n

    \n
  • \n
  • \n

    \n Scottish_Islands\n

    \n
  • \n
  • \n

    \n US_Cities\n

    \n
  • \n
  • \n

    \n Wild_Cats\n

    \n
  • \n
\n

To obtain a generated host name, call GetHostNameSuggestion, which returns a\n host name based on the current theme.

" - } - }, - "DefaultAvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default Availability Zone, which must be in the specified region. For more\n information, see Regions and\n Endpoints. If you also specify a value for DefaultSubnetId, the subnet must\n be in the same zone. For more information, see the VpcId parameter description.\n

" - } - }, - "DefaultSubnetId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default VPC subnet ID. This parameter is required if you specify a value for the\n VpcId parameter. All instances are launched into this subnet unless you specify\n otherwise when you create the instance. If you also specify a value for\n DefaultAvailabilityZone, the subnet must be in that zone. For information on\n default values and when this parameter is required, see the VpcId parameter\n description.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration \n attribute values or to pass data to recipes. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" - } - }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", - "traits": { - "smithy.api#documentation": "

The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the \n Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is \n currently 12.

" - } - }, - "ChefConfiguration": { - "target": "com.amazonaws.opsworks#ChefConfiguration", - "traits": { - "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" - } - }, - "UseCustomCookbooks": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the stack uses custom cookbooks.

" - } - }, - "UseOpsworksSecurityGroups": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

\n

OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. With UseOpsworksSecurityGroups you can instead\n provide your own custom security groups. UseOpsworksSecurityGroups has the\n following settings:

\n
    \n
  • \n

    True - OpsWorks Stacks automatically associates the appropriate built-in security group with each \n layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot \n delete the built-in security group.

    \n
  • \n
  • \n

    False - OpsWorks Stacks does not associate built-in security groups with layers. You must create \n appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still \n manually associate a built-in security group with a layer on creation; custom security groups are required only for those \n layers that need custom settings.

    \n
  • \n
\n

For more information, see Create a New\n Stack.

" - } - }, - "CustomCookbooksSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or \n Cookbooks and Recipes.

" - } - }, - "DefaultSshKeyName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, \n OpsWorks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.

" - } - }, - "DefaultRootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", - "traits": { - "smithy.api#documentation": "

The default root device type. This value is the default for all instances in the stack,\n but you can override it when you create an instance. The default option is\n instance-store. For more information, see Storage for the Root Device.

" - } - }, - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The default OpsWorks Stacks agent version. You have the following options:

\n
    \n
  • \n

    Auto-update - Set this parameter to LATEST. OpsWorks Stacks\n automatically installs new agent versions on the stack's instances as soon as\n they are available.

    \n
  • \n
  • \n

    Fixed version - Set this parameter to your preferred agent version. To update the agent version, \n you must edit the stack configuration and specify a new version. OpsWorks Stacks installs \n that version on the stack's instances.

    \n
  • \n
\n

The default setting is the most recent release of the agent. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

\n \n

You can also specify an agent version when you create or update an instance, \n which overrides the stack's default setting.

\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#CreateStackResult": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID, which is an opaque string that you use to identify the stack when performing\n actions such as DescribeStacks.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a CreateStack request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#CreateUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#CreateUserProfileRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#CreateUserProfileResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new user profile.

\n

\n Required Permissions: To use this action, an IAM user must have an attached policy\n that explicitly grants permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#CreateUserProfileRequest": { - "type": "structure", - "members": { - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN; this can also be a federated user's ARN.

", - "smithy.api#required": {} - } - }, - "SshUsername": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If\n the specified name includes other punctuation marks, OpsWorks Stacks removes them. For example,\n my.name is changed to myname. If you do not specify an SSH\n user name, OpsWorks Stacks generates one from the IAM user name.

" - } - }, - "SshPublicKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's public SSH key.

" - } - }, - "AllowSelfManagement": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether users can specify their own SSH public key through the My Settings page. For more\n information, see Setting an IAM\n User's Public SSH Key.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#CreateUserProfileResult": { - "type": "structure", - "members": { - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a CreateUserProfile request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DailyAutoScalingSchedule": { - "type": "map", - "key": { - "target": "com.amazonaws.opsworks#Hour" - }, - "value": { - "target": "com.amazonaws.opsworks#Switch" - } - }, - "com.amazonaws.opsworks#DataSource": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The data source's type, AutoSelectOpsworksMysqlInstance,\n OpsworksMysqlInstance, RdsDbInstance, or None.

" - } - }, - "Arn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The data source's ARN.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The database name.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an app's data source.

" - } - }, - "com.amazonaws.opsworks#DataSources": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#DataSource" - } - }, - "com.amazonaws.opsworks#DateTime": { - "type": "string" - }, - "com.amazonaws.opsworks#DeleteApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeleteAppRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specified app.

\n

\n Required Permissions: To use this action, an IAM user must have a \n Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeleteAppRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeleteInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeleteInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before \n you can delete it.

\n

For more information, see Deleting\n Instances.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage \n permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeleteInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - }, - "DeleteElasticIp": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to delete the instance Elastic IP address.

" - } - }, - "DeleteVolumes": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to delete the instance's Amazon EBS volumes.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeleteLayer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeleteLayerRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specified layer. You must first stop and then delete all associated instances or\n unassign registered instances. For more information, see How to\n Delete a Layer.

\n

\n Required Permissions: To use this action, an IAM user must have a \n Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeleteLayerRequest": { - "type": "structure", - "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeleteStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeleteStackRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specified stack. You must first delete all instances, layers, and apps or\n deregister registered instances. For more information, see Shut Down a\n Stack.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeleteStackRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeleteUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeleteUserProfileRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a user profile.

\n

\n Required Permissions: To use this action, an IAM user must have an attached \n policy\n that explicitly grants permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeleteUserProfileRequest": { - "type": "structure", - "members": { - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN. This can also be a federated user's ARN.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#Deployment": { - "type": "structure", - "members": { - "DeploymentId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The deployment ID.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

Date when the deployment was created.

" - } - }, - "CompletedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

Date when the deployment completed.

" - } - }, - "Duration": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The deployment duration.

" - } - }, - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN.

" - } - }, - "Comment": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A user-defined comment.

" - } - }, - "Command": { - "target": "com.amazonaws.opsworks#DeploymentCommand", - "traits": { - "smithy.api#documentation": "

Used to specify a stack or deployment command.

" - } - }, - "Status": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The deployment status:

\n
    \n
  • \n

    running

    \n
  • \n
  • \n

    successful

    \n
  • \n
  • \n

    failed

    \n
  • \n
" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration \n attribute values for stack or to pass data to recipes. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information on custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" - } - }, - "InstanceIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The IDs of the target instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a deployment of a stack or app.

" - } - }, - "com.amazonaws.opsworks#DeploymentCommand": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.opsworks#DeploymentCommandName", - "traits": { - "smithy.api#documentation": "

Specifies the operation. You can specify only one command.

\n

For stacks, the following commands are available:

\n
    \n
  • \n

    \n execute_recipes: Execute one or more recipes. To specify the recipes, set an\n Args parameter named recipes to the list of recipes to be\n executed. For example, to execute phpapp::appsetup, set Args to\n {\"recipes\":[\"phpapp::appsetup\"]}.

    \n
  • \n
  • \n

    \n install_dependencies: Install the stack's dependencies.

    \n
  • \n
  • \n

    \n update_custom_cookbooks: Update the stack's custom cookbooks.

    \n
  • \n
  • \n

    \n update_dependencies: Update the stack's dependencies.

    \n
  • \n
\n \n

The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.

\n
\n

For apps, the following commands are available:

\n
    \n
  • \n

    \n deploy: Deploy an app. Ruby on Rails apps have an optional Args\n parameter named migrate. Set Args to {\"migrate\":[\"true\"]} to\n migrate the database. The default setting is {\"migrate\":[\"false\"]}.

    \n
  • \n
  • \n

    \n rollback Roll the app back to the previous version. When you update an app,\n OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this\n command to roll an app back as many as four versions.

    \n
  • \n
  • \n

    \n start: Start the app's web or application server.

    \n
  • \n
  • \n

    \n stop: Stop the app's web or application server.

    \n
  • \n
  • \n

    \n restart: Restart the app's web or application server.

    \n
  • \n
  • \n

    \n undeploy: Undeploy the app.

    \n
  • \n
", - "smithy.api#required": {} - } - }, - "Args": { - "target": "com.amazonaws.opsworks#DeploymentCommandArgs", - "traits": { - "smithy.api#documentation": "

The arguments of those commands that take arguments. It should be set to a JSON object with the following format:

\n

\n {\"arg_name1\" : [\"value1\", \"value2\", ...], \"arg_name2\" : [\"value1\", \"value2\", ...],\n ...}\n

\n

The update_dependencies command takes two arguments:

\n
    \n
  • \n

    \n upgrade_os_to - Specifies the Amazon Linux version that you want instances\n to run, such as Amazon Linux 2. You must also set\n the allow_reboot argument to true.

    \n
  • \n
  • \n

    \n allow_reboot - Specifies whether to allow OpsWorks Stacks to reboot the instances if\n necessary, after installing the updates. This argument can be set to either\n true or false. The default value is false.

    \n
  • \n
\n

For example, to upgrade an instance to Amazon Linux 2018.03, set Args to the\n following.

\n

\n { \"upgrade_os_to\":[\"Amazon Linux 2018.03\"], \"allow_reboot\":[\"true\"] } \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Used to specify a stack or deployment command.

" - } - }, - "com.amazonaws.opsworks#DeploymentCommandArgs": { - "type": "map", - "key": { - "target": "com.amazonaws.opsworks#String" - }, - "value": { - "target": "com.amazonaws.opsworks#Strings" - } - }, - "com.amazonaws.opsworks#DeploymentCommandName": { - "type": "enum", - "members": { - "install_dependencies": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "install_dependencies" - } - }, - "update_dependencies": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "update_dependencies" - } - }, - "update_custom_cookbooks": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "update_custom_cookbooks" - } - }, - "execute_recipes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "execute_recipes" - } - }, - "configure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "configure" - } - }, - "setup": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "setup" - } - }, - "deploy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deploy" - } - }, - "rollback": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rollback" - } - }, - "start": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "start" - } - }, - "stop": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stop" - } - }, - "restart": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "restart" - } - }, - "undeploy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "undeploy" - } - } - } - }, - "com.amazonaws.opsworks#Deployments": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#Deployment" - } - }, - "com.amazonaws.opsworks#DeregisterEcsCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeregisterEcsClusterRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deregisters a specified Amazon ECS cluster from a stack.\n For more information, see\n \n Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see\n https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.

" - } - }, - "com.amazonaws.opsworks#DeregisterEcsClusterRequest": { - "type": "structure", - "members": { - "EcsClusterArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cluster's Amazon Resource Number (ARN).

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeregisterElasticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeregisterElasticIpRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deregisters a specified Elastic IP address. The address can be registered by another\n stack after it is deregistered. For more information, see Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeregisterElasticIpRequest": { - "type": "structure", - "members": { - "ElasticIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeregisterInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeregisterInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deregister an instance from OpsWorks Stacks. The instance can be a registered instance (Amazon EC2 or on-premises) or an instance created with OpsWorks. \n This action removes the instance from the stack and returns it to your control.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeregisterInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeregisterRdsDbInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeregisterRdsDbInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deregisters an Amazon RDS instance.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeregisterRdsDbInstanceRequest": { - "type": "structure", - "members": { - "RdsDbInstanceArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon RDS instance's ARN.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeregisterVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeregisterVolumeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more\n information, see Resource\n Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeregisterVolumeRequest": { - "type": "structure", - "members": { - "VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The OpsWorks Stacks volume ID, which is the GUID that OpsWorks Stacks assigned to the instance \n when you registered the volume with the stack, not the Amazon EC2 volume ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeAgentVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeAgentVersionsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeAgentVersionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the available OpsWorks Stacks agent versions. You must specify a stack ID or a\n configuration manager. DescribeAgentVersions returns a list of available\n agent versions for the specified stack or configuration manager.

" - } - }, - "com.amazonaws.opsworks#DescribeAgentVersionsRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", - "traits": { - "smithy.api#documentation": "

The configuration manager.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeAgentVersionsResult": { - "type": "structure", - "members": { - "AgentVersions": { - "target": "com.amazonaws.opsworks#AgentVersions", - "traits": { - "smithy.api#documentation": "

The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, \n not the abbreviated number used by the console.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeAgentVersions request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeApps": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeAppsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeAppsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Requests a description of a specified set of apps.

\n \n

This call accepts only one resource-identifying parameter.

\n
\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, \n or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

", - "smithy.waiters#waitable": { - "AppExists": { - "acceptors": [ - { - "state": "success", - "matcher": { - "success": true - } - }, - { - "state": "failure", - "matcher": { - "success": false - } - } - ], - "minDelay": 1 - } - } - } - }, - "com.amazonaws.opsworks#DescribeAppsRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app stack ID. If you use this parameter, DescribeApps returns a description\n of the apps in the specified stack.

" - } - }, - "AppIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of app IDs for the apps to be described. If you use this parameter,\n DescribeApps returns a description of the specified apps. Otherwise, it returns\n a description of every app.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeAppsResult": { - "type": "structure", - "members": { - "Apps": { - "target": "com.amazonaws.opsworks#Apps", - "traits": { - "smithy.api#documentation": "

An array of App objects that describe the specified apps.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeApps request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeCommands": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeCommandsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeCommandsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the results of specified commands.

\n \n

This call accepts only one resource-identifying parameter.

\n
\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeCommandsRequest": { - "type": "structure", - "members": { - "DeploymentId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The deployment ID. If you include this parameter, DescribeCommands returns a\n description of the commands associated with the specified deployment.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID. If you include this parameter, DescribeCommands returns a\n description of the commands associated with the specified instance.

" - } - }, - "CommandIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of command IDs. If you include this parameter, DescribeCommands returns\n a description of the specified commands. Otherwise, it returns a description of every\n command.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeCommandsResult": { - "type": "structure", - "members": { - "Commands": { - "target": "com.amazonaws.opsworks#Commands", - "traits": { - "smithy.api#documentation": "

An array of Command objects that describe each of the specified commands.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeCommands request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeDeployments": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeDeploymentsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeDeploymentsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Requests a description of a specified set of deployments.

\n \n

This call accepts only one resource-identifying parameter.

\n
\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

", - "smithy.waiters#waitable": { - "DeploymentSuccessful": { - "documentation": "Wait until a deployment has completed successfully.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Deployments[].Status", - "expected": "successful", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Deployments[].Status", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.opsworks#DescribeDeploymentsRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID. If you include this parameter, the command returns a\n description of the commands associated with the specified stack.

" - } - }, - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID. If you include this parameter, the command returns a\n description of the commands associated with the specified app.

" - } - }, - "DeploymentIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of deployment IDs to be described. If you include this parameter,\n the command returns a description of the specified deployments.\n Otherwise, it returns a description of every deployment.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeDeploymentsResult": { - "type": "structure", - "members": { - "Deployments": { - "target": "com.amazonaws.opsworks#Deployments", - "traits": { - "smithy.api#documentation": "

An array of Deployment objects that describe the deployments.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeDeployments request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeEcsClusters": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeEcsClustersRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeEcsClustersResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID,\n you can use the MaxResults and NextToken parameters to paginate the\n response. However, OpsWorks Stacks currently supports only one cluster per layer, so the result\n set has a maximum of one element.

\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack or an attached policy that explicitly grants\n permission. For more information about user permissions, see Managing User\n Permissions.

\n

This call accepts only one resource-identifying parameter.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "EcsClusters", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.opsworks#DescribeEcsClustersRequest": { - "type": "structure", - "members": { - "EcsClusterArns": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

A list of ARNs, one for each cluster to be described.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A stack ID.\n DescribeEcsClusters returns a description of the cluster that is registered with the stack.

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results,\n the response object'sNextToken parameter value is set to a token.\n To retrieve the next set of results, call DescribeEcsClusters\n again and assign that token to the request object's NextToken parameter.\n If there are no remaining results, the previous response\n object's NextToken parameter is set to null.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

To receive a paginated response, use this parameter to specify the maximum number\n of results to be returned with a single call. If the number of available results exceeds this maximum, the\n response includes a NextToken value that you can assign\n to the NextToken request parameter to get the next set of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeEcsClustersResult": { - "type": "structure", - "members": { - "EcsClusters": { - "target": "com.amazonaws.opsworks#EcsClusters", - "traits": { - "smithy.api#documentation": "

A list of EcsCluster objects containing the cluster descriptions.

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

If a paginated request does not return all of the remaining results, this parameter is set to a token that\n you can assign to the request object's NextToken parameter to retrieve the next set of results.\n If the previous paginated request returned all of the remaining results,\n this parameter is set to null.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeEcsClusters request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeElasticIps": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeElasticIpsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeElasticIpsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes Elastic IP addresses.

\n \n

This call accepts only one resource-identifying parameter.

\n
\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeElasticIpsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID. If you include this parameter, DescribeElasticIps returns a\n description of the Elastic IP addresses associated with the specified instance.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A stack ID. If you include this parameter, DescribeElasticIps returns a\n description of the Elastic IP addresses that are registered with the specified stack.

" - } - }, - "Ips": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of Elastic IP addresses to be described. If you include this parameter,\n DescribeElasticIps returns a description of the specified Elastic IP addresses.\n Otherwise, it returns a description of every Elastic IP address.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeElasticIpsResult": { - "type": "structure", - "members": { - "ElasticIps": { - "target": "com.amazonaws.opsworks#ElasticIps", - "traits": { - "smithy.api#documentation": "

An ElasticIps object that describes the specified Elastic IP addresses.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeElasticIps request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeElasticLoadBalancers": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeElasticLoadBalancersRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeElasticLoadBalancersResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a stack's Elastic Load Balancing instances.

\n \n

This call accepts only one resource-identifying parameter.

\n
\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeElasticLoadBalancersRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A stack ID. The action describes the stack's Elastic Load Balancing instances.

" - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeElasticLoadBalancersResult": { - "type": "structure", - "members": { - "ElasticLoadBalancers": { - "target": "com.amazonaws.opsworks#ElasticLoadBalancers", - "traits": { - "smithy.api#documentation": "

A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing\n instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeElasticLoadBalancers request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeInstancesRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeInstancesResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Requests a description of a set of instances.

\n \n

This call accepts only one resource-identifying parameter.

\n
\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

", - "smithy.waiters#waitable": { - "InstanceOnline": { - "documentation": "Wait until OpsWorks instance is online.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "online", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "setup_failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "shutting_down", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "start_failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stopped", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stopping", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "terminating", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "terminated", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stop_failed", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "InstanceRegistered": { - "documentation": "Wait until OpsWorks instance is registered.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "registered", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "setup_failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "shutting_down", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stopped", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stopping", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "terminating", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "terminated", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stop_failed", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "InstanceStopped": { - "documentation": "Wait until OpsWorks instance is stopped.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stopped", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "booting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "pending", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "rebooting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "requested", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "running_setup", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "setup_failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "start_failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stop_failed", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "InstanceTerminated": { - "documentation": "Wait until OpsWorks instance is terminated.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "terminated", - "comparator": "allStringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "ResourceNotFoundException" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "booting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "online", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "pending", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "rebooting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "requested", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "running_setup", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "setup_failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "start_failed", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.opsworks#DescribeInstancesRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A stack ID. If you use this parameter, DescribeInstances returns descriptions of\n the instances associated with the specified stack.

" - } - }, - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A layer ID. If you use this parameter, DescribeInstances returns descriptions of\n the instances associated with the specified layer.

" - } - }, - "InstanceIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of instance IDs to be described. If you use this parameter,\n DescribeInstances returns a description of the specified instances. Otherwise,\n it returns a description of every instance.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeInstancesResult": { - "type": "structure", - "members": { - "Instances": { - "target": "com.amazonaws.opsworks#Instances", - "traits": { - "smithy.api#documentation": "

An array of Instance objects that describe the instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeInstances request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeLayers": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeLayersRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeLayersResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Requests a description of one or more layers in a specified stack.

\n \n

This call accepts only one resource-identifying parameter.

\n
\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeLayersRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of layer IDs that specify the layers to be described. If you omit this parameter,\n DescribeLayers returns a description of every layer in the specified stack.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeLayersResult": { - "type": "structure", - "members": { - "Layers": { - "target": "com.amazonaws.opsworks#Layers", - "traits": { - "smithy.api#documentation": "

An array of Layer objects that describe the layers.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeLayers request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeLoadBasedAutoScaling": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeLoadBasedAutoScalingRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeLoadBasedAutoScalingResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes load-based auto scaling configurations for specified layers.

\n \n

You must specify at least one of the parameters.

\n
\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeLoadBasedAutoScalingRequest": { - "type": "structure", - "members": { - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of layer IDs.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeLoadBasedAutoScalingResult": { - "type": "structure", - "members": { - "LoadBasedAutoScalingConfigurations": { - "target": "com.amazonaws.opsworks#LoadBasedAutoScalingConfigurations", - "traits": { - "smithy.api#documentation": "

An array of LoadBasedAutoScalingConfiguration objects that describe each layer's\n configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeLoadBasedAutoScaling request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeMyUserProfile": { - "type": "operation", - "input": { - "target": "smithy.api#Unit" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeMyUserProfileResult" - }, - "traits": { - "smithy.api#documentation": "

Describes a user's SSH information.

\n

\n Required Permissions: To use this action, an IAM user must have self-management\n enabled or an attached policy that explicitly grants permissions. For more information about user\n permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeMyUserProfileResult": { - "type": "structure", - "members": { - "UserProfile": { - "target": "com.amazonaws.opsworks#SelfUserProfile", - "traits": { - "smithy.api#documentation": "

A UserProfile object that describes the user's SSH information.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeMyUserProfile request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeOperatingSystems": { - "type": "operation", - "input": { - "target": "smithy.api#Unit" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeOperatingSystemsResponse" - }, - "traits": { - "smithy.api#documentation": "

Describes the operating systems that are supported by OpsWorks Stacks.

" - } - }, - "com.amazonaws.opsworks#DescribeOperatingSystemsResponse": { - "type": "structure", - "members": { - "OperatingSystems": { - "target": "com.amazonaws.opsworks#OperatingSystems", - "traits": { - "smithy.api#documentation": "

Contains information in response to a DescribeOperatingSystems request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The response to a DescribeOperatingSystems request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribePermissionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the permissions for a specified stack.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribePermissionsRequest": { - "type": "structure", - "members": { - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM \n ARNs, see Using\n Identifiers.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribePermissionsResult": { - "type": "structure", - "members": { - "Permissions": { - "target": "com.amazonaws.opsworks#Permissions", - "traits": { - "smithy.api#documentation": "

An array of Permission objects that describe the stack permissions.

\n
    \n
  • \n

    If the request object contains only a stack ID, the array contains a\n Permission object with permissions for each of the stack IAM ARNs.

    \n
  • \n
  • \n

    If the request object contains only an IAM ARN, the array contains a\n Permission object with permissions for each of the user's stack IDs.

    \n
  • \n
  • \n

    If the request contains a stack ID and an IAM ARN, the array contains a single\n Permission object with permissions for the specified stack and IAM ARN.

    \n
  • \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribePermissions request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeRaidArrays": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeRaidArraysRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeRaidArraysResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describe an instance's RAID arrays.

\n \n

This call accepts only one resource-identifying parameter.

\n
\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeRaidArraysRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID. If you use this parameter, DescribeRaidArrays returns\n descriptions of the RAID arrays associated with the specified instance.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "RaidArrayIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of RAID array IDs. If you use this parameter, DescribeRaidArrays\n returns descriptions of the specified arrays. Otherwise, it returns a description of every\n array.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeRaidArraysResult": { - "type": "structure", - "members": { - "RaidArrays": { - "target": "com.amazonaws.opsworks#RaidArrays", - "traits": { - "smithy.api#documentation": "

A RaidArrays object that describes the specified RAID arrays.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeRaidArrays request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeRdsDbInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeRdsDbInstancesRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeRdsDbInstancesResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes Amazon RDS instances.

\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

\n

This call accepts only one resource-identifying parameter.

" - } - }, - "com.amazonaws.opsworks#DescribeRdsDbInstancesRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the stack with which the instances are registered. The operation returns descriptions of all registered \n Amazon RDS instances.

", - "smithy.api#required": {} - } - }, - "RdsDbInstanceArns": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the ARNs of the instances to be described.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeRdsDbInstancesResult": { - "type": "structure", - "members": { - "RdsDbInstances": { - "target": "com.amazonaws.opsworks#RdsDbInstances", - "traits": { - "smithy.api#documentation": "

An a array of RdsDbInstance objects that describe the instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeRdsDbInstances request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeServiceErrors": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeServiceErrorsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeServiceErrorsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes OpsWorks Stacks service errors.

\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

\n

This call accepts only one resource-identifying parameter.

" - } - }, - "com.amazonaws.opsworks#DescribeServiceErrorsRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID. If you use this parameter, DescribeServiceErrors returns\n descriptions of the errors associated with the specified stack.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID. If you use this parameter, DescribeServiceErrors returns\n descriptions of the errors associated with the specified instance.

" - } - }, - "ServiceErrorIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of service error IDs. If you use this parameter, DescribeServiceErrors\n returns descriptions of the specified errors. Otherwise, it returns a description of every\n error.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeServiceErrorsResult": { - "type": "structure", - "members": { - "ServiceErrors": { - "target": "com.amazonaws.opsworks#ServiceErrors", - "traits": { - "smithy.api#documentation": "

An array of ServiceError objects that describe the specified service errors.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeServiceErrors request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeStackProvisioningParameters": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeStackProvisioningParametersRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeStackProvisioningParametersResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Requests a description of a stack's provisioning parameters.

\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeStackProvisioningParametersRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeStackProvisioningParametersResult": { - "type": "structure", - "members": { - "AgentInstallerUrl": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The OpsWorks Stacks agent installer's URL.

" - } - }, - "Parameters": { - "target": "com.amazonaws.opsworks#Parameters", - "traits": { - "smithy.api#documentation": "

An embedded object that contains the provisioning parameters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeStackProvisioningParameters request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeStackSummary": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeStackSummaryRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeStackSummaryResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the number of layers and apps in a specified stack, and the number of instances in\n each state, such as running_setup or online.

\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeStackSummaryRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeStackSummaryResult": { - "type": "structure", - "members": { - "StackSummary": { - "target": "com.amazonaws.opsworks#StackSummary", - "traits": { - "smithy.api#documentation": "

A StackSummary object that contains the results.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeStackSummary request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeStacks": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeStacksRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeStacksResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Requests a description of one or more stacks.

\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeStacksRequest": { - "type": "structure", - "members": { - "StackIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of stack IDs that specify the stacks to be described. If you omit this parameter, and have permissions to get information \n about all stacks, DescribeStacks returns a description of every stack. If the IAM policy that is attached to an IAM \n user limits the DescribeStacks action to specific stack ARNs, this parameter is required, and the user must specify a stack ARN that is allowed by the policy. \n Otherwise, DescribeStacks returns an AccessDenied error.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeStacksResult": { - "type": "structure", - "members": { - "Stacks": { - "target": "com.amazonaws.opsworks#Stacks", - "traits": { - "smithy.api#documentation": "

An array of Stack objects that describe the stacks.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeStacks request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeTimeBasedAutoScaling": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeTimeBasedAutoScalingRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeTimeBasedAutoScalingResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes time-based auto scaling configurations for specified instances.

\n \n

You must specify at least one of the parameters.

\n
\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeTimeBasedAutoScalingRequest": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of instance IDs.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeTimeBasedAutoScalingResult": { - "type": "structure", - "members": { - "TimeBasedAutoScalingConfigurations": { - "target": "com.amazonaws.opsworks#TimeBasedAutoScalingConfigurations", - "traits": { - "smithy.api#documentation": "

An array of TimeBasedAutoScalingConfiguration objects that describe the\n configuration for the specified instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeTimeBasedAutoScaling request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeUserProfiles": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeUserProfilesRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeUserProfilesResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describe specified users.

\n

\n Required Permissions: To use this action, an IAM user must have an attached policy\n that explicitly grants permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeUserProfilesRequest": { - "type": "structure", - "members": { - "IamUserArns": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of IAM or federated user ARNs that identify the users to be described.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeUserProfilesResult": { - "type": "structure", - "members": { - "UserProfiles": { - "target": "com.amazonaws.opsworks#UserProfiles", - "traits": { - "smithy.api#documentation": "

A Users object that describes the specified users.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeUserProfiles request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeVolumes": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeVolumesRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeVolumesResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an instance's Amazon EBS volumes.

\n \n

This call accepts only one resource-identifying parameter.

\n
\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeVolumesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID. If you use this parameter, DescribeVolumes returns descriptions\n of the volumes associated with the specified instance.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A stack ID. The action describes the stack's registered Amazon EBS volumes.

" - } - }, - "RaidArrayId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The RAID array ID. If you use this parameter, DescribeVolumes returns\n descriptions of the volumes associated with the specified RAID array.

" - } - }, - "VolumeIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

Am array of volume IDs. If you use this parameter, DescribeVolumes returns\n descriptions of the specified volumes. Otherwise, it returns a description of every\n volume.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeVolumesResult": { - "type": "structure", - "members": { - "Volumes": { - "target": "com.amazonaws.opsworks#Volumes", - "traits": { - "smithy.api#documentation": "

An array of volume IDs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeVolumes request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DetachElasticLoadBalancer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DetachElasticLoadBalancerRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Detaches a specified Elastic Load Balancing instance from its layer.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage \n permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DetachElasticLoadBalancerRequest": { - "type": "structure", - "members": { - "ElasticLoadBalancerName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic Load Balancing instance's name.

", - "smithy.api#required": {} - } - }, - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the layer that the Elastic Load Balancing instance is attached to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DisassociateElasticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DisassociateElasticIpRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates an Elastic IP address from its instance. The address remains registered with\n the stack. For more information, see Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DisassociateElasticIpRequest": { - "type": "structure", - "members": { - "ElasticIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#Double": { - "type": "double" - }, - "com.amazonaws.opsworks#EbsBlockDevice": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The snapshot ID.

" - } - }, - "Iops": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of I/O operations per second (IOPS) that the volume supports. For more\n information, see EbsBlockDevice.

" - } - }, - "VolumeSize": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The volume size, in GiB. For more information, see EbsBlockDevice.

" - } - }, - "VolumeType": { - "target": "com.amazonaws.opsworks#VolumeType", - "traits": { - "smithy.api#documentation": "

The volume type. gp2 for General Purpose (SSD) volumes, io1 for\n Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

\n

If you specify the io1 volume type, you must also specify a value for the Iops attribute. \n The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. Amazon Web Services uses the default volume size (in GiB) \n specified in the AMI attributes to set IOPS to 50 x (volume size).

" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the volume is deleted on instance termination.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice\n data type.

" - } - }, - "com.amazonaws.opsworks#EcsCluster": { - "type": "structure", - "members": { - "EcsClusterArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cluster's ARN.

" - } - }, - "EcsClusterName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cluster name.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "RegisteredAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

The time and date that the cluster was registered with the stack.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a registered Amazon ECS cluster.

" - } - }, - "com.amazonaws.opsworks#EcsClusters": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#EcsCluster" - } - }, - "com.amazonaws.opsworks#ElasticIp": { - "type": "structure", - "members": { - "Ip": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The IP address.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The name, which can be a maximum of 32 characters.

" - } - }, - "Domain": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The domain.

" - } - }, - "Region": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region. For more information, see Regions and Endpoints.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the instance that the address is attached to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Elastic IP address.

" - } - }, - "com.amazonaws.opsworks#ElasticIps": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#ElasticIp" - } - }, - "com.amazonaws.opsworks#ElasticLoadBalancer": { - "type": "structure", - "members": { - "ElasticLoadBalancerName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic Load Balancing instance name.

" - } - }, - "Region": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's Amazon Web Services Region.

" - } - }, - "DnsName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's public DNS name.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the stack with which the instance is associated.

" - } - }, - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the layer to which the instance is attached.

" - } - }, - "VpcId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The VPC ID.

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

A list of Availability Zones.

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

A list of subnet IDs, if the stack is running in a VPC.

" - } - }, - "Ec2InstanceIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

A list of the EC2 instances for which the Elastic Load Balancing instance is managing traffic.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Elastic Load Balancing instance.

" - } - }, - "com.amazonaws.opsworks#ElasticLoadBalancers": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#ElasticLoadBalancer" - } - }, - "com.amazonaws.opsworks#EnvironmentVariable": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. \n The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

(Optional) The environment variable's value, which can be left empty. If you specify a value, \n it can contain up to 256 characters, which must all be printable.

", - "smithy.api#required": {} - } - }, - "Secure": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

(Optional) Whether the variable's value is returned by the DescribeApps action.\n To hide an environment variable's value, set Secure to true.\n DescribeApps returns *****FILTERED***** instead of the actual\n value. The default value for Secure is false.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents an app's environment variable.

" - } - }, - "com.amazonaws.opsworks#EnvironmentVariables": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#EnvironmentVariable" - } - }, - "com.amazonaws.opsworks#GetHostnameSuggestion": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#GetHostnameSuggestionRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#GetHostnameSuggestionResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a generated host name for the specified layer, based on the current host name theme.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#GetHostnameSuggestionRequest": { - "type": "structure", - "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#GetHostnameSuggestionResult": { - "type": "structure", - "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

" - } - }, - "Hostname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The generated host name.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a GetHostnameSuggestion request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#GrantAccess": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#GrantAccessRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#GrantAccessResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\n

This action can be used only with Windows stacks.

\n
\n

Grants RDP access to a Windows instance for a specified time period.

" - } - }, - "com.amazonaws.opsworks#GrantAccessRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's OpsWorks Stacks ID.

", - "smithy.api#required": {} - } - }, - "ValidForInMinutes": { - "target": "com.amazonaws.opsworks#ValidForInMinutes", - "traits": { - "smithy.api#documentation": "

The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, \n the user will no longer be able to use the credentials to log in. If the user is logged in at the time, they are \n logged out.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#GrantAccessResult": { - "type": "structure", - "members": { - "TemporaryCredential": { - "target": "com.amazonaws.opsworks#TemporaryCredential", - "traits": { - "smithy.api#documentation": "

A TemporaryCredential object that contains the data needed to log in to the\n instance by RDP clients, such as the Microsoft Remote Desktop Connection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a GrantAccess request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#Hour": { - "type": "string" - }, - "com.amazonaws.opsworks#Instance": { - "type": "structure", - "members": { - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The agent version. This parameter is set to INHERIT if\n the instance inherits the default stack setting or to a\n a version number for a fixed agent version.

" - } - }, - "AmiId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A custom AMI ID to be used to create the instance. For more\n information, see Instances\n

" - } - }, - "Architecture": { - "target": "com.amazonaws.opsworks#Architecture", - "traits": { - "smithy.api#documentation": "

The instance architecture: \"i386\" or \"x86_64\".

" - } - }, - "Arn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's Amazon Resource Number (ARN).

" - } - }, - "AutoScalingType": { - "target": "com.amazonaws.opsworks#AutoScalingType", - "traits": { - "smithy.api#documentation": "

For load-based or time-based instances, the type.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance Availability Zone. For more information, see Regions and Endpoints.

" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.opsworks#BlockDeviceMappings", - "traits": { - "smithy.api#documentation": "

An array of BlockDeviceMapping objects that specify the instance's block device\n mappings.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

The time that the instance was created.

" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether this is an Amazon EBS-optimized instance.

" - } - }, - "Ec2InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the associated Amazon EC2 instance.

" - } - }, - "EcsClusterArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

For container instances, the Amazon ECS cluster's ARN.

" - } - }, - "EcsContainerInstanceArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

For container instances, the instance's ARN.

" - } - }, - "ElasticIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance Elastic IP address.

" - } - }, - "Hostname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance host name. The following are character limits for instance host names.

\n
    \n
  • \n

    Linux-based instances: 63 characters

    \n
  • \n
  • \n

    Windows-based instances: 15 characters

    \n
  • \n
" - } - }, - "InfrastructureClass": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

For registered instances, the infrastructure class: ec2 or\n on-premises.

" - } - }, - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. If this value is set to false, you must update\n instances manually by using CreateDeployment to run the\n update_dependencies stack command or\n by manually running yum (Amazon\n Linux) or apt-get (Ubuntu) on the instances.

\n \n

We strongly recommend using the default value of true to ensure that your\n instances have the latest security updates.

\n
" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - }, - "InstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ARN of the instance's IAM profile. For more information about IAM ARNs, \n see Using\n Identifiers.

" - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance type, such as t2.micro.

" - } - }, - "LastServiceErrorId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the last service error. For more information, call\n DescribeServiceErrors.

" - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the instance layer IDs.

" - } - }, - "Os": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's operating system.

" - } - }, - "Platform": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's platform.

" - } - }, - "PrivateDns": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's private DNS name.

" - } - }, - "PrivateIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's private IP address.

" - } - }, - "PublicDns": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance public DNS name.

" - } - }, - "PublicIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance public IP address.

" - } - }, - "RegisteredBy": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

For registered instances, who performed the registration.

" - } - }, - "ReportedAgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's reported OpsWorks Stacks agent version.

" - } - }, - "ReportedOs": { - "target": "com.amazonaws.opsworks#ReportedOs", - "traits": { - "smithy.api#documentation": "

For registered instances, the reported operating system.

" - } - }, - "RootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", - "traits": { - "smithy.api#documentation": "

The instance's root device type. For more information, see Storage for the Root Device.

" - } - }, - "RootDeviceVolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The root device volume ID.

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the instance security group IDs.

" - } - }, - "SshHostDsaKeyFingerprint": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The SSH key's Deep Security Agent (DSA) fingerprint.

" - } - }, - "SshHostRsaKeyFingerprint": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The SSH key's RSA fingerprint.

" - } - }, - "SshKeyName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's Amazon EC2 key-pair name.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "Status": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance status:

\n
    \n
  • \n

    \n booting\n

    \n
  • \n
  • \n

    \n connection_lost\n

    \n
  • \n
  • \n

    \n online\n

    \n
  • \n
  • \n

    \n pending\n

    \n
  • \n
  • \n

    \n rebooting\n

    \n
  • \n
  • \n

    \n requested\n

    \n
  • \n
  • \n

    \n running_setup\n

    \n
  • \n
  • \n

    \n setup_failed\n

    \n
  • \n
  • \n

    \n shutting_down\n

    \n
  • \n
  • \n

    \n start_failed\n

    \n
  • \n
  • \n

    \n stop_failed\n

    \n
  • \n
  • \n

    \n stopped\n

    \n
  • \n
  • \n

    \n stopping\n

    \n
  • \n
  • \n

    \n terminated\n

    \n
  • \n
  • \n

    \n terminating\n

    \n
  • \n
" - } - }, - "SubnetId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's subnet ID; applicable only if the stack is running in a VPC.

" - } - }, - "Tenancy": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's tenancy option, such as dedicated or host.

" - } - }, - "VirtualizationType": { - "target": "com.amazonaws.opsworks#VirtualizationType", - "traits": { - "smithy.api#documentation": "

The instance's virtualization type: paravirtual or hvm.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance.

" - } - }, - "com.amazonaws.opsworks#InstanceIdentity": { - "type": "structure", - "members": { - "Document": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A JSON document that contains the metadata.

" - } - }, - "Signature": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A signature that can be used to verify the document's accuracy and authenticity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata service. For more\n information, see Instance Metadata and User Data.

" - } - }, - "com.amazonaws.opsworks#Instances": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#Instance" - } - }, - "com.amazonaws.opsworks#InstancesCount": { - "type": "structure", - "members": { - "Assigning": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances in the Assigning state.

" - } - }, - "Booting": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with booting status.

" - } - }, - "ConnectionLost": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with connection_lost status.

" - } - }, - "Deregistering": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances in the Deregistering state.

" - } - }, - "Online": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with online status.

" - } - }, - "Pending": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with pending status.

" - } - }, - "Rebooting": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with rebooting status.

" - } - }, - "Registered": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances in the Registered state.

" - } - }, - "Registering": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances in the Registering state.

" - } - }, - "Requested": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with requested status.

" - } - }, - "RunningSetup": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with running_setup status.

" - } - }, - "SetupFailed": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with setup_failed status.

" - } - }, - "ShuttingDown": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with shutting_down status.

" - } - }, - "StartFailed": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with start_failed status.

" - } - }, - "StopFailed": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with stop_failed status.

" - } - }, - "Stopped": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with stopped status.

" - } - }, - "Stopping": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with stopping status.

" - } - }, - "Terminated": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with terminated status.

" - } - }, - "Terminating": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with terminating status.

" - } - }, - "Unassigning": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances in the Unassigning state.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes how many instances a stack has for each status.

" - } - }, - "com.amazonaws.opsworks#Integer": { - "type": "integer" - }, - "com.amazonaws.opsworks#Layer": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of a layer.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer stack ID.

" - } - }, - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

" - } - }, - "Type": { - "target": "com.amazonaws.opsworks#LayerType", - "traits": { - "smithy.api#documentation": "

The layer type.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer name. Layer names can be a maximum of 32 characters.

" - } - }, - "Shortname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer short name.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#LayerAttributes", - "traits": { - "smithy.api#documentation": "

The layer attributes.

\n

For the HaproxyStatsPassword, MysqlRootPassword, and\n GangliaPassword attributes, OpsWorks Stacks returns *****FILTERED*****\n instead of the actual value

\n

For an ECS Cluster layer, OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

" - } - }, - "CloudWatchLogsConfiguration": { - "target": "com.amazonaws.opsworks#CloudWatchLogsConfiguration", - "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch Logs configuration settings for the layer.

" - } - }, - "CustomInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ARN of the default IAM profile to be used for the layer's EC2 instances. For more\n information about IAM ARNs, see Using\n Identifiers.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A JSON formatted string containing the layer's custom stack configuration and deployment attributes.

" - } - }, - "CustomSecurityGroupIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the layer's custom security group IDs.

" - } - }, - "DefaultSecurityGroupNames": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the layer's security group names.

" - } - }, - "Packages": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of Package objects that describe the layer's packages.

" - } - }, - "VolumeConfigurations": { - "target": "com.amazonaws.opsworks#VolumeConfigurations", - "traits": { - "smithy.api#documentation": "

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" - } - }, - "EnableAutoHealing": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether auto healing is disabled for the layer.

" - } - }, - "AutoAssignElasticIps": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to automatically assign an Elastic IP\n address to the layer's instances. For more information, see How to Edit\n a Layer.

" - } - }, - "AutoAssignPublicIps": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

For stacks that are running in a VPC, whether to automatically assign a public IP address to\n the layer's instances. For more information, see How to Edit\n a Layer.

" - } - }, - "DefaultRecipes": { - "target": "com.amazonaws.opsworks#Recipes", - "traits": { - "smithy.api#documentation": "

OpsWorks Stacks supports five lifecycle events: setup, configuration, \n deploy, undeploy, and shutdown.\n For each layer, OpsWorks Stacks runs a set of standard recipes for each event. You can also provide \n custom recipes for any or all layers and events. OpsWorks Stacks runs custom event recipes after the standard \n recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of \n the five events.

\n

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe \n name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the \n dbsetup.rb recipe in the repository's phpapp2 folder.

" - } - }, - "CustomRecipes": { - "target": "com.amazonaws.opsworks#Recipes", - "traits": { - "smithy.api#documentation": "

A LayerCustomRecipes object that specifies the layer's custom recipes.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

Date when the layer was created.

" - } - }, - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. If this value is set to false, you must then update\n your instances manually by using CreateDeployment to run the\n update_dependencies stack command or manually running yum (Amazon\n Linux) or apt-get (Ubuntu) on the instances.

\n \n

We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.

\n
" - } - }, - "UseEbsOptimizedInstances": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the layer uses Amazon EBS-optimized instances.

" - } - }, - "LifecycleEventConfiguration": { - "target": "com.amazonaws.opsworks#LifecycleEventConfiguration", - "traits": { - "smithy.api#documentation": "

A LifeCycleEventConfiguration object that specifies the Shutdown event\n configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a layer.

" - } - }, - "com.amazonaws.opsworks#LayerAttributes": { - "type": "map", - "key": { - "target": "com.amazonaws.opsworks#LayerAttributesKeys" - }, - "value": { - "target": "com.amazonaws.opsworks#String" - } - }, - "com.amazonaws.opsworks#LayerAttributesKeys": { - "type": "enum", - "members": { - "EcsClusterArn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EcsClusterArn" - } - }, - "EnableHaproxyStats": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EnableHaproxyStats" - } - }, - "HaproxyStatsUrl": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HaproxyStatsUrl" - } - }, - "HaproxyStatsUser": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HaproxyStatsUser" - } - }, - "HaproxyStatsPassword": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HaproxyStatsPassword" - } - }, - "HaproxyHealthCheckUrl": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HaproxyHealthCheckUrl" - } - }, - "HaproxyHealthCheckMethod": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HaproxyHealthCheckMethod" - } - }, - "MysqlRootPassword": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MysqlRootPassword" - } - }, - "MysqlRootPasswordUbiquitous": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MysqlRootPasswordUbiquitous" - } - }, - "GangliaUrl": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GangliaUrl" - } - }, - "GangliaUser": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GangliaUser" - } - }, - "GangliaPassword": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GangliaPassword" - } - }, - "MemcachedMemory": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MemcachedMemory" - } - }, - "NodejsVersion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NodejsVersion" - } - }, - "RubyVersion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RubyVersion" - } - }, - "RubygemsVersion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RubygemsVersion" - } - }, - "ManageBundler": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ManageBundler" - } - }, - "BundlerVersion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BundlerVersion" - } - }, - "RailsStack": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RailsStack" - } - }, - "PassengerVersion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PassengerVersion" - } - }, - "Jvm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Jvm" - } - }, - "JvmVersion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JvmVersion" - } - }, - "JvmOptions": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JvmOptions" - } - }, - "JavaAppServer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JavaAppServer" - } - }, - "JavaAppServerVersion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JavaAppServerVersion" - } - } - } - }, - "com.amazonaws.opsworks#LayerType": { - "type": "enum", - "members": { - "aws_flow_ruby": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "aws-flow-ruby" - } - }, - "ecs_cluster": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ecs-cluster" - } - }, - "java_app": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "java-app" - } - }, - "lb": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lb" - } - }, - "web": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "web" - } - }, - "php_app": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "php-app" - } - }, - "rails_app": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rails-app" - } - }, - "nodejs_app": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "nodejs-app" - } - }, - "memcached": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "memcached" - } - }, - "db_master": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-master" - } - }, - "monitoring_master": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "monitoring-master" - } - }, - "custom": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "custom" - } - } - } - }, - "com.amazonaws.opsworks#Layers": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#Layer" - } - }, - "com.amazonaws.opsworks#LifecycleEventConfiguration": { - "type": "structure", - "members": { - "Shutdown": { - "target": "com.amazonaws.opsworks#ShutdownEventConfiguration", - "traits": { - "smithy.api#documentation": "

A ShutdownEventConfiguration object that specifies the Shutdown event\n configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the lifecycle event configuration

" - } - }, - "com.amazonaws.opsworks#ListTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#ListTagsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#ListTagsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of tags that are applied to the specified stack or layer.

" - } - }, - "com.amazonaws.opsworks#ListTagsRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.opsworks#ResourceArn", - "traits": { - "smithy.api#documentation": "

The stack or layer's Amazon Resource Number (ARN).

", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.opsworks#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Do not use. A validation exception occurs if you add a MaxResults parameter to a ListTagsRequest \n call.\n

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworks#NextToken", - "traits": { - "smithy.api#documentation": "

Do not use. A validation exception occurs if you add a NextToken parameter to a ListTagsRequest \n call.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#ListTagsResult": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.opsworks#Tags", - "traits": { - "smithy.api#documentation": "

A set of key-value pairs that contain tag keys and tag values that are attached to a stack or layer.

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworks#NextToken", - "traits": { - "smithy.api#documentation": "

If a paginated request does not return all of the remaining results, this parameter is set to a token that\n you can assign to the request object's NextToken parameter to get the next set of results.\n If the previous paginated request returned all of the remaining results,\n this parameter is set to null.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a ListTags request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#LoadBasedAutoScalingConfiguration": { - "type": "structure", - "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

" - } - }, - "Enable": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether load-based auto scaling is enabled for the layer.

" - } - }, - "UpScaling": { - "target": "com.amazonaws.opsworks#AutoScalingThresholds", - "traits": { - "smithy.api#documentation": "

An AutoScalingThresholds object that describes the upscaling configuration,\n which defines how and when OpsWorks Stacks increases the number of instances.

" - } - }, - "DownScaling": { - "target": "com.amazonaws.opsworks#AutoScalingThresholds", - "traits": { - "smithy.api#documentation": "

An AutoScalingThresholds object that describes the downscaling configuration,\n which defines how and when OpsWorks Stacks reduces the number of instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a layer's load-based auto scaling configuration.

" - } - }, - "com.amazonaws.opsworks#LoadBasedAutoScalingConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#LoadBasedAutoScalingConfiguration" - } - }, - "com.amazonaws.opsworks#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.opsworks#Minute": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.opsworks#NextToken": { - "type": "string" - }, - "com.amazonaws.opsworks#OperatingSystem": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The name of the operating system, such as Amazon Linux 2.

" - } - }, - "Id": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of a supported operating system, such as Amazon Linux 2.

" - } - }, - "Type": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The type of a supported operating system, either Linux or Windows.

" - } - }, - "ConfigurationManagers": { - "target": "com.amazonaws.opsworks#OperatingSystemConfigurationManagers", - "traits": { - "smithy.api#documentation": "

Supported configuration manager name and versions for an OpsWorks Stacks operating system.

" - } - }, - "ReportedName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A short name for the operating system manufacturer.

" - } - }, - "ReportedVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The version of the operating system, including the release and edition, if applicable.

" - } - }, - "Supported": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates that an operating system is not supported for new instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes supported operating systems in OpsWorks Stacks.

" - } - }, - "com.amazonaws.opsworks#OperatingSystemConfigurationManager": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The name of the configuration manager, which is Chef.

" - } - }, - "Version": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The versions of the configuration manager that are supported by an operating system.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A block that contains information about the configuration manager (Chef) and the versions of the \n configuration manager that are supported for an operating system.

" - } - }, - "com.amazonaws.opsworks#OperatingSystemConfigurationManagers": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#OperatingSystemConfigurationManager" - } - }, - "com.amazonaws.opsworks#OperatingSystems": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#OperatingSystem" - } - }, - "com.amazonaws.opsworks#OpsWorks_20130218": { - "type": "service", - "version": "2013-02-18", - "operations": [ - { - "target": "com.amazonaws.opsworks#AssignInstance" - }, - { - "target": "com.amazonaws.opsworks#AssignVolume" - }, - { - "target": "com.amazonaws.opsworks#AssociateElasticIp" - }, - { - "target": "com.amazonaws.opsworks#AttachElasticLoadBalancer" - }, - { - "target": "com.amazonaws.opsworks#CloneStack" - }, - { - "target": "com.amazonaws.opsworks#CreateApp" - }, - { - "target": "com.amazonaws.opsworks#CreateDeployment" - }, - { - "target": "com.amazonaws.opsworks#CreateInstance" - }, - { - "target": "com.amazonaws.opsworks#CreateLayer" - }, - { - "target": "com.amazonaws.opsworks#CreateStack" - }, - { - "target": "com.amazonaws.opsworks#CreateUserProfile" - }, - { - "target": "com.amazonaws.opsworks#DeleteApp" - }, - { - "target": "com.amazonaws.opsworks#DeleteInstance" - }, - { - "target": "com.amazonaws.opsworks#DeleteLayer" - }, - { - "target": "com.amazonaws.opsworks#DeleteStack" - }, - { - "target": "com.amazonaws.opsworks#DeleteUserProfile" - }, - { - "target": "com.amazonaws.opsworks#DeregisterEcsCluster" - }, - { - "target": "com.amazonaws.opsworks#DeregisterElasticIp" - }, - { - "target": "com.amazonaws.opsworks#DeregisterInstance" - }, - { - "target": "com.amazonaws.opsworks#DeregisterRdsDbInstance" - }, - { - "target": "com.amazonaws.opsworks#DeregisterVolume" - }, - { - "target": "com.amazonaws.opsworks#DescribeAgentVersions" - }, - { - "target": "com.amazonaws.opsworks#DescribeApps" - }, - { - "target": "com.amazonaws.opsworks#DescribeCommands" - }, - { - "target": "com.amazonaws.opsworks#DescribeDeployments" - }, - { - "target": "com.amazonaws.opsworks#DescribeEcsClusters" - }, - { - "target": "com.amazonaws.opsworks#DescribeElasticIps" - }, - { - "target": "com.amazonaws.opsworks#DescribeElasticLoadBalancers" - }, - { - "target": "com.amazonaws.opsworks#DescribeInstances" - }, - { - "target": "com.amazonaws.opsworks#DescribeLayers" - }, - { - "target": "com.amazonaws.opsworks#DescribeLoadBasedAutoScaling" - }, - { - "target": "com.amazonaws.opsworks#DescribeMyUserProfile" - }, - { - "target": "com.amazonaws.opsworks#DescribeOperatingSystems" - }, - { - "target": "com.amazonaws.opsworks#DescribePermissions" - }, - { - "target": "com.amazonaws.opsworks#DescribeRaidArrays" - }, - { - "target": "com.amazonaws.opsworks#DescribeRdsDbInstances" - }, - { - "target": "com.amazonaws.opsworks#DescribeServiceErrors" - }, - { - "target": "com.amazonaws.opsworks#DescribeStackProvisioningParameters" - }, - { - "target": "com.amazonaws.opsworks#DescribeStacks" - }, - { - "target": "com.amazonaws.opsworks#DescribeStackSummary" - }, - { - "target": "com.amazonaws.opsworks#DescribeTimeBasedAutoScaling" - }, - { - "target": "com.amazonaws.opsworks#DescribeUserProfiles" - }, - { - "target": "com.amazonaws.opsworks#DescribeVolumes" - }, - { - "target": "com.amazonaws.opsworks#DetachElasticLoadBalancer" - }, - { - "target": "com.amazonaws.opsworks#DisassociateElasticIp" - }, - { - "target": "com.amazonaws.opsworks#GetHostnameSuggestion" - }, - { - "target": "com.amazonaws.opsworks#GrantAccess" - }, - { - "target": "com.amazonaws.opsworks#ListTags" - }, - { - "target": "com.amazonaws.opsworks#RebootInstance" - }, - { - "target": "com.amazonaws.opsworks#RegisterEcsCluster" - }, - { - "target": "com.amazonaws.opsworks#RegisterElasticIp" - }, - { - "target": "com.amazonaws.opsworks#RegisterInstance" - }, - { - "target": "com.amazonaws.opsworks#RegisterRdsDbInstance" - }, - { - "target": "com.amazonaws.opsworks#RegisterVolume" - }, - { - "target": "com.amazonaws.opsworks#SetLoadBasedAutoScaling" - }, - { - "target": "com.amazonaws.opsworks#SetPermission" - }, - { - "target": "com.amazonaws.opsworks#SetTimeBasedAutoScaling" - }, - { - "target": "com.amazonaws.opsworks#StartInstance" - }, - { - "target": "com.amazonaws.opsworks#StartStack" - }, - { - "target": "com.amazonaws.opsworks#StopInstance" - }, - { - "target": "com.amazonaws.opsworks#StopStack" - }, - { - "target": "com.amazonaws.opsworks#TagResource" - }, - { - "target": "com.amazonaws.opsworks#UnassignInstance" - }, - { - "target": "com.amazonaws.opsworks#UnassignVolume" - }, - { - "target": "com.amazonaws.opsworks#UntagResource" - }, - { - "target": "com.amazonaws.opsworks#UpdateApp" - }, - { - "target": "com.amazonaws.opsworks#UpdateElasticIp" - }, - { - "target": "com.amazonaws.opsworks#UpdateInstance" - }, - { - "target": "com.amazonaws.opsworks#UpdateLayer" - }, - { - "target": "com.amazonaws.opsworks#UpdateMyUserProfile" - }, - { - "target": "com.amazonaws.opsworks#UpdateRdsDbInstance" - }, - { - "target": "com.amazonaws.opsworks#UpdateStack" - }, - { - "target": "com.amazonaws.opsworks#UpdateUserProfile" - }, - { - "target": "com.amazonaws.opsworks#UpdateVolume" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "OpsWorks", - "arnNamespace": "opsworks", - "cloudFormationName": "OpsWorks", - "cloudTrailEventSource": "opsworks.amazonaws.com", - "endpointPrefix": "opsworks" - }, - "aws.auth#sigv4": { - "name": "opsworks" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "OpsWorks\n

Welcome to the OpsWorks Stacks API Reference. This guide provides descriptions, syntax, \n and\n usage examples for OpsWorks Stacks actions and data types, including common parameters and error\n codes.

\n

OpsWorks Stacks is an application management service that provides an integrated experience for\n managing the complete application lifecycle. For information about OpsWorks, see the\n OpsWorks information page.

\n

\n SDKs and CLI\n

\n

Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the \n Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:

\n \n

\n Endpoints\n

\n

OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. \n Stacks can only be accessed or managed within the endpoint in which they are created.

\n
    \n
  • \n

    opsworks.us-east-1.amazonaws.com

    \n
  • \n
  • \n

    opsworks.us-east-2.amazonaws.com

    \n
  • \n
  • \n

    opsworks.us-west-1.amazonaws.com

    \n
  • \n
  • \n

    opsworks.us-west-2.amazonaws.com

    \n
  • \n
  • \n

    opsworks.ca-central-1.amazonaws.com (API only; not available in the Amazon Web Services Management Console)

    \n
  • \n
  • \n

    opsworks.eu-west-1.amazonaws.com

    \n
  • \n
  • \n

    opsworks.eu-west-2.amazonaws.com

    \n
  • \n
  • \n

    opsworks.eu-west-3.amazonaws.com

    \n
  • \n
  • \n

    opsworks.eu-central-1.amazonaws.com

    \n
  • \n
  • \n

    opsworks.ap-northeast-1.amazonaws.com

    \n
  • \n
  • \n

    opsworks.ap-northeast-2.amazonaws.com

    \n
  • \n
  • \n

    opsworks.ap-south-1.amazonaws.com

    \n
  • \n
  • \n

    opsworks.ap-southeast-1.amazonaws.com

    \n
  • \n
  • \n

    opsworks.ap-southeast-2.amazonaws.com

    \n
  • \n
  • \n

    opsworks.sa-east-1.amazonaws.com

    \n
  • \n
\n

\n Chef Versions\n

\n

When you call CreateStack, CloneStack, or UpdateStack we recommend you\n use the ConfigurationManager parameter to specify the Chef version.\n The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information,\n see Chef Versions.

\n \n

You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks \n to Chef 12 as soon as possible.

\n
", - "smithy.api#title": "AWS OpsWorks", - "smithy.api#xmlNamespace": { - "uri": "http://opsworks.amazonaws.com/doc/2013-02-18/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://opsworks-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://opsworks-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://opsworks.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://opsworks.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.opsworks#Parameters": { - "type": "map", - "key": { - "target": "com.amazonaws.opsworks#String" - }, - "value": { - "target": "com.amazonaws.opsworks#String" - } - }, - "com.amazonaws.opsworks#Permission": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A stack ID.

" - } - }, - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an Identity and Access Management (IAM) role. For more\n information about IAM ARNs, see Using\n Identifiers.

" - } - }, - "AllowSsh": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the user can use SSH.

" - } - }, - "AllowSudo": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the user can use sudo.

" - } - }, - "Level": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's permission level, which must be the following:

\n
    \n
  • \n

    \n deny\n

    \n
  • \n
  • \n

    \n show\n

    \n
  • \n
  • \n

    \n deploy\n

    \n
  • \n
  • \n

    \n manage\n

    \n
  • \n
  • \n

    \n iam_only\n

    \n
  • \n
\n

For more information on the permissions associated with these levels, see Managing User Permissions\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes stack or user permissions.

" - } - }, - "com.amazonaws.opsworks#Permissions": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#Permission" - } - }, - "com.amazonaws.opsworks#RaidArray": { - "type": "structure", - "members": { - "RaidArrayId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The array ID.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The array name.

" - } - }, - "RaidLevel": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The RAID level.

" - } - }, - "NumberOfDisks": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of disks in the array.

" - } - }, - "Size": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The array's size.

" - } - }, - "Device": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The array's Linux device. For example /dev/mdadm0.

" - } - }, - "MountPoint": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The array's mount point.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The array's Availability Zone. For more information, see Regions and Endpoints.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

When the RAID array was created.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "VolumeType": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume type, standard or PIOPS.

" - } - }, - "Iops": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

For PIOPS volumes, the IOPS per disk.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance's RAID array.

" - } - }, - "com.amazonaws.opsworks#RaidArrays": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#RaidArray" - } - }, - "com.amazonaws.opsworks#RdsDbInstance": { - "type": "structure", - "members": { - "RdsDbInstanceArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's ARN.

" - } - }, - "DbInstanceIdentifier": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The database instance identifier.

" - } - }, - "DbUser": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The master user name.

" - } - }, - "DbPassword": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

" - } - }, - "Region": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's Amazon Web Services Region.

" - } - }, - "Address": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's address.

" - } - }, - "Engine": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's database engine.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the stack with which the instance is registered.

" - } - }, - "MissingOnRds": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Set to true if OpsWorks Stacks is unable to discover the Amazon RDS instance. \n OpsWorks Stacks attempts\n to discover the instance only once. If this value is set to true, you must\n deregister the instance, and then register it again.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon RDS instance.

" - } - }, - "com.amazonaws.opsworks#RdsDbInstances": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#RdsDbInstance" - } - }, - "com.amazonaws.opsworks#RebootInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#RebootInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Reboots a specified instance. For more information, see Starting,\n Stopping, and Rebooting Instances.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#RebootInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#Recipes": { - "type": "structure", - "members": { - "Setup": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of custom recipe names to be run following a setup event.

" - } - }, - "Configure": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of custom recipe names to be run following a configure event.

" - } - }, - "Deploy": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of custom recipe names to be run following a deploy event.

" - } - }, - "Undeploy": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of custom recipe names to be run following a undeploy event.

" - } - }, - "Shutdown": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of custom recipe names to be run following a shutdown event.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

OpsWorks Stacks supports five\n lifecycle events:\n setup, configuration, deploy, undeploy, and shutdown. For\n each layer, OpsWorks Stacks runs a set of standard recipes for each event. In addition, you can provide\n custom recipes for any or all layers and events. OpsWorks Stacks runs custom event recipes after the\n standard recipes. LayerCustomRecipes specifies the custom recipes for a\n particular layer to be run in response to each of the five events.

\n

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, \n which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in \n the repository's phpapp2 folder.

" - } - }, - "com.amazonaws.opsworks#RegisterEcsCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#RegisterEcsClusterRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#RegisterEcsClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Registers a specified Amazon ECS cluster with a stack. You can register only one\n cluster with a stack. A cluster can be registered with only one stack.\n For more information, see\n \n Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see\n \n Managing User Permissions.

" - } - }, - "com.amazonaws.opsworks#RegisterEcsClusterRequest": { - "type": "structure", - "members": { - "EcsClusterArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cluster's ARN.

", - "smithy.api#required": {} - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#RegisterEcsClusterResult": { - "type": "structure", - "members": { - "EcsClusterArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cluster's ARN.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a RegisterEcsCluster request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#RegisterElasticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#RegisterElasticIpRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#RegisterElasticIpResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Registers an Elastic IP address with a specified stack. An address can be registered with\n only one stack at a time. If the address is already registered, you must first deregister it\n by calling DeregisterElasticIp. For more information, see Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#RegisterElasticIpRequest": { - "type": "structure", - "members": { - "ElasticIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#required": {} - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#RegisterElasticIpResult": { - "type": "structure", - "members": { - "ElasticIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic IP address.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a RegisterElasticIp request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#RegisterInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#RegisterInstanceRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#RegisterInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Registers instances that were created outside of OpsWorks Stacks with a specified stack.

\n \n

We do not recommend using this action to register instances. The complete registration\n operation includes two tasks: installing the OpsWorks Stacks agent on the instance, and registering\n the instance with the stack. RegisterInstance handles only the second step. You\n should instead use the CLI register command, which performs the entire\n registration operation. For more information,\n see \n Registering an Instance with an OpsWorks Stacks Stack.

\n
\n

Registered instances have the same requirements as instances that are created by using the CreateInstance \n API. \n For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance \n type. For more information about requirements for instances that you want to register, see \n Preparing the Instance.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#RegisterInstanceRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the stack that the instance is to be registered with.

", - "smithy.api#required": {} - } - }, - "Hostname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's host name. The following are character limits for instance host names.

\n
    \n
  • \n

    Linux-based instances: 63 characters

    \n
  • \n
  • \n

    Windows-based instances: 15 characters

    \n
  • \n
" - } - }, - "PublicIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's public IP address.

" - } - }, - "PrivateIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's private IP address.

" - } - }, - "RsaPublicKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

" - } - }, - "RsaPublicKeyFingerprint": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instances public RSA key fingerprint.

" - } - }, - "InstanceIdentity": { - "target": "com.amazonaws.opsworks#InstanceIdentity", - "traits": { - "smithy.api#documentation": "

An InstanceIdentity object that contains the instance's identity.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#RegisterInstanceResult": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The registered instance's OpsWorks Stacks ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a RegisterInstanceResult request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#RegisterRdsDbInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#RegisterRdsDbInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Registers an Amazon RDS instance with a stack.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#RegisterRdsDbInstanceRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - }, - "RdsDbInstanceArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon RDS instance's ARN.

", - "smithy.api#required": {} - } - }, - "DbUser": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The database's master user name.

", - "smithy.api#required": {} - } - }, - "DbPassword": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The database password.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#RegisterVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#RegisterVolumeRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#RegisterVolumeResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one\n stack at a time. If the volume is already registered, you must first deregister it by calling\n DeregisterVolume. For more information, see Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#RegisterVolumeRequest": { - "type": "structure", - "members": { - "Ec2VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon EBS volume ID.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#RegisterVolumeResult": { - "type": "structure", - "members": { - "VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a RegisterVolume request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#ReportedOs": { - "type": "structure", - "members": { - "Family": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The operating system family.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The operating system name.

" - } - }, - "Version": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The operating system version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A registered instance's reported operating system.

" - } - }, - "com.amazonaws.opsworks#ResourceArn": { - "type": "string" - }, - "com.amazonaws.opsworks#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The exception message.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Indicates that a resource was not found.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.opsworks#RootDeviceType": { - "type": "enum", - "members": { - "ebs": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ebs" - } - }, - "instance_store": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instance-store" - } - } - } - }, - "com.amazonaws.opsworks#SelfUserProfile": { - "type": "structure", - "members": { - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's name.

" - } - }, - "SshUsername": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH user name.

" - } - }, - "SshPublicKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH public key.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a user's SSH information.

" - } - }, - "com.amazonaws.opsworks#ServiceError": { - "type": "structure", - "members": { - "ServiceErrorId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The error ID.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - }, - "Type": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The error type.

" - } - }, - "Message": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A message that describes the error.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

When the error occurred.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an OpsWorks Stacks service error.

" - } - }, - "com.amazonaws.opsworks#ServiceErrors": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#ServiceError" - } - }, - "com.amazonaws.opsworks#SetLoadBasedAutoScaling": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#SetLoadBasedAutoScalingRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Specify the load-based auto scaling configuration for a specified layer. For more\n information, see Managing\n Load with Time-based and Load-based Instances.

\n \n

To use load-based auto scaling, you must create a set of load-based auto scaling instances. \n Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough \n instances to handle the maximum anticipated load.

\n
\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#SetLoadBasedAutoScalingRequest": { - "type": "structure", - "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

", - "smithy.api#required": {} - } - }, - "Enable": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Enables load-based auto scaling for the layer.

" - } - }, - "UpScaling": { - "target": "com.amazonaws.opsworks#AutoScalingThresholds", - "traits": { - "smithy.api#documentation": "

An AutoScalingThresholds object with the upscaling threshold configuration. If\n the load exceeds these thresholds for a specified amount of time, OpsWorks Stacks starts a specified\n number of instances.

" - } - }, - "DownScaling": { - "target": "com.amazonaws.opsworks#AutoScalingThresholds", - "traits": { - "smithy.api#documentation": "

An AutoScalingThresholds object with the downscaling threshold configuration. If\n the load falls below these thresholds for a specified amount of time, OpsWorks Stacks stops a specified\n number of instances.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#SetPermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#SetPermissionRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Specifies a user's permissions. For more information, see \n Security and\n Permissions.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#SetPermissionRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - }, - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN. This can also be a federated user's ARN.

", - "smithy.api#required": {} - } - }, - "AllowSsh": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

The user is allowed to use SSH to communicate with the instance.

" - } - }, - "AllowSudo": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

The user is allowed to use sudo to elevate privileges.

" - } - }, - "Level": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.

\n
    \n
  • \n

    \n deny\n

    \n
  • \n
  • \n

    \n show\n

    \n
  • \n
  • \n

    \n deploy\n

    \n
  • \n
  • \n

    \n manage\n

    \n
  • \n
  • \n

    \n iam_only\n

    \n
  • \n
\n

For more information about the permissions associated with these levels, see Managing User Permissions.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#SetTimeBasedAutoScaling": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#SetTimeBasedAutoScalingRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Specify the time-based auto scaling configuration for a specified instance. For more\n information, see Managing\n Load with Time-based and Load-based Instances.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#SetTimeBasedAutoScalingRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - }, - "AutoScalingSchedule": { - "target": "com.amazonaws.opsworks#WeeklyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

An AutoScalingSchedule with the instance schedule.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#ShutdownEventConfiguration": { - "type": "structure", - "members": { - "ExecutionTimeout": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The time, in seconds, that OpsWorks Stacks waits after triggering a Shutdown event before \n shutting down an instance.

" - } - }, - "DelayUntilElbConnectionsDrained": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Shutdown event configuration.

" - } - }, - "com.amazonaws.opsworks#Source": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.opsworks#SourceType", - "traits": { - "smithy.api#documentation": "

The repository type.

" - } - }, - "Url": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The source URL. The following is an example of an Amazon S3 source \n URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz.

" - } - }, - "Username": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

This parameter depends on the repository type.

\n
    \n
  • \n

    For Amazon S3 bundles, set Username to the appropriate IAM access key\n ID.

    \n
  • \n
  • \n

    For HTTP bundles, Git repositories, and Subversion repositories, set Username\n to the user name.

    \n
  • \n
" - } - }, - "Password": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

When included in a request, the parameter depends on the repository type.

\n
    \n
  • \n

    For Amazon S3 bundles, set Password to the appropriate IAM secret access\n key.

    \n
  • \n
  • \n

    For HTTP bundles and Subversion repositories, set Password to the\n password.

    \n
  • \n
\n

For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.

\n

In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

" - } - }, - "SshKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

In requests, the repository's SSH key.

\n

In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

" - } - }, - "Revision": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. \n One of the simplest approaches is to have branches or revisions in your repository that represent different \n versions that can potentially be deployed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more\n information, see Creating Apps or Custom Recipes and\n Cookbooks.

" - } - }, - "com.amazonaws.opsworks#SourceType": { - "type": "enum", - "members": { - "git": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "git" - } - }, - "svn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "svn" - } - }, - "archive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "archive" - } - }, - "s3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "s3" - } - } - } - }, - "com.amazonaws.opsworks#SslConfiguration": { - "type": "structure", - "members": { - "Certificate": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The contents of the certificate's domain.crt file.

", - "smithy.api#required": {} - } - }, - "PrivateKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The private key; the contents of the certificate's domain.kex file.

", - "smithy.api#required": {} - } - }, - "Chain": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Optional. Can be used to specify an intermediate certificate authority key or client authentication.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an app's SSL configuration.

" - } - }, - "com.amazonaws.opsworks#Stack": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack name. Stack names can be a maximum of 64 characters.

" - } - }, - "Arn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's ARN.

" - } - }, - "Region": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack Amazon Web Services Region, such as ap-northeast-2. For more information about \n Amazon Web Services Regions, see Regions and Endpoints.

" - } - }, - "VpcId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The VPC ID; applicable only if the stack is running in a VPC.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#StackAttributes", - "traits": { - "smithy.api#documentation": "

The stack's attributes.

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack Identity and Access Management (IAM) role.

" - } - }, - "DefaultInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

" - } - }, - "DefaultOs": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default operating system.

" - } - }, - "HostnameTheme": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack host name theme, with spaces replaced by underscores.

" - } - }, - "DefaultAvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default Availability Zone. For more information, see Regions and Endpoints.

" - } - }, - "DefaultSubnetId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The default subnet ID; applicable only if the stack is running in a VPC.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. \n You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. \n The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information on custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" - } - }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", - "traits": { - "smithy.api#documentation": "

The configuration manager.

" - } - }, - "ChefConfiguration": { - "target": "com.amazonaws.opsworks#ChefConfiguration", - "traits": { - "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version. For more information, see Create a New Stack.

" - } - }, - "UseCustomCookbooks": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the stack uses custom cookbooks.

" - } - }, - "UseOpsworksSecurityGroups": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the stack automatically associates the OpsWorks Stacks built-in security groups with the stack's layers.

" - } - }, - "CustomCookbooksSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or \n Cookbooks and Recipes.

" - } - }, - "DefaultSshKeyName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or \n update an instance.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

The date when the stack was created.

" - } - }, - "DefaultRootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", - "traits": { - "smithy.api#documentation": "

The default root device type. This value is used by default for all instances in the stack,\n but you can override it when you create an instance. For more information, see Storage for the Root Device.\n

" - } - }, - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The agent version. This parameter is set to LATEST for auto-update.\n or a version number for a fixed agent version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a stack.

" - } - }, - "com.amazonaws.opsworks#StackAttributes": { - "type": "map", - "key": { - "target": "com.amazonaws.opsworks#StackAttributesKeys" - }, - "value": { - "target": "com.amazonaws.opsworks#String" - } - }, - "com.amazonaws.opsworks#StackAttributesKeys": { - "type": "enum", - "members": { - "Color": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Color" - } - } - } - }, - "com.amazonaws.opsworks#StackConfigurationManager": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The name. This parameter must be set to Chef.

" - } - }, - "Version": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. \n The default value for Linux stacks is 12.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configuration manager.

" - } - }, - "com.amazonaws.opsworks#StackSummary": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack name.

" - } - }, - "Arn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's ARN.

" - } - }, - "LayersCount": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of layers.

" - } - }, - "AppsCount": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of apps.

" - } - }, - "InstancesCount": { - "target": "com.amazonaws.opsworks#InstancesCount", - "traits": { - "smithy.api#documentation": "

An InstancesCount object with the number of instances in each status.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Summarizes the number of layers, instances, and apps in a stack.

" - } - }, - "com.amazonaws.opsworks#Stacks": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#Stack" - } - }, - "com.amazonaws.opsworks#StartInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#StartInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a specified instance. For more information, see Starting,\n Stopping, and Rebooting Instances.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#StartInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#StartStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#StartStackRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a stack's instances.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#StartStackRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#StopInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#StopInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a specified instance. When you stop a standard instance, the data disappears and must\n be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without\n losing data. For more information, see Starting,\n Stopping, and Rebooting Instances.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#StopInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - }, - "Force": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether to force an instance to stop. If the instance's root device type is ebs, or EBS-backed, \n adding the Force parameter to the StopInstances API call disassociates the OpsWorks Stacks \n instance from EC2, and forces deletion of only the OpsWorks Stacks instance. \n You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the OpsWorks Stacks \n instance with a new one.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#StopStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#StopStackRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a specified stack.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#StopStackRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#String": { - "type": "string" - }, - "com.amazonaws.opsworks#Strings": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#String" - } - }, - "com.amazonaws.opsworks#Switch": { - "type": "string" - }, - "com.amazonaws.opsworks#TagKey": { - "type": "string" - }, - "com.amazonaws.opsworks#TagKeys": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#TagKey" - } - }, - "com.amazonaws.opsworks#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#TagResourceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks. For more information about how \n tagging works, see Tags in the OpsWorks User Guide.

" - } - }, - "com.amazonaws.opsworks#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.opsworks#ResourceArn", - "traits": { - "smithy.api#documentation": "

The stack or layer's Amazon Resource Number (ARN).

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.opsworks#Tags", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to a stack or layer.

\n
    \n
  • \n

    The key cannot be empty.

    \n
  • \n
  • \n

    The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, \n or the following special characters: + - = . _ : /\n

    \n
  • \n
  • \n

    The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, \n or the following special characters: + - = . _ : /\n

    \n
  • \n
  • \n

    Leading and trailing white spaces are trimmed from both the key and value.

    \n
  • \n
  • \n

    A maximum of 40 tags is allowed for any resource.

    \n
  • \n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#TagValue": { - "type": "string" - }, - "com.amazonaws.opsworks#Tags": { - "type": "map", - "key": { - "target": "com.amazonaws.opsworks#TagKey" - }, - "value": { - "target": "com.amazonaws.opsworks#TagValue" - } - }, - "com.amazonaws.opsworks#TemporaryCredential": { - "type": "structure", - "members": { - "Username": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user name.

" - } - }, - "Password": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The password.

" - } - }, - "ValidForInMinutes": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, \n the user will no longer be able to use the credentials to log in. If they are logged in at the time, they are \n automatically logged out.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's OpsWorks Stacks ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the data needed by RDP clients such as the Microsoft Remote Desktop Connection to log in to the instance.

" - } - }, - "com.amazonaws.opsworks#TimeBasedAutoScalingConfiguration": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - }, - "AutoScalingSchedule": { - "target": "com.amazonaws.opsworks#WeeklyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

A WeeklyAutoScalingSchedule object with the instance schedule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance's time-based auto scaling configuration.

" - } - }, - "com.amazonaws.opsworks#TimeBasedAutoScalingConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#TimeBasedAutoScalingConfiguration" - } - }, - "com.amazonaws.opsworks#UnassignInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UnassignInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Unassigns a registered instance from all layers that are using the instance. \n The instance remains in the stack as an unassigned instance, and can be assigned to \n another layer as needed. You cannot use this action with instances that were created \n with OpsWorks Stacks.

\n

\n Required Permissions: To use this action, an IAM user must \n have a Manage permissions level for the stack or an attached policy that explicitly \n grants permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UnassignInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UnassignVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UnassignVolumeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more\n information, see Resource\n Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UnassignVolumeRequest": { - "type": "structure", - "members": { - "VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UntagResourceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes tags from a specified stack or layer.

" - } - }, - "com.amazonaws.opsworks#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.opsworks#ResourceArn", - "traits": { - "smithy.api#documentation": "

The stack or layer's Amazon Resource Number (ARN).

", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.opsworks#TagKeys", - "traits": { - "smithy.api#documentation": "

A list of the keys of tags to be removed from a stack or layer.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateAppRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a specified app.

\n

\n Required Permissions: To use this action, an IAM user must have a Deploy or Manage\n permissions level for the stack, or an attached policy that explicitly grants permissions. For\n more information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateAppRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app name.

" - } - }, - "Description": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A description of the app.

" - } - }, - "DataSources": { - "target": "com.amazonaws.opsworks#DataSources", - "traits": { - "smithy.api#documentation": "

The app's data sources.

" - } - }, - "Type": { - "target": "com.amazonaws.opsworks#AppType", - "traits": { - "smithy.api#documentation": "

The app type.

" - } - }, - "AppSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

A Source object that specifies the app repository.

" - } - }, - "Domains": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The app's virtual host settings, with multiple domains separated by commas. For example:\n 'www.example.com, example.com'\n

" - } - }, - "EnableSsl": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether SSL is enabled for the app.

" - } - }, - "SslConfiguration": { - "target": "com.amazonaws.opsworks#SslConfiguration", - "traits": { - "smithy.api#documentation": "

An SslConfiguration object with the SSL configuration.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#AppAttributes", - "traits": { - "smithy.api#documentation": "

One or more user-defined key/value pairs to be added to the stack attributes.

" - } - }, - "Environment": { - "target": "com.amazonaws.opsworks#EnvironmentVariables", - "traits": { - "smithy.api#documentation": "

An array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n associated app server instances.For more information, see Environment Variables.

\n

There is no specific limit on the number of environment variables. However, the size of the associated data structure - \n which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most \n if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 20 KB).\"

\n \n

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateElasticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateElasticIpRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a registered Elastic IP address's name. For more information, see Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateElasticIpRequest": { - "type": "structure", - "members": { - "ElasticIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The IP address for which you want to update the name.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The new name, which can be a maximum of 32 characters.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a specified instance.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The instance's layer IDs.

" - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance type, such as t2.micro. For a list of supported instance types,\n open the stack in the console, choose Instances, and choose + Instance.\n The Size list contains the currently supported types. For more information, see Instance\n Families and Types. The parameter values that you use to specify the various types are\n in the API Name column of the Available Instance Types table.

" - } - }, - "AutoScalingType": { - "target": "com.amazonaws.opsworks#AutoScalingType", - "traits": { - "smithy.api#documentation": "

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

" - } - }, - "Hostname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance host name. The following are character limits for instance host names.

\n
    \n
  • \n

    Linux-based instances: 63 characters

    \n
  • \n
  • \n

    Windows-based instances: 15 characters

    \n
  • \n
" - } - }, - "Os": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's operating system, which must be set to one of the following. You cannot update an instance that is using \n a custom AMI.

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux\n 2015.03.

    \n
  • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
  • \n
  • \n

    \n CentOS Linux 7\n

    \n
  • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
  • \n
  • \n

    A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
  • \n
\n

Not all operating systems are supported with all versions of Chef. For more information about supported operating systems,\n see OpsWorks Stacks Operating Systems.

\n

The default option is the current Amazon Linux version. If you set this parameter to\n Custom, you must use the AmiId parameter to\n specify the custom AMI that you want to use. For more information about how to use custom AMIs with OpsWorks, see Using\n Custom AMIs.

\n \n

You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.

\n
" - } - }, - "AmiId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the \n instance is already using. \n You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using \n custom AMIs.\n

" - } - }, - "SshKeyName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's Amazon EC2 key name.

" - } - }, - "Architecture": { - "target": "com.amazonaws.opsworks#Architecture", - "traits": { - "smithy.api#documentation": "

The instance architecture. Instance types do not necessarily support both architectures. For\n a list of the architectures that are supported by the different instance types, see Instance\n Families and Types.

" - } - }, - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.

\n
" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

This property cannot be updated.

" - } - }, - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The default OpsWorks Stacks agent version. You have the following options:

\n
    \n
  • \n

    \n INHERIT - Use the stack's default agent version setting.

    \n
  • \n
  • \n

    \n version_number - Use the specified agent version.\n This value overrides the stack's default setting.\n To update the agent version, you must edit the instance configuration and specify a\n new version.\n OpsWorks Stacks installs that version on the instance.

    \n
  • \n
\n

The default setting is INHERIT. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions.

\n

AgentVersion cannot be set to Chef 12.2.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateLayer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateLayerRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a specified layer.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateLayerRequest": { - "type": "structure", - "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer name, which is used by the console. Layer names can be a maximum of 32 characters.

" - } - }, - "Shortname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

For custom layers only, use this parameter to specify the layer's short name, which is used internally by \n OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files \n are installed. It can have a maximum of 32 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/.

\n

Built-in layer short names are defined by OpsWorks Stacks. For more information, see the \n Layer reference in the OpsWorks User Guide.\n

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#LayerAttributes", - "traits": { - "smithy.api#documentation": "

One or more user-defined key/value pairs to be added to the stack attributes.

" - } - }, - "CloudWatchLogsConfiguration": { - "target": "com.amazonaws.opsworks#CloudWatchLogsConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies CloudWatch Logs configuration options for the layer. For more information, \n see CloudWatchLogsLogStream.

" - } - }, - "CustomInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more\n information about IAM ARNs, see Using\n Identifiers.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A JSON-formatted string containing custom stack configuration and deployment attributes\n to be installed on the layer's instances. For more information, see\n \n Using Custom JSON.\n

" - } - }, - "CustomSecurityGroupIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the layer's custom security group IDs.

" - } - }, - "Packages": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of Package objects that describe the layer's packages.

" - } - }, - "VolumeConfigurations": { - "target": "com.amazonaws.opsworks#VolumeConfigurations", - "traits": { - "smithy.api#documentation": "

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" - } - }, - "EnableAutoHealing": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to disable auto healing for the layer.

" - } - }, - "AutoAssignElasticIps": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to automatically assign an Elastic IP\n address to the layer's instances. For more information, see How to Edit\n a Layer.

" - } - }, - "AutoAssignPublicIps": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

For stacks that are running in a VPC, whether to automatically assign a public IP address to\n the layer's instances. For more information, see How to Edit\n a Layer.

" - } - }, - "CustomRecipes": { - "target": "com.amazonaws.opsworks#Recipes", - "traits": { - "smithy.api#documentation": "

A LayerCustomRecipes object that specifies the layer's custom recipes.

" - } - }, - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.

\n
" - } - }, - "UseEbsOptimizedInstances": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to use Amazon EBS-optimized instances.

" - } - }, - "LifecycleEventConfiguration": { - "target": "com.amazonaws.opsworks#LifecycleEventConfiguration", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateMyUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateMyUserProfileRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a user's SSH public key.

\n

\n Required Permissions: To use this action, an IAM user must have self-management\n enabled or an attached policy that explicitly grants permissions. For more information about user\n permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateMyUserProfileRequest": { - "type": "structure", - "members": { - "SshPublicKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH public key.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateRdsDbInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateRdsDbInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an Amazon RDS instance.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateRdsDbInstanceRequest": { - "type": "structure", - "members": { - "RdsDbInstanceArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon RDS instance's ARN.

", - "smithy.api#required": {} - } - }, - "DbUser": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The master user name.

" - } - }, - "DbPassword": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The database password.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateStackRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a specified stack.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateStackRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's new name. Stack names can be a maximum of 64 characters.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#StackAttributes", - "traits": { - "smithy.api#documentation": "

One or more user-defined key-value pairs to be added to the stack attributes.

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Do not use this parameter. You cannot update a stack's service role.

" - } - }, - "DefaultInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

" - } - }, - "DefaultOs": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's operating system, which must be set to one of the following:

\n
    \n
  • \n

    A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, \n Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    \n
  • \n
  • \n

    A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    \n
  • \n
  • \n

    \n CentOS Linux 7\n

    \n
  • \n
  • \n

    \n Red Hat Enterprise Linux 7\n

    \n
  • \n
  • \n

    A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, \n Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    \n
  • \n
  • \n

    A custom AMI: Custom. You specify the custom AMI you want to use when\n you create instances. For more information about how to use custom AMIs with OpsWorks, see Using\n Custom AMIs.

    \n
  • \n
\n

The default option is the stack's current operating system.\n Not all operating systems are supported with all versions of Chef. For more information about supported operating systems,\n see OpsWorks Stacks Operating Systems.

" - } - }, - "HostnameTheme": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's new host name theme, with spaces replaced by underscores.\n The theme is used to generate host names for the stack's instances.\n By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to \n the\n layer's short name. The other themes are:

\n
    \n
  • \n

    \n Baked_Goods\n

    \n
  • \n
  • \n

    \n Clouds\n

    \n
  • \n
  • \n

    \n Europe_Cities\n

    \n
  • \n
  • \n

    \n Fruits\n

    \n
  • \n
  • \n

    \n Greek_Deities_and_Titans\n

    \n
  • \n
  • \n

    \n Legendary_creatures_from_Japan\n

    \n
  • \n
  • \n

    \n Planets_and_Moons\n

    \n
  • \n
  • \n

    \n Roman_Deities\n

    \n
  • \n
  • \n

    \n Scottish_Islands\n

    \n
  • \n
  • \n

    \n US_Cities\n

    \n
  • \n
  • \n

    \n Wild_Cats\n

    \n
  • \n
\n

To obtain a generated host name, call GetHostNameSuggestion, which returns a\n host name based on the current theme.

" - } - }, - "DefaultAvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default Availability Zone, which must be in the\n stack's region. For more\n information, see Regions and\n Endpoints. If you also specify a value for DefaultSubnetId, the subnet must\n be in the same zone. For more information, see CreateStack.

" - } - }, - "DefaultSubnetId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default VPC subnet ID. This parameter is required if you specify a value for the\n VpcId parameter. All instances are launched into this subnet unless you specify\n otherwise when you create the instance. If you also specify a value for\n DefaultAvailabilityZone, the subnet must be in that zone. For information on\n default values and when this parameter is required, see the VpcId parameter\n description.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration \n JSON values or to pass data to recipes. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" - } - }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", - "traits": { - "smithy.api#documentation": "

The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the \n Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

" - } - }, - "ChefConfiguration": { - "target": "com.amazonaws.opsworks#ChefConfiguration", - "traits": { - "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" - } - }, - "UseCustomCookbooks": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the stack uses custom cookbooks.

" - } - }, - "CustomCookbooksSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or \n Cookbooks and Recipes.

" - } - }, - "DefaultSshKeyName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A default Amazon EC2 key-pair name. The default value is\n none. If you specify a key-pair name,\n OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.

" - } - }, - "DefaultRootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", - "traits": { - "smithy.api#documentation": "

The default root device type. This value is used by default for all instances in the stack,\n but you can override it when you create an instance. For more information, see Storage for the Root Device.

" - } - }, - "UseOpsworksSecurityGroups": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

\n

OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. UseOpsworksSecurityGroups allows you to\n provide your own custom security groups\n instead of using the built-in groups. UseOpsworksSecurityGroups has\n the following settings:

\n
    \n
  • \n

    True - OpsWorks Stacks automatically associates the appropriate built-in security group with each \n layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot \n delete the built-in security group.

    \n
  • \n
  • \n

    False - OpsWorks Stacks does not associate built-in security groups with layers. You must create \n appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still \n manually associate a built-in security group with a layer on. Custom security groups are required only for those layers \n that need custom settings.

    \n
  • \n
\n

For more information, see Create a New\n Stack.

" - } - }, - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The default OpsWorks Stacks agent version. You have the following options:

\n
    \n
  • \n

    Auto-update - Set this parameter to LATEST. OpsWorks Stacks\n automatically installs new agent versions on the stack's instances as soon as\n they are available.

    \n
  • \n
  • \n

    Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must \n edit the stack configuration and specify a new version. OpsWorks Stacks installs that version \n on the stack's instances.

    \n
  • \n
\n

The default setting is LATEST. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. \n AgentVersion cannot be set to Chef 12.2.

\n \n

You can also specify an agent version when you create or update an instance, which overrides the stack's default \n setting.

\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateUserProfileRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a specified user profile.

\n

\n Required Permissions: To use this action, an IAM user must have an attached policy\n that explicitly grants permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateUserProfileRequest": { - "type": "structure", - "members": { - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user IAM ARN. This can also be a federated user's ARN.

", - "smithy.api#required": {} - } - }, - "SshUsername": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If\n the specified name includes other punctuation marks, OpsWorks Stacks removes them. For example,\n my.name will be changed to myname. If you do not specify an SSH\n user name, OpsWorks Stacks generates one from the IAM user name.

" - } - }, - "SshPublicKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's new SSH public key.

" - } - }, - "AllowSelfManagement": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether users can specify their own SSH public key through the My Settings page. For more\n information, see Managing User\n Permissions.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateVolumeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an Amazon EBS volume's name or mount point. For more information, see \n Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateVolumeRequest": { - "type": "structure", - "members": { - "VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume ID.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The new name. Volume names can be a maximum of 128 characters.

" - } - }, - "MountPoint": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The new mount point.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UserProfile": { - "type": "structure", - "members": { - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's name.

" - } - }, - "SshUsername": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH user name.

" - } - }, - "SshPublicKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH public key.

" - } - }, - "AllowSelfManagement": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether users can specify their own SSH public key through the My Settings page. For more\n information, see Managing User\n Permissions.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a user's SSH information.

" - } - }, - "com.amazonaws.opsworks#UserProfiles": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#UserProfile" - } - }, - "com.amazonaws.opsworks#ValidForInMinutes": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 60, - "max": 1440 - } - } - }, - "com.amazonaws.opsworks#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The exception message.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Indicates that a request was not valid.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.opsworks#VirtualizationType": { - "type": "enum", - "members": { - "paravirtual": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "paravirtual" - } - }, - "hvm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hvm" - } - } - } - }, - "com.amazonaws.opsworks#Volume": { - "type": "structure", - "members": { - "VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume ID.

" - } - }, - "Ec2VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 volume ID.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume name. Volume names are a maximum of 128 characters.

" - } - }, - "RaidArrayId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The RAID array ID.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - }, - "Status": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The value returned by DescribeVolumes.

" - } - }, - "Size": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The volume size.

" - } - }, - "Device": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The device name.

" - } - }, - "MountPoint": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume mount point. For example, \"/mnt/disk1\".

" - } - }, - "Region": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region. For more information about Amazon Web Services Regions, see \n Regions and Endpoints.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume Availability Zone. For more information, see Regions and Endpoints.

" - } - }, - "VolumeType": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume type. For more information, see \n Amazon EBS Volume Types.

\n
    \n
  • \n

    \n standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.

    \n
  • \n
  • \n

    \n io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.

    \n
  • \n
  • \n

    \n gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size \n of 16384 GiB.

    \n
  • \n
  • \n

    \n st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a \n minimum size of 125 GiB and a maximum size of 16384 GiB.

    \n
  • \n
  • \n

    \n sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB.

    \n
  • \n
" - } - }, - "Iops": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

For PIOPS volumes, the IOPS per disk.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether an Amazon EBS volume is encrypted. For more information, \n see Amazon EBS Encryption.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance's Amazon EBS volume.

" - } - }, - "com.amazonaws.opsworks#VolumeConfiguration": { - "type": "structure", - "members": { - "MountPoint": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume mount point. For example \"/dev/sdh\".

", - "smithy.api#required": {} - } - }, - "RaidLevel": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The volume RAID level.

" - } - }, - "NumberOfDisks": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of disks in the volume.

", - "smithy.api#required": {} - } - }, - "Size": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The volume size.

", - "smithy.api#required": {} - } - }, - "VolumeType": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume type. For more information, see \n Amazon EBS Volume Types.

\n
    \n
  • \n

    \n standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.

    \n
  • \n
  • \n

    \n io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.

    \n
  • \n
  • \n

    \n gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size \n of 16384 GiB.

    \n
  • \n
  • \n

    \n st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a \n minimum size of 125 GiB and a maximum size of 16384 GiB.

    \n
  • \n
  • \n

    \n sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB.

    \n
  • \n
" - } - }, - "Iops": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

For PIOPS volumes, the IOPS per disk.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether an Amazon EBS volume is encrypted. For more information, \n see Amazon EBS Encryption.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon EBS volume configuration.

" - } - }, - "com.amazonaws.opsworks#VolumeConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#VolumeConfiguration" - } - }, - "com.amazonaws.opsworks#VolumeType": { - "type": "enum", - "members": { - "gp2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gp2" - } - }, - "io1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "io1" - } - }, - "standard": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "standard" - } - } - } - }, - "com.amazonaws.opsworks#Volumes": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#Volume" - } - }, - "com.amazonaws.opsworks#WeeklyAutoScalingSchedule": { - "type": "structure", - "members": { - "Monday": { - "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for Monday.

" - } - }, - "Tuesday": { - "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for Tuesday.

" - } - }, - "Wednesday": { - "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for Wednesday.

" - } - }, - "Thursday": { - "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for Thursday.

" - } - }, - "Friday": { - "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for Friday.

" - } - }, - "Saturday": { - "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for Saturday.

" - } - }, - "Sunday": { - "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for Sunday.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a time-based instance's auto scaling schedule. The schedule consists of a set of key-value pairs.

\n
    \n
  • \n

    The key is the time period (a UTC hour) and must be an integer from 0 - 23.

    \n
  • \n
  • \n

    The value indicates whether the instance should be online or offline for the specified period, and must be \n set to \"on\" or \"off\"

    \n
  • \n
\n

The default setting for all time periods is off, so you use the following parameters primarily to specify the online periods. You don't have to explicitly specify offline periods unless you want to change an online period to an offline period.

\n

The following example specifies that the instance should be online for four hours, \n from UTC 1200 - 1600. It will be off for the remainder of the day.

\n

\n { \"12\":\"on\", \"13\":\"on\", \"14\":\"on\", \"15\":\"on\" } \n

" - } - } - } -} diff --git a/codegen/sdk/aws-models/opsworkscm.json b/codegen/sdk/aws-models/opsworkscm.json deleted file mode 100644 index be8b723fb60..00000000000 --- a/codegen/sdk/aws-models/opsworkscm.json +++ /dev/null @@ -1,3133 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.opsworkscm#AWSOpsWorksCMResourceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws.*:opsworks-cm:.*:[0-9]{12}:" - } - }, - "com.amazonaws.opsworkscm#AccountAttribute": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The attribute name. The following are supported attribute names.\n

\n
    \n
  • \n

    \n ServerLimit: The number of current servers/maximum number of servers allowed. By default, you can have a \n maximum of 10 servers.\n

    \n
  • \n
  • \n

    \n ManualBackupLimit: The number of current manual backups/maximum number of backups allowed. By default, \n you can have a maximum \n of 50 manual backups saved.\n

    \n
  • \n
" - } - }, - "Maximum": { - "target": "com.amazonaws.opsworkscm#Integer", - "traits": { - "smithy.api#documentation": "

\n The maximum allowed value.\n

" - } - }, - "Used": { - "target": "com.amazonaws.opsworkscm#Integer", - "traits": { - "smithy.api#documentation": "

\n The current usage, such as the current number of servers that are associated with the account.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Stores account attributes.\n

" - } - }, - "com.amazonaws.opsworkscm#AccountAttributes": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#AccountAttribute" - }, - "traits": { - "smithy.api#documentation": "

\n A list of individual account attributes.\n

" - } - }, - "com.amazonaws.opsworkscm#AssociateNode": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#AssociateNodeRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#AssociateNodeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.

\n

\n On a Chef server: This command is an alternative to knife bootstrap.

\n

\n Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes \"Name=CHEF_ORGANIZATION,Value=default\" \"Name=CHEF_AUTOMATE_NODE_PUBLIC_KEY,Value=public-key-pem\"\n

\n

\n On a Puppet server, this command is an alternative to the puppet cert sign command that signs a Puppet node CSR.\n

\n

\n Example (Puppet): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes \"Name=PUPPET_NODE_CSR,Value=csr-pem\"\n

\n

\n A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown.\n A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.\n The AssociateNode API call can be integrated into Auto Scaling configurations, CloudFormation templates, or the user data \n of a server's instance.\n

" - } - }, - "com.amazonaws.opsworkscm#AssociateNodeRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server with which to associate the node.\n

", - "smithy.api#required": {} - } - }, - "NodeName": { - "target": "com.amazonaws.opsworkscm#NodeName", - "traits": { - "smithy.api#documentation": "

The name of the node.\n

", - "smithy.api#required": {} - } - }, - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

Engine attributes used for associating the node.\n

\n

\n Attributes accepted in a AssociateNode request for Chef\n

\n
    \n
  • \n

    \n CHEF_ORGANIZATION: The Chef organization\n with which the node is associated. By default only one organization\n named default can exist.\n

    \n
  • \n
  • \n

    \n CHEF_AUTOMATE_NODE_PUBLIC_KEY: A PEM-formatted public key. This key is required for the chef-client agent to access the Chef API.\n

    \n
  • \n
\n

\n Attributes accepted in a AssociateNode request for Puppet\n

\n
    \n
  • \n

    \n PUPPET_NODE_CSR: A PEM-formatted certificate-signing request (CSR) that is created by the node.\n

    \n
  • \n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#AssociateNodeResponse": { - "type": "structure", - "members": { - "NodeAssociationStatusToken": { - "target": "com.amazonaws.opsworkscm#NodeAssociationStatusToken", - "traits": { - "smithy.api#documentation": "

Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the association request.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#AttributeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[A-Z][A-Z0-9_]*$" - } - }, - "com.amazonaws.opsworkscm#AttributeValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^(?s)" - } - }, - "com.amazonaws.opsworkscm#Backup": { - "type": "structure", - "members": { - "BackupArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The ARN of the backup.\n

" - } - }, - "BackupId": { - "target": "com.amazonaws.opsworkscm#BackupId", - "traits": { - "smithy.api#documentation": "

\n The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS\n

" - } - }, - "BackupType": { - "target": "com.amazonaws.opsworkscm#BackupType", - "traits": { - "smithy.api#documentation": "

\n The backup type. Valid values are automated or manual.\n

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworkscm#Timestamp", - "traits": { - "smithy.api#documentation": "

\n The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z\n

" - } - }, - "Description": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n A user-provided description for a manual backup. This field is empty for automated backups.\n

" - } - }, - "Engine": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The engine type that is obtained from the server when the backup is created.\n

" - } - }, - "EngineModel": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The engine model that is obtained from the server when the backup is created.\n

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The engine version that is obtained from the server when the backup is created.\n

" - } - }, - "InstanceProfileArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored,\n you are not required to provide the InstanceProfileArn again if you restore a backup.\n

" - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The instance type that is obtained from the server when the backup is created.\n

" - } - }, - "KeyPair": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The key pair that is obtained from the server when the backup is created.\n

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", - "traits": { - "smithy.api#documentation": "

\n The preferred backup period that is obtained from the server when the backup is created.\n

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", - "traits": { - "smithy.api#documentation": "

\n The preferred maintenance period that is obtained from the server when the backup is created.\n

" - } - }, - "S3DataSize": { - "target": "com.amazonaws.opsworkscm#Integer", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

\n This field is deprecated and is no longer used.\n

" - } - }, - "S3DataUrl": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

\n This field is deprecated and is no longer used.\n

" - } - }, - "S3LogUrl": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The Amazon S3 URL of the backup's log file.\n

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.opsworkscm#Strings", - "traits": { - "smithy.api#documentation": "

\n The security group IDs that are obtained from the server when the backup is created.\n

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

\n The name of the server from which the backup was made.\n

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The service role ARN that is obtained from the server when the backup is created.\n

" - } - }, - "Status": { - "target": "com.amazonaws.opsworkscm#BackupStatus", - "traits": { - "smithy.api#documentation": "

The status of a backup while in progress.\n

" - } - }, - "StatusDescription": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n An informational message about backup status.\n

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.opsworkscm#Strings", - "traits": { - "smithy.api#documentation": "

\n The subnet IDs that are obtained from the server when the backup is created.\n

" - } - }, - "ToolsVersion": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The version of OpsWorks CM-specific tools that is obtained from the server when the backup is created.\n

" - } - }, - "UserArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The user ARN of the requester for manual backups. This field is empty for automated backups.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a single backup.\n

" - } - }, - "com.amazonaws.opsworkscm#BackupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 79 - }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-\\.\\:]*$" - } - }, - "com.amazonaws.opsworkscm#BackupRetentionCountDefinition": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.opsworkscm#BackupStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "OK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OK" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - } - } - }, - "com.amazonaws.opsworkscm#BackupType": { - "type": "enum", - "members": { - "AUTOMATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTOMATED" - } - }, - "MANUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANUAL" - } - } - } - }, - "com.amazonaws.opsworkscm#Backups": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#Backup" - } - }, - "com.amazonaws.opsworkscm#Boolean": { - "type": "boolean" - }, - "com.amazonaws.opsworkscm#CreateBackup": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#CreateBackupRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#CreateBackupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#LimitExceededException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Creates an application-level backup of a server. While the\n server is in the BACKING_UP state, the server cannot be\n changed, and no additional backup can be created.\n

\n

\n Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. \n By default, you can create a maximum of 50\n manual backups.\n

\n

\n This operation is asynchronous.\n

\n

\n A LimitExceededException is thrown when the maximum number of manual backups is reached.\n An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY.\n A ResourceNotFoundException is thrown when the server is not found.\n A ValidationException is thrown when parameters of the request are not valid.\n

" - } - }, - "com.amazonaws.opsworkscm#CreateBackupRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server that you want to back up.\n

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n A user-defined description of the backup.\n

" - } - }, - "Tags": { - "target": "com.amazonaws.opsworkscm#TagList", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values to attach to an OpsWorks CM server backup.

\n
    \n
  • \n

    The key cannot be empty.

    \n
  • \n
  • \n

    The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the \n following special characters: + - = . _ : /\n

    \n
  • \n
  • \n

    The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the \n following special characters: + - = . _ : /\n

    \n
  • \n
  • \n

    Leading and trailing white spaces are trimmed from both the key and value.

    \n
  • \n
  • \n

    A maximum of 50 user-applied tags is allowed for tag-supported OpsWorks CM resources.

    \n
  • \n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#CreateBackupResponse": { - "type": "structure", - "members": { - "Backup": { - "target": "com.amazonaws.opsworkscm#Backup", - "traits": { - "smithy.api#documentation": "

Backup created by request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#CreateServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#CreateServerRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#CreateServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#LimitExceededException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By \n default, you can create a maximum of 10 servers.\n

\n

\n This operation is asynchronous.\n

\n

\n A LimitExceededException is thrown when you have created the maximum number of servers (10). A \n ResourceAlreadyExistsException\n is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when \n you\n specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when \n parameters\n of the request are not valid.\n

\n

\n If you do not specify a security group by adding the SecurityGroupIds parameter, OpsWorks creates a new \n security group.\n

\n

\n Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If \n a KeyName is present, OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.\n

\n

\n Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.\n

\n

By default, your server is accessible from any IP address. We\n recommend that you update your security group rules to allow\n access from known IP addresses and address ranges only. To edit security group rules, open Security Groups\n in the navigation pane of the EC2 management console.\n

\n

To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, \n specify values for CustomDomain, \n CustomCertificate, and CustomPrivateKey.

" - } - }, - "com.amazonaws.opsworkscm#CreateServerRequest": { - "type": "structure", - "members": { - "AssociatePublicIpAddress": { - "target": "com.amazonaws.opsworkscm#Boolean", - "traits": { - "smithy.api#documentation": "

\n Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.\n

" - } - }, - "CustomDomain": { - "target": "com.amazonaws.opsworkscm#CustomDomain", - "traits": { - "smithy.api#documentation": "

An optional public endpoint of a server, such as https://aws.my-company.com. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom \n domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the \n generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate \n and CustomPrivateKey.

" - } - }, - "CustomCertificate": { - "target": "com.amazonaws.opsworkscm#CustomCertificate", - "traits": { - "smithy.api#documentation": "

A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a \n custom certificate, you must also specify values for CustomDomain and CustomPrivateKey. The following are requirements for the CustomCertificate value:

\n
    \n
  • \n

    You can provide either a self-signed, custom certificate, or the full certificate chain.

    \n
  • \n
  • \n

    The certificate must be a valid X509 certificate, or a certificate chain in PEM format.

    \n
  • \n
  • \n

    The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires \n (the certificate's NotAfter date).

    \n
  • \n
  • \n

    The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain.

    \n
  • \n
  • \n

    The certificate must match the value of CustomPrivateKey.

    \n
  • \n
" - } - }, - "CustomPrivateKey": { - "target": "com.amazonaws.opsworkscm#CustomPrivateKey", - "traits": { - "smithy.api#documentation": "

A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. \n If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate.

" - } - }, - "DisableAutomatedBackup": { - "target": "com.amazonaws.opsworkscm#Boolean", - "traits": { - "smithy.api#documentation": "

\n Enable or disable scheduled backups. Valid values are true or false. The default value is true.\n

" - } - }, - "Engine": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The configuration management engine to use. Valid values include ChefAutomate and Puppet.\n

", - "smithy.api#required": {} - } - }, - "EngineModel": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.\n

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion \n is currently 2. For a Puppet server, valid values are 2019 or 2017.\n

" - } - }, - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

Optional engine attributes on a specified server.\n

\n

\n Attributes accepted in a Chef createServer request:\n

\n
    \n
  • \n

    \n CHEF_AUTOMATE_PIVOTAL_KEY: A\n base64-encoded RSA public key. The corresponding private key is required to\n access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is\n generated and returned in the response.\n

    \n
  • \n
  • \n

    \n CHEF_AUTOMATE_ADMIN_PASSWORD:\n The password for the administrative user in the Chef Automate web-based dashboard. The\n password length is a minimum of eight characters, and a maximum of 32. The\n password can contain letters, numbers, and special characters\n (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper\n case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is\n generated and returned in the response.

    \n
  • \n
\n

\n Attributes accepted in a Puppet createServer request:\n

\n
    \n
  • \n

    \n PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a password must use ASCII characters.

    \n
  • \n
  • \n

    \n PUPPET_R10K_REMOTE: The r10k remote is the URL of your control repository \n (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.

    \n
  • \n
  • \n

    \n PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository, add \n PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.

    \n
  • \n
" - } - }, - "BackupRetentionCount": { - "target": "com.amazonaws.opsworkscm#BackupRetentionCountDefinition", - "traits": { - "smithy.api#documentation": "

\n The number of automated backups that you want to keep. Whenever a new backup is created, OpsWorks CM deletes the oldest backups if this number is exceeded.\n The default value is 1.\n

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

\n The name of the server. The server name must be unique within your Amazon Web Services account, within each region.\n Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.\n

", - "smithy.api#required": {} - } - }, - "InstanceProfileArn": { - "target": "com.amazonaws.opsworkscm#InstanceProfileArn", - "traits": { - "smithy.api#documentation": "

\n The ARN of the instance profile that your Amazon EC2\n instances use. The OpsWorks console typically creates\n the instance profile for you

", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The Amazon EC2 instance type to use. For example, m5.large.\n

", - "smithy.api#required": {} - } - }, - "KeyPair": { - "target": "com.amazonaws.opsworkscm#KeyPair", - "traits": { - "smithy.api#documentation": "

\n The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.\n

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", - "traits": { - "smithy.api#documentation": "

\n The start time for a one-hour period each week during which OpsWorks CM performs maintenance on the instance.\n Valid values must be specified in the following format: DDD:HH:MM. MM must be specified as 00. The specified time is in coordinated universal time (UTC).\n The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.\n

\n

\n Example:\n Mon:08:00,\n which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)\n

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", - "traits": { - "smithy.api#documentation": "

\n The start time for a one-hour period during which OpsWorks CM backs up application-level data on your server\n if automated backups are enabled. Valid values must be specified in one of the following formats:\n

\n
    \n
  • \n

    \n HH:MM for daily backups

    \n
  • \n
  • \n

    \n DDD:HH:MM for weekly backups

    \n
  • \n
\n

\n MM must be specified as 00. The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

\n

\n Example:\n 08:00, which represents a daily start time of 08:00 UTC.

\n

\n Example:\n Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.opsworkscm#Strings", - "traits": { - "smithy.api#documentation": "

\n A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups\n must be within the VPC that is specified by SubnetIds.\n

\n

\n If you do not specify this parameter, OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to\n 0.0.0.0/0 (everyone).\n

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworkscm#ServiceRoleArn", - "traits": { - "smithy.api#documentation": "

\n The service role that the OpsWorks CM service backend uses to work with your account.

", - "smithy.api#required": {} - } - }, - "SubnetIds": { - "target": "com.amazonaws.opsworkscm#Strings", - "traits": { - "smithy.api#documentation": "

\n The IDs of subnets in which to launch the server EC2 instance.\n

\n

\n Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have \"Auto Assign Public IP\" enabled.\n

\n

\n EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that \n is selected by Amazon EC2. If you specify subnet IDs, the VPC must have \"Auto Assign Public IP\" enabled.\n

\n

For more information about supported Amazon EC2 platforms, see\n Supported Platforms.

" - } - }, - "Tags": { - "target": "com.amazonaws.opsworkscm#TagList", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values to attach to an OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

\n
    \n
  • \n

    The key cannot be empty.

    \n
  • \n
  • \n

    The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @\n

    \n
  • \n
  • \n

    The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / @\n

    \n
  • \n
  • \n

    Leading and trailing spaces are trimmed from both the key and value.

    \n
  • \n
  • \n

    A maximum of 50 user-applied tags is allowed for any OpsWorks CM server.

    \n
  • \n
" - } - }, - "BackupId": { - "target": "com.amazonaws.opsworkscm#BackupId", - "traits": { - "smithy.api#documentation": "

\n If you specify this field, OpsWorks CM creates the server by using the backup represented by BackupId.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#CreateServerResponse": { - "type": "structure", - "members": { - "Server": { - "target": "com.amazonaws.opsworkscm#Server", - "traits": { - "smithy.api#documentation": "

The server that is created by the request.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#CustomCertificate": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2097152 - }, - "smithy.api#pattern": "^(?s)\\s*-----BEGIN CERTIFICATE-----.+-----END CERTIFICATE-----\\s*$" - } - }, - "com.amazonaws.opsworkscm#CustomDomain": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 253 - }, - "smithy.api#pattern": "^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$" - } - }, - "com.amazonaws.opsworkscm#CustomPrivateKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4096 - }, - "smithy.api#pattern": "^(?ms)\\s*^-----BEGIN (?-s:.*)PRIVATE KEY-----$.*?^-----END (?-s:.*)PRIVATE KEY-----$\\s*$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.opsworkscm#DeleteBackup": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DeleteBackupRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DeleteBackupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.\n

\n

\n An InvalidStateException is thrown when a backup deletion is already in progress.\n A ResourceNotFoundException is thrown when the backup does not exist.\n A ValidationException is thrown when parameters of the request are not valid.\n

" - } - }, - "com.amazonaws.opsworkscm#DeleteBackupRequest": { - "type": "structure", - "members": { - "BackupId": { - "target": "com.amazonaws.opsworkscm#BackupId", - "traits": { - "smithy.api#documentation": "

The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs.\n Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DeleteBackupResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#DeleteServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DeleteServerRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DeleteServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Deletes the server and the underlying CloudFormation stacks\n (including the server's EC2 instance). When you run this command, the server state is updated\n to DELETING. After the server is deleted, it is no longer returned by\n DescribeServer requests. If the CloudFormation stack cannot be deleted, the server cannot be deleted.\n

\n

\n This operation is asynchronous.\n

\n

\n An InvalidStateException is thrown when a server deletion is already in progress.\n A ResourceNotFoundException is thrown when the server does not exist.\n A ValidationException is raised when parameters of the request are not valid.\n

\n

\n

" - } - }, - "com.amazonaws.opsworkscm#DeleteServerRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The ID of the server to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DeleteServerResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#DescribeAccountAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DescribeAccountAttributesRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DescribeAccountAttributesResponse" - }, - "traits": { - "smithy.api#documentation": "

\n Describes your OpsWorks CM account attributes.\n

\n

\n This operation is synchronous.\n

" - } - }, - "com.amazonaws.opsworkscm#DescribeAccountAttributesRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DescribeAccountAttributesResponse": { - "type": "structure", - "members": { - "Attributes": { - "target": "com.amazonaws.opsworkscm#AccountAttributes", - "traits": { - "smithy.api#documentation": "

\n The attributes that are currently set for the account.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#DescribeBackups": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DescribeBackupsRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DescribeBackupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Describes backups. The results are ordered by time, with newest backups first.\n If you do not specify a BackupId or ServerName, the command returns all backups.\n

\n

\n This operation is synchronous.\n

\n

\n A ResourceNotFoundException is thrown when the backup does not exist.\n A ValidationException is raised when parameters of the request are not valid.\n

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Backups", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.opsworkscm#DescribeBackupsRequest": { - "type": "structure", - "members": { - "BackupId": { - "target": "com.amazonaws.opsworkscm#BackupId", - "traits": { - "smithy.api#documentation": "

Describes a single backup.\n

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

Returns backups for the server with the specified ServerName.\n

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#NextToken", - "traits": { - "smithy.api#documentation": "

This is not currently implemented for DescribeBackups requests.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.opsworkscm#MaxResults", - "traits": { - "smithy.api#documentation": "

This is not currently implemented for DescribeBackups requests.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DescribeBackupsResponse": { - "type": "structure", - "members": { - "Backups": { - "target": "com.amazonaws.opsworkscm#Backups", - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeBackups request.\n

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

This is not currently implemented for DescribeBackups requests.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#DescribeEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DescribeEventsRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DescribeEventsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Describes events for a specified server. Results are ordered by time, with newest events first.\n

\n

\n This operation is synchronous.\n

\n

\n A ResourceNotFoundException is thrown when the server does not exist.\n A ValidationException is raised when parameters of the request are not valid.\n

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ServerEvents", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.opsworkscm#DescribeEventsRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server for which you want to view events.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#NextToken", - "traits": { - "smithy.api#documentation": "

NextToken is a string that is returned in some command responses. It indicates that\n not all entries have been returned, and that you must run at least one more request to get remaining\n items. To get remaining results, call DescribeEvents again, and assign the token from the previous\n results as the value of the nextToken parameter. If there are no more results,\n the response object's nextToken parameter value is null.\n Setting a nextToken value that was not returned in\n your previous results causes an InvalidNextTokenException to occur.\n

" - } - }, - "MaxResults": { - "target": "com.amazonaws.opsworkscm#MaxResults", - "traits": { - "smithy.api#documentation": "

To receive a paginated response, use this parameter to specify the maximum number\n of results to be returned with a single call. If the number of available results exceeds\n this maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DescribeEventsResponse": { - "type": "structure", - "members": { - "ServerEvents": { - "target": "com.amazonaws.opsworkscm#ServerEvents", - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeEvents request.\n

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

NextToken is a string that is returned in some command responses. It indicates that\n not all entries have been returned, and that you must run at least one more request to get remaining\n items. To get remaining results, call DescribeEvents again, and assign the token from the previous\n results as the value of the nextToken parameter. If there are no more results,\n the response object's nextToken parameter value is null.\n Setting a nextToken value that was not returned in\n your previous results causes an InvalidNextTokenException to occur.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#DescribeNodeAssociationStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DescribeNodeAssociationStatusRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DescribeNodeAssociationStatusResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Returns the current status of an existing association or disassociation request.\n

\n

\n A ResourceNotFoundException is thrown when no recent association or disassociation request with the specified token is found,\n or when the server does not exist. A ValidationException is raised when parameters of the request are not valid.\n

", - "smithy.waiters#waitable": { - "NodeAssociated": { - "documentation": "Wait until node is associated or disassociated.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "NodeAssociationStatus", - "expected": "SUCCESS", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "NodeAssociationStatus", - "expected": "FAILED", - "comparator": "stringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.opsworkscm#DescribeNodeAssociationStatusRequest": { - "type": "structure", - "members": { - "NodeAssociationStatusToken": { - "target": "com.amazonaws.opsworkscm#NodeAssociationStatusToken", - "traits": { - "smithy.api#documentation": "

The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse.\n

", - "smithy.api#required": {} - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server from which to disassociate the node.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DescribeNodeAssociationStatusResponse": { - "type": "structure", - "members": { - "NodeAssociationStatus": { - "target": "com.amazonaws.opsworkscm#NodeAssociationStatus", - "traits": { - "smithy.api#documentation": "

The status of the association or disassociation request.\n

\n

\n Possible values:\n

\n
    \n
  • \n

    \n SUCCESS: The association or disassociation succeeded.\n

    \n
  • \n
  • \n

    \n FAILED: The association or disassociation failed.\n

    \n
  • \n
  • \n

    \n IN_PROGRESS: The association or disassociation is still in progress.\n

    \n
  • \n
" - } - }, - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

Attributes specific to the node association. \n In Puppet, the attribute PUPPET_NODE_CERT contains the signed certificate (the result of the CSR).\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#DescribeServers": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DescribeServersRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DescribeServersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Lists all configuration management servers that are identified with your account.\n Only the stored results from Amazon DynamoDB\n are returned. OpsWorks CM does not query other services.\n

\n

\n This operation is synchronous.\n

\n

\n A ResourceNotFoundException is thrown when the server does not exist.\n A ValidationException is raised when parameters of the request are not valid.\n

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Servers", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.opsworkscm#DescribeServersRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

Describes the server with the specified ServerName.

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#NextToken", - "traits": { - "smithy.api#documentation": "

This is not currently implemented for DescribeServers requests.\n

" - } - }, - "MaxResults": { - "target": "com.amazonaws.opsworkscm#MaxResults", - "traits": { - "smithy.api#documentation": "

This is not currently implemented for DescribeServers requests.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DescribeServersResponse": { - "type": "structure", - "members": { - "Servers": { - "target": "com.amazonaws.opsworkscm#Servers", - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeServers request.

\n

\n For Chef Automate servers: If DescribeServersResponse$Servers$EngineAttributes includes \n CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server to Chef Automate 2. To be eligible for upgrade, a server running \n Chef Automate 1 must have had at least one successful maintenance run after November 1, 2019.

\n

\n For Puppet servers:\n DescribeServersResponse$Servers$EngineAttributes contains\n the following two responses:

\n
    \n
  • \n

    \n PUPPET_API_CA_CERT, the PEM-encoded CA certificate that is used by the Puppet API over TCP port number 8140. \n The CA certificate is also used to sign node certificates.

    \n
  • \n
  • \n

    \n PUPPET_API_CRL, a certificate revocation list. The certificate revocation list is for internal \n maintenance purposes only. For more information about the Puppet certificate revocation list, see \n Man Page: puppet certificate_revocation_list in the Puppet documentation.

    \n
  • \n
" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

This is not currently implemented for DescribeServers requests.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#DisassociateNode": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DisassociateNodeRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DisassociateNodeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Disassociates a node from an OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated,\n the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode.\n

\n

A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown.\n A ResourceNotFoundException is thrown when the server does not exist.\n A ValidationException is raised when parameters of the request are not valid.\n

" - } - }, - "com.amazonaws.opsworkscm#DisassociateNodeRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server from which to disassociate the node.\n

", - "smithy.api#required": {} - } - }, - "NodeName": { - "target": "com.amazonaws.opsworkscm#NodeName", - "traits": { - "smithy.api#documentation": "

The name of the client node.\n

", - "smithy.api#required": {} - } - }, - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

Engine attributes that are used for disassociating the node. No attributes are required for Puppet.\n

\n

\n Attributes required in a DisassociateNode request for Chef\n

\n
    \n
  • \n

    \n CHEF_ORGANIZATION: The Chef organization\n with which the node was associated. By default only one organization\n named default can exist.\n

    \n
  • \n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DisassociateNodeResponse": { - "type": "structure", - "members": { - "NodeAssociationStatusToken": { - "target": "com.amazonaws.opsworkscm#NodeAssociationStatusToken", - "traits": { - "smithy.api#documentation": "

Contains a token which can be passed to the\n DescribeNodeAssociationStatus API call to get the status of\n the disassociation request.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#EngineAttribute": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.opsworkscm#EngineAttributeName", - "traits": { - "smithy.api#documentation": "

The name of the engine attribute.\n

" - } - }, - "Value": { - "target": "com.amazonaws.opsworkscm#EngineAttributeValue", - "traits": { - "smithy.api#documentation": "

The value of the engine attribute.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A name and value pair that is specific to the engine of the server.\n

" - } - }, - "com.amazonaws.opsworkscm#EngineAttributeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^(?s)" - } - }, - "com.amazonaws.opsworkscm#EngineAttributeValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^(?s)", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.opsworkscm#EngineAttributes": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#EngineAttribute" - } - }, - "com.amazonaws.opsworkscm#ExportServerEngineAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#ExportServerEngineAttributeRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#ExportServerEngineAttributeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can \n use in EC2 to associate nodes with a server.\n

\n

\n This operation is synchronous.\n

\n

\n A ValidationException is raised when parameters of the request are not valid.\n A ResourceNotFoundException is thrown when the server does not exist.\n An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED,\n FAILED or DELETING.\n

" - } - }, - "com.amazonaws.opsworkscm#ExportServerEngineAttributeRequest": { - "type": "structure", - "members": { - "ExportAttributeName": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The name of the export attribute. Currently, the supported export attribute is Userdata. \n This exports a user data script that includes parameters and values provided in the InputAttributes list.

", - "smithy.api#required": {} - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server from which you are exporting the attribute.

", - "smithy.api#required": {} - } - }, - "InputAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

The list of engine attributes. The list type is EngineAttribute. An EngineAttribute list item \n is a pair that includes an attribute name and its value. For the Userdata ExportAttributeName, the following are \n supported engine attribute names.

\n
    \n
  • \n

    \n RunList In Chef, a list of roles or recipes that are run in the specified order. \n In Puppet, this parameter is ignored.

    \n
  • \n
  • \n

    \n OrganizationName In Chef, an organization name. OpsWorks for Chef Automate \n always creates the organization default. In Puppet, this parameter is ignored.

    \n
  • \n
  • \n

    \n NodeEnvironment In Chef, a node environment (for example, development, staging, or one-box). \n In Puppet, this parameter is ignored.

    \n
  • \n
  • \n

    \n NodeClientVersion In Chef, the version of the Chef engine (three numbers separated \n by dots, such as 13.8.5). If this attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet, \n this parameter is ignored.

    \n
  • \n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#ExportServerEngineAttributeResponse": { - "type": "structure", - "members": { - "EngineAttribute": { - "target": "com.amazonaws.opsworkscm#EngineAttribute", - "traits": { - "smithy.api#documentation": "

The requested engine attribute pair with attribute name and value.

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The server name used in the request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#InstanceProfileArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^arn:aws:iam::[0-9]{12}:instance-profile/" - } - }, - "com.amazonaws.opsworkscm#Integer": { - "type": "integer" - }, - "com.amazonaws.opsworkscm#InvalidNextTokenException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

Error or informational message that can contain more detail about a nextToken failure.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This occurs when the provided nextToken is not valid.\n

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.opsworkscm#InvalidStateException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

Error or informational message that provides more detail if a resource is\n in a state that is not valid for performing a specified action.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The resource is in a state that does not allow you to perform a specified action.\n

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.opsworkscm#KeyPair": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.opsworkscm#LimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

Error or informational message that the maximum allowed number of servers or backups has been exceeded.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The limit of servers or backups has been reached.\n

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.opsworkscm#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of tags that are applied to the specified OpsWorks for Chef Automate or\n OpsWorks for Puppet Enterprise servers or backups.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Tags", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.opsworkscm#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.opsworkscm#AWSOpsWorksCMResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of an OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server for which you want to show applied tags. For example, \n arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#NextToken", - "traits": { - "smithy.api#documentation": "

NextToken is a string that is returned in some command responses. It indicates that\n not all entries have been returned, and that you must run at least one more request to get remaining\n items. To get remaining results, call ListTagsForResource again, and assign the token from the previous\n results as the value of the nextToken parameter. If there are no more results,\n the response object's nextToken parameter value is null.\n Setting a nextToken value that was not returned in\n your previous results causes an InvalidNextTokenException to occur.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.opsworkscm#MaxResults", - "traits": { - "smithy.api#documentation": "

To receive a paginated response, use this parameter to specify the maximum number\n of results to be returned with a single call. If the number of available results exceeds\n this maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.opsworkscm#TagList", - "traits": { - "smithy.api#documentation": "

Tags that have been applied to the resource.

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#NextToken", - "traits": { - "smithy.api#documentation": "

A token that you can use as the value of NextToken in subsequent calls to the API to show more results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#MaintenanceStatus": { - "type": "enum", - "members": { - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.opsworkscm#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.opsworkscm#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^(?s)" - } - }, - "com.amazonaws.opsworkscm#NodeAssociationStatus": { - "type": "enum", - "members": { - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - } - }, - "traits": { - "smithy.api#documentation": "

The status of the association or disassociation request.\n

\n

\n Possible values:\n

\n
    \n
  • \n

    \n SUCCESS: The association or disassociation succeeded.\n

    \n
  • \n
  • \n

    \n FAILED: The association or disassociation failed.\n

    \n
  • \n
  • \n

    \n IN_PROGRESS: The association or disassociation is still in progress.\n

    \n
  • \n
" - } - }, - "com.amazonaws.opsworkscm#NodeAssociationStatusToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^(?s)" - } - }, - "com.amazonaws.opsworkscm#NodeName": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The node name that is used by chef-client or puppet-agentfor a new node. We recommend to use a unique FQDN as hostname. For more information, see the\n Chef or \n Puppet documentation.\n

", - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^[\\-\\p{Alnum}_:.]+$" - } - }, - "com.amazonaws.opsworkscm#OpsWorksCM_V2016_11_01": { - "type": "service", - "version": "2016-11-01", - "operations": [ - { - "target": "com.amazonaws.opsworkscm#AssociateNode" - }, - { - "target": "com.amazonaws.opsworkscm#CreateBackup" - }, - { - "target": "com.amazonaws.opsworkscm#CreateServer" - }, - { - "target": "com.amazonaws.opsworkscm#DeleteBackup" - }, - { - "target": "com.amazonaws.opsworkscm#DeleteServer" - }, - { - "target": "com.amazonaws.opsworkscm#DescribeAccountAttributes" - }, - { - "target": "com.amazonaws.opsworkscm#DescribeBackups" - }, - { - "target": "com.amazonaws.opsworkscm#DescribeEvents" - }, - { - "target": "com.amazonaws.opsworkscm#DescribeNodeAssociationStatus" - }, - { - "target": "com.amazonaws.opsworkscm#DescribeServers" - }, - { - "target": "com.amazonaws.opsworkscm#DisassociateNode" - }, - { - "target": "com.amazonaws.opsworkscm#ExportServerEngineAttribute" - }, - { - "target": "com.amazonaws.opsworkscm#ListTagsForResource" - }, - { - "target": "com.amazonaws.opsworkscm#RestoreServer" - }, - { - "target": "com.amazonaws.opsworkscm#StartMaintenance" - }, - { - "target": "com.amazonaws.opsworkscm#TagResource" - }, - { - "target": "com.amazonaws.opsworkscm#UntagResource" - }, - { - "target": "com.amazonaws.opsworkscm#UpdateServer" - }, - { - "target": "com.amazonaws.opsworkscm#UpdateServerEngineAttributes" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "OpsWorksCM", - "arnNamespace": "opsworks-cm", - "cloudFormationName": "OpsWorksCM", - "cloudTrailEventSource": "opsworkscm.amazonaws.com", - "endpointPrefix": "opsworks-cm" - }, - "aws.auth#sigv4": { - "name": "opsworks-cm" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "OpsWorks CM\n \n

The OpsWorks services have reached end of life and have been disabled for both new and existing customers. \n We strongly recommend customers migrate their workloads to other solutions as soon as possible. If you have questions about migration, reach out to the Amazon Web ServicesSupport Team on Amazon Web Services re:Post or through Amazon Web Services Premium Support.

\n
\n

OpsWorks CM is a service that runs and manages\n configuration management servers. You can use OpsWorks CM to create and manage OpsWorks for Chef Automate and \n OpsWorks for Puppet Enterprise servers, and add or remove\n nodes for the servers to manage.

\n

\n Glossary of terms\n

\n
    \n
  • \n

    \n Server: A configuration management server that can be \n highly-available. The configuration management server runs on\n an Amazon Elastic Compute Cloud (EC2) instance, and may use various other Amazon Web Services services, such as Amazon Relational Database Service \n (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration\n manager that you want to use, much like Amazon RDS. In OpsWorks CM, you do not start\n or stop servers. After you create servers, they continue to run until they are deleted.

    \n
  • \n
  • \n

    \n Engine: The engine is the specific configuration manager \n that you want to use. Valid values in this release include ChefAutomate and Puppet.

    \n
  • \n
  • \n

    \n Backup: This\n is an application-level backup of the data that the configuration manager\n stores. OpsWorks CM\n creates an S3 bucket for backups when you launch the first\n server. A backup maintains a snapshot of a server's configuration-related\n attributes at the time the backup starts.

    \n
  • \n
  • \n

    \n Events:\n Events are always related to a server. Events are written\n during server creation, when health checks run, when backups\n are created, when system maintenance is performed, etc. When you delete a server, the server's events are\n also deleted.

    \n
  • \n
  • \n

    \n Account attributes:\n Every account has attributes that are assigned in the OpsWorks CM\n database. These attributes store information about configuration limits (servers,\n backups, etc.) and your customer account.\n

    \n
  • \n
\n

\n Endpoints\n

\n

OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. \n Your servers\n can only be accessed or managed within the endpoint in which they are created.

\n
    \n
  • \n

    opsworks-cm.us-east-1.amazonaws.com

    \n
  • \n
  • \n

    opsworks-cm.us-east-2.amazonaws.com

    \n
  • \n
  • \n

    opsworks-cm.us-west-1.amazonaws.com

    \n
  • \n
  • \n

    opsworks-cm.us-west-2.amazonaws.com

    \n
  • \n
  • \n

    opsworks-cm.ap-northeast-1.amazonaws.com

    \n
  • \n
  • \n

    opsworks-cm.ap-southeast-1.amazonaws.com

    \n
  • \n
  • \n

    opsworks-cm.ap-southeast-2.amazonaws.com

    \n
  • \n
  • \n

    opsworks-cm.eu-central-1.amazonaws.com

    \n
  • \n
  • \n

    opsworks-cm.eu-west-1.amazonaws.com

    \n
  • \n
\n

For more information, see OpsWorks endpoints and quotas in the Amazon Web Services General Reference.

\n

\n Throttling limits\n

\n

All API operations allow for five requests per second with a burst of 10 requests per second.

", - "smithy.api#title": "AWS OpsWorks CM", - "smithy.api#xmlNamespace": { - "uri": "http://opsworks-cm.amazonaws.com/doc/2016-11-01/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://opsworks-cm-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://opsworks-cm-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://opsworks-cm.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://opsworks-cm.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.opsworkscm#ResourceAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

Error or informational message in response to a CreateServer request that a resource cannot be created because it already exists.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The requested resource cannot be created because it already exists.\n

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.opsworkscm#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

Error or informational message that can contain more detail about problems locating or accessing a resource.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The requested resource does not exist, or access was denied.\n

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.opsworkscm#RestoreServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#RestoreServerRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#RestoreServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state.\n When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains\n the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work.\n

\n

Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a HEALTHY state, \n OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in a \n Running or Stopped state, but is eventually terminated.

\n

\n This operation is asynchronous.\n

\n

\n An InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown\n when the server does not exist. A ValidationException is raised when parameters of the request are not valid.\n

" - } - }, - "com.amazonaws.opsworkscm#RestoreServerRequest": { - "type": "structure", - "members": { - "BackupId": { - "target": "com.amazonaws.opsworkscm#BackupId", - "traits": { - "smithy.api#documentation": "

The ID of the backup that you want to use to restore a server.\n

", - "smithy.api#required": {} - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server that you want to restore.\n

", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The type of instance to restore. Valid values must be specified in the following format: ^([cm][34]|t2).*\n For example, m5.large. Valid values are m5.large, r5.xlarge, and r5.2xlarge. If you do not specify this parameter,\n RestoreServer uses the instance type from the specified backup.\n

" - } - }, - "KeyPair": { - "target": "com.amazonaws.opsworkscm#KeyPair", - "traits": { - "smithy.api#documentation": "

The name of the key pair to set on the new EC2 instance. This can be helpful\n if the administrator no longer has the SSH key.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#RestoreServerResponse": { - "type": "structure", - "members": { - "Server": { - "target": "com.amazonaws.opsworkscm#Server" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#Server": { - "type": "structure", - "members": { - "AssociatePublicIpAddress": { - "target": "com.amazonaws.opsworkscm#Boolean", - "traits": { - "smithy.api#documentation": "

Associate a public IP address with a server that you are launching.\n

" - } - }, - "BackupRetentionCount": { - "target": "com.amazonaws.opsworkscm#Integer", - "traits": { - "smithy.api#documentation": "

The number of automated backups to keep.\n

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The name of the server.\n

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworkscm#Timestamp", - "traits": { - "smithy.api#documentation": "

Time stamp of server creation. Example 2016-07-29T13:38:47.520Z\n

" - } - }, - "CloudFormationStackArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The ARN of the CloudFormation stack that was used to create the server.\n

" - } - }, - "CustomDomain": { - "target": "com.amazonaws.opsworkscm#CustomDomain", - "traits": { - "smithy.api#documentation": "

An optional public endpoint of a server, such as https://aws.my-company.com. \n You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

" - } - }, - "DisableAutomatedBackup": { - "target": "com.amazonaws.opsworkscm#Boolean", - "traits": { - "smithy.api#documentation": "

Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.\n

" - } - }, - "Endpoint": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. \n You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.\n

" - } - }, - "Engine": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The engine type of the server. Valid values in this release include ChefAutomate and Puppet.\n

" - } - }, - "EngineModel": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.\n

" - } - }, - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

The response of a createServer() request returns the master\n credential to access the server in EngineAttributes. These\n credentials are not stored by OpsWorks CM; they are returned only as part of the result of createServer().\n

\n

\n Attributes returned in a createServer response for Chef\n

\n
    \n
  • \n

    \n CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is\n generated by OpsWorks for Chef Automate. This private key is required to access\n the Chef API.

    \n
  • \n
  • \n

    \n CHEF_STARTER_KIT: A base64-encoded ZIP file.\n The ZIP file contains a Chef starter kit, which includes a README, a\n configuration file, and the required RSA private key. Save this file, unzip it,\n and then change to the directory where you've unzipped the file contents.\n From this directory, you can run Knife commands.

    \n
  • \n
\n

\n Attributes returned in a createServer response for Puppet\n

\n
    \n
  • \n

    \n PUPPET_STARTER_KIT: A base64-encoded ZIP file.\n The ZIP file contains a Puppet starter kit, including a README and a\n required private key. Save this file, unzip it,\n and then change to the directory where you've unzipped the file contents.

    \n
  • \n
  • \n

    \n PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the \n Puppet Enterprise console after the server is online.

    \n
  • \n
" - } - }, - "EngineVersion": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The engine version of the server. For a Chef server, the valid value for EngineVersion is \n currently 2. For a Puppet server, specify either 2019 or 2017.\n

" - } - }, - "InstanceProfileArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The instance profile ARN of the server.\n

" - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type \n that is shown in the EC2 console.\n

" - } - }, - "KeyPair": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The key pair associated with the server.\n

" - } - }, - "MaintenanceStatus": { - "target": "com.amazonaws.opsworkscm#MaintenanceStatus", - "traits": { - "smithy.api#documentation": "

The status of the most recent server maintenance run. Shows SUCCESS or FAILED.\n

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", - "traits": { - "smithy.api#documentation": "

The preferred maintenance period specified for the server.\n

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", - "traits": { - "smithy.api#documentation": "

The preferred backup period specified for the server.\n

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.opsworkscm#Strings", - "traits": { - "smithy.api#documentation": "

\n The security group IDs for the server, as specified in the CloudFormation stack.\n These might not be the same security groups that are shown in the EC2 console.\n

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The service role ARN used to create the server.\n

" - } - }, - "Status": { - "target": "com.amazonaws.opsworkscm#ServerStatus", - "traits": { - "smithy.api#documentation": "

\n The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server,\n as well as the server's health state.\n

" - } - }, - "StatusReason": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n Depending on the server status, this field has either a human-readable\n message (such as a create or backup error), or an escaped block of JSON (used for health check results).\n

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.opsworkscm#Strings", - "traits": { - "smithy.api#documentation": "

\n The subnet IDs specified in a CreateServer request.\n

" - } - }, - "ServerArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The ARN of the server.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a configuration management server.\n

" - } - }, - "com.amazonaws.opsworkscm#ServerEvent": { - "type": "structure", - "members": { - "CreatedAt": { - "target": "com.amazonaws.opsworkscm#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the event occurred.\n

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The name of the server on or for which the event occurred.\n

" - } - }, - "Message": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

A human-readable informational or status message.

" - } - }, - "LogUrl": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The Amazon S3 URL of the event's log file.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An event that is related to the server, such as the start of maintenance or backup.\n

" - } - }, - "com.amazonaws.opsworkscm#ServerEvents": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#ServerEvent" - } - }, - "com.amazonaws.opsworkscm#ServerName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 40 - }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-]*$" - } - }, - "com.amazonaws.opsworkscm#ServerStatus": { - "type": "enum", - "members": { - "BACKING_UP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BACKING_UP" - } - }, - "CONNECTION_LOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTION_LOST" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "MODIFYING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MODIFYING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "HEALTHY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HEALTHY" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "RESTORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESTORING" - } - }, - "SETUP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SETUP" - } - }, - "UNDER_MAINTENANCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNDER_MAINTENANCE" - } - }, - "UNHEALTHY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNHEALTHY" - } - }, - "TERMINATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATED" - } - } - } - }, - "com.amazonaws.opsworkscm#Servers": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#Server" - } - }, - "com.amazonaws.opsworkscm#ServiceRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^arn:aws:iam::[0-9]{12}:role/" - } - }, - "com.amazonaws.opsworkscm#StartMaintenance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#StartMaintenanceRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#StartMaintenanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying\n cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is in progress.\n

\n

\n Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown.\n A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.\n

" - } - }, - "com.amazonaws.opsworkscm#StartMaintenanceRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server on which to run maintenance.\n

", - "smithy.api#required": {} - } - }, - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

Engine attributes that are specific to the server on which you want to run maintenance.

\n

\n Attributes accepted in a StartMaintenance request for Chef\n

\n
    \n
  • \n

    \n CHEF_MAJOR_UPGRADE: If a Chef Automate server is eligible for upgrade to Chef Automate 2, \n add this engine attribute to a StartMaintenance request and set the value to true to upgrade the server to Chef Automate 2. For more information, see \n Upgrade an OpsWorks for Chef Automate Server to Chef Automate 2.\n

    \n
  • \n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#StartMaintenanceResponse": { - "type": "structure", - "members": { - "Server": { - "target": "com.amazonaws.opsworkscm#Server", - "traits": { - "smithy.api#documentation": "

Contains the response to a StartMaintenance request.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#String": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^(?s)" - } - }, - "com.amazonaws.opsworkscm#Strings": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#String" - } - }, - "com.amazonaws.opsworkscm#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.opsworkscm#TagKey", - "traits": { - "smithy.api#documentation": "

A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 127 characters, \n and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.opsworkscm#TagValue", - "traits": { - "smithy.api#documentation": "

An optional tag value, such as Production or test-owcm-server. The value can be a maximum of 255 characters, \n and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values to attach to an OpsWorks for Chef Automate \n or OpsWorks for Puppet Enterprise server. Leading and trailing spaces are trimmed from both the key and value. \n A maximum of 50 user-applied tags is allowed for tag-supported OpsWorks CM resources.

" - } - }, - "com.amazonaws.opsworkscm#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.opsworkscm#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.opsworkscm#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#Tag" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.opsworkscm#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Applies tags to an OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server, or to server backups.

" - } - }, - "com.amazonaws.opsworkscm#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.opsworkscm#AWSOpsWorksCMResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of a resource to which you want to apply tags. For example, \n arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.opsworkscm#TagList", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values to attach to OpsWorks CM servers or backups.

\n
    \n
  • \n

    The key cannot be empty.

    \n
  • \n
  • \n

    The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n

    \n
  • \n
  • \n

    The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n

    \n
  • \n
  • \n

    Leading and trailing white spaces are trimmed from both the key and value.

    \n
  • \n
  • \n

    A maximum of 50 user-applied tags is allowed for any OpsWorks CM server or backup.

    \n
  • \n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.opsworkscm#TimeWindowDefinition": { - "type": "string", - "traits": { - "smithy.api#documentation": "

\n DDD:HH:MM (weekly start time) or\n HH:MM (daily start time).\n

\n

\n Time windows always use coordinated universal time (UTC). Valid strings for day of week (DDD) are: Mon, Tue, Wed,\n Thr, Fri, Sat, or Sun.

", - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$" - } - }, - "com.amazonaws.opsworkscm#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.opsworkscm#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes specified tags from an OpsWorks CM server or backup.

" - } - }, - "com.amazonaws.opsworkscm#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.opsworkscm#AWSOpsWorksCMResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of a resource from which you want to remove tags. For example, \n arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.opsworkscm#TagKeyList", - "traits": { - "smithy.api#documentation": "

The keys of tags that you want to remove.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#UpdateServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#UpdateServerRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#UpdateServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Updates settings for a server.\n

\n

\n This operation is synchronous.\n

" - } - }, - "com.amazonaws.opsworkscm#UpdateServerEngineAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#UpdateServerEngineAttributesRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#UpdateServerEngineAttributesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Updates engine-specific attributes on a specified server. The server\n enters the MODIFYING state when this operation\n is in progress. Only one update can occur at a time.\n You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's \n admin password (PUPPET_ADMIN_PASSWORD).\n

\n

\n This operation is asynchronous.\n

\n

\n This operation can only be called for servers in HEALTHY or UNHEALTHY states. \n Otherwise, an InvalidStateException is raised.\n A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is \n raised when parameters of the request are not valid.\n

" - } - }, - "com.amazonaws.opsworkscm#UpdateServerEngineAttributesRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server to update.\n

", - "smithy.api#required": {} - } - }, - "AttributeName": { - "target": "com.amazonaws.opsworkscm#AttributeName", - "traits": { - "smithy.api#documentation": "

The name of the engine attribute to update.\n

", - "smithy.api#required": {} - } - }, - "AttributeValue": { - "target": "com.amazonaws.opsworkscm#AttributeValue", - "traits": { - "smithy.api#documentation": "

The value to set for the attribute.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#UpdateServerEngineAttributesResponse": { - "type": "structure", - "members": { - "Server": { - "target": "com.amazonaws.opsworkscm#Server", - "traits": { - "smithy.api#documentation": "

Contains the response to an UpdateServerEngineAttributes request.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#UpdateServerRequest": { - "type": "structure", - "members": { - "DisableAutomatedBackup": { - "target": "com.amazonaws.opsworkscm#Boolean", - "traits": { - "smithy.api#documentation": "

Setting DisableAutomatedBackup to true disables automated or scheduled backups. \n Automated backups are enabled by default.\n

" - } - }, - "BackupRetentionCount": { - "target": "com.amazonaws.opsworkscm#Integer", - "traits": { - "smithy.api#documentation": "

Sets the number of automated backups that you want to keep.\n

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server to update.\n

", - "smithy.api#required": {} - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition" - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#UpdateServerResponse": { - "type": "structure", - "members": { - "Server": { - "target": "com.amazonaws.opsworkscm#Server", - "traits": { - "smithy.api#documentation": "

Contains the response to a UpdateServer request.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#ValidationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

Error or informational message that can contain more detail about a validation failure.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more of the provided request parameters are not valid.\n

", - "smithy.api#error": "client" - } - } - } -} diff --git a/codegen/sdk/aws-models/organizations.json b/codegen/sdk/aws-models/organizations.json index ffef915c28c..426b14a1216 100644 --- a/codegen/sdk/aws-models/organizations.json +++ b/codegen/sdk/aws-models/organizations.json @@ -145,6 +145,9 @@ { "target": "com.amazonaws.organizations#ListAccountsForParent" }, + { + "target": "com.amazonaws.organizations#ListAccountsWithInvalidEffectivePolicy" + }, { "target": "com.amazonaws.organizations#ListAWSServiceAccessForOrganization" }, @@ -160,6 +163,9 @@ { "target": "com.amazonaws.organizations#ListDelegatedServicesForAccount" }, + { + "target": "com.amazonaws.organizations#ListEffectivePolicyValidationErrors" + }, { "target": "com.amazonaws.organizations#ListHandshakesForAccount" }, @@ -1286,17 +1292,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1310,17 +1305,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1365,17 +1349,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1389,17 +1362,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1652,7 +1614,13 @@ "Status": { "target": "com.amazonaws.organizations#AccountStatus", "traits": { - "smithy.api#documentation": "

The status of the account in the organization.

" + "smithy.api#documentation": "

The status of the account in the organization.

\n \n

The Status parameter in the Account object will be retired on September 9, 2026.\n Although both the account State and account Status parameters are currently\n available in the Organizations APIs (DescribeAccount, ListAccounts,\n ListAccountsForParent), we recommend that you update your scripts or other code to\n use the State parameter instead of Status before September 9, 2026.

\n
" + } + }, + "State": { + "target": "com.amazonaws.organizations#AccountState", + "traits": { + "smithy.api#documentation": "

Each state represents a specific phase in the account lifecycle. Use this information\n to manage account access, automate workflows, or trigger actions based on account state\n changes.

\n

For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the\n Organizations User Guide.

" } }, "JoinedMethod": { @@ -1781,6 +1749,41 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.organizations#AccountState": { + "type": "enum", + "members": { + "PENDING_ACTIVATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_ACTIVATION" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "SUSPENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUSPENDED" + } + }, + "PENDING_CLOSURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_CLOSURE" + } + }, + "CLOSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOSED" + } + } + } + }, "com.amazonaws.organizations#AccountStatus": { "type": "enum", "members": { @@ -2128,7 +2131,7 @@ } ], "traits": { - "smithy.api#documentation": "

Closes an Amazon Web Services member account within an organization. You can close an account when\n all\n features are enabled . You can't close the management account with this API.\n This is an asynchronous request that Amazon Web Services performs in the background. Because\n CloseAccount operates asynchronously, it can return a successful\n completion message even though account closure might still be in progress. You need to\n wait a few minutes before the account is fully closed. To check the status of the\n request, do one of the following:

\n
    \n
  • \n

    Use the AccountId that you sent in the CloseAccount\n request to provide as a parameter to the DescribeAccount\n operation.

    \n

    While the close account request is in progress, Account status will indicate\n PENDING_CLOSURE. When the close account request completes, the status will\n change to SUSPENDED.

    \n
  • \n
  • \n

    Check the CloudTrail log for the CloseAccountResult event that gets\n published after the account closes successfully. For information on using CloudTrail\n with Organizations, see Logging and monitoring in Organizations in the\n Organizations User Guide.

    \n
  • \n
\n \n
    \n
  • \n

    You can close only 10% of member accounts, between 10 and 1000, within a\n rolling 30 day period. This quota is not bound by a calendar month, but\n starts when you close an account. After you reach this limit, you can't close\n additional accounts. For more information, see Closing a member\n account in your organization and Quotas for\n Organizations in the Organizations User Guide.

    \n
  • \n
  • \n

    To reinstate a closed account, contact Amazon Web Services Support within the 90-day\n grace period while the account is in SUSPENDED status.

    \n
  • \n
  • \n

    If the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud\n (US) account, the CloseAccount request will close both\n accounts. To learn important pre-closure details, see \n Closing an Amazon Web Services GovCloud (US) account in the \n Amazon Web Services GovCloud User Guide.

    \n
  • \n
\n
" + "smithy.api#documentation": "

Closes an Amazon Web Services member account within an organization. You can close an account when\n all\n features are enabled . You can't close the management account with this API.\n This is an asynchronous request that Amazon Web Services performs in the background. Because\n CloseAccount operates asynchronously, it can return a successful\n completion message even though account closure might still be in progress. You need to\n wait a few minutes before the account is fully closed. To check the status of the\n request, do one of the following:

\n
    \n
  • \n

    Use the AccountId that you sent in the CloseAccount\n request to provide as a parameter to the DescribeAccount\n operation.

    \n

    While the close account request is in progress, Account status will indicate\n PENDING_CLOSURE. When the close account request completes, the status will\n change to SUSPENDED.

    \n
  • \n
  • \n

    Check the CloudTrail log for the CloseAccountResult event that gets\n published after the account closes successfully. For information on using CloudTrail\n with Organizations, see Logging and monitoring in Organizations in the\n Organizations User Guide.

    \n
  • \n
\n \n
    \n
  • \n

    You can close only 10% of member accounts, between 10 and 1000, within a\n rolling 30 day period. This quota is not bound by a calendar month, but\n starts when you close an account. After you reach this limit, you can't\n close additional accounts. For more information, see Closing a member\n account in your organization and Quotas for\n Organizations in the Organizations User Guide.

    \n
  • \n
  • \n

    To reinstate a closed account, contact Amazon Web Services Support within the 90-day\n grace period while the account is in SUSPENDED status.

    \n
  • \n
  • \n

    If the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud\n (US) account, the CloseAccount request will close both\n accounts. To learn important pre-closure details, see \n Closing an Amazon Web Services GovCloud (US) account in the \n Amazon Web Services GovCloud User Guide.

    \n
  • \n
\n
" } }, "com.amazonaws.organizations#CloseAccountRequest": { @@ -2453,7 +2456,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Web Services account that is automatically a member of the organization whose\n credentials made the request. This is an asynchronous request that Amazon Web Services performs in the\n background. Because CreateAccount operates asynchronously, it can return a\n successful completion message even though account initialization might still be in\n progress. You might need to wait a few minutes before you can successfully access the\n account. To check the status of the request, do one of the following:

\n
    \n
  • \n

    Use the Id value of the CreateAccountStatus response\n element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

    \n
  • \n
  • \n

    Check the CloudTrail log for the CreateAccountResult event. For\n information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the\n Organizations User Guide.

    \n
  • \n
\n

The user who calls the API to create an account must have the\n organizations:CreateAccount permission. If you enabled all features in\n the organization, Organizations creates the required service-linked role named\n AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the\n Organizations User Guide.

\n

If the request includes tags, then the requester must have the\n organizations:TagResource permission.

\n

Organizations preconfigures the new member account with a role (named\n OrganizationAccountAccessRole by default) that grants users in the\n management account administrator permissions in the new member account. Principals in\n the management account can assume the role. Organizations clones the company name and address\n information for the new account from the organization's management account.

\n

This operation can be called only from the organization's management account.

\n

For more information about creating accounts, see Creating\n a member account in your organization in the\n Organizations User Guide.

\n \n
    \n
  • \n

    When you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required for the account to operate\n as a standalone account, such as a payment method is not automatically\n collected. If you must remove an account from your organization later, you\n can do so only after you provide the missing information. For more\n information, see Considerations before removing an account from an organization\n in the Organizations User Guide.

    \n
  • \n
  • \n

    If you get an exception that indicates that you exceeded your account\n limits for the organization, contact Amazon Web Services Support.

    \n
  • \n
  • \n

    If you get an exception that indicates that the operation failed because\n your organization is still initializing, wait one hour and then try again.\n If the error persists, contact Amazon Web Services Support.

    \n
  • \n
  • \n

    It isn't recommended to use CreateAccount to create multiple temporary accounts, and using \n the CreateAccount API to close accounts is subject to a 30-day usage quota. For information on the requirements\n and process for closing an account, see Closing a member\n account in your organization in the\n Organizations User Guide.

    \n
  • \n
\n
\n \n

When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting access to\n your billing information and tools.

\n
", + "smithy.api#documentation": "

Creates an Amazon Web Services account that is automatically a member of the organization whose\n credentials made the request. This is an asynchronous request that Amazon Web Services performs in the\n background. Because CreateAccount operates asynchronously, it can return a\n successful completion message even though account initialization might still be in\n progress. You might need to wait a few minutes before you can successfully access the\n account. To check the status of the request, do one of the following:

\n
    \n
  • \n

    Use the Id value of the CreateAccountStatus response\n element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

    \n
  • \n
  • \n

    Check the CloudTrail log for the CreateAccountResult event. For\n information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the\n Organizations User Guide.

    \n
  • \n
\n

The user who calls the API to create an account must have the\n organizations:CreateAccount permission. If you enabled all features in\n the organization, Organizations creates the required service-linked role named\n AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the\n Organizations User Guide.

\n

If the request includes tags, then the requester must have the\n organizations:TagResource permission.

\n

Organizations preconfigures the new member account with a role (named\n OrganizationAccountAccessRole by default) that grants users in the\n management account administrator permissions in the new member account. Principals in\n the management account can assume the role. Organizations clones the company name and address\n information for the new account from the organization's management account.

\n

This operation can be called only from the organization's management account.

\n

For more information about creating accounts, see Creating\n a member account in your organization in the\n Organizations User Guide.

\n \n
    \n
  • \n

    When you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required for the account to operate\n as a standalone account, such as a payment method is\n not automatically collected. If you must remove an\n account from your organization later, you can do so only after you provide\n the missing information. For more information, see Considerations before removing an account from an organization\n in the Organizations User Guide.

    \n
  • \n
  • \n

    If you get an exception that indicates that you exceeded your account\n limits for the organization, contact Amazon Web Services Support.

    \n
  • \n
  • \n

    If you get an exception that indicates that the operation failed because\n your organization is still initializing, wait one hour and then try again.\n If the error persists, contact Amazon Web Services Support.

    \n
  • \n
  • \n

    It isn't recommended to use CreateAccount to create multiple\n temporary accounts, and using the CreateAccount API to close\n accounts is subject to a 30-day usage quota. For information on the\n requirements and process for closing an account, see Closing a member\n account in your organization in the\n Organizations User Guide.

    \n
  • \n
\n
\n \n

When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting access to\n your billing information and tools.

\n
", "smithy.api#examples": [ { "title": "To create a new account that is automatically part of the organization", @@ -3714,7 +3717,7 @@ "Account": { "target": "com.amazonaws.organizations#Account", "traits": { - "smithy.api#documentation": "

A structure that contains information about the requested account.

" + "smithy.api#documentation": "

A structure that contains information about the requested account.

\n \n

The Status parameter in the API response will be retired on September 9, 2026.\n Although both the account State and account Status parameters are currently\n available in the Organizations APIs (DescribeAccount, ListAccounts,\n ListAccountsForParent), we recommend that you update your scripts or other code to\n use the State parameter instead of Status before September 9, 2026.

\n
" } } }, @@ -3840,7 +3843,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the contents of the effective policy for specified policy type and account.\n The effective policy is the aggregation of any policies of the specified type that the\n account inherits, plus any policy of that type that is directly attached to the\n account.

\n

This operation applies only to management policies. It does not apply to authorization policies: service\n control policies (SCPs) and resource control policies (RCPs).

\n

For more information about policy inheritance, see Understanding\n management policy inheritance in the\n Organizations User Guide.

\n

This operation can be called from any account in the organization.

" + "smithy.api#documentation": "

Returns the contents of the effective policy for specified policy type and account.\n The effective policy is the aggregation of any policies of the specified type that the\n account inherits, plus any policy of that type that is directly attached to the\n account.

\n

This operation applies only to management policies. It does not apply to authorization\n policies: service control policies (SCPs) and resource control policies (RCPs).

\n

For more information about policy inheritance, see Understanding\n management policy inheritance in the\n Organizations User Guide.

\n

This operation can be called from any account in the organization.

" } }, "com.amazonaws.organizations#DescribeEffectivePolicyRequest": { @@ -4044,7 +4047,7 @@ "Organization": { "target": "com.amazonaws.organizations#Organization", "traits": { - "smithy.api#documentation": "

A structure that contains information about the organization.

\n \n

The AvailablePolicyTypes part of the response is deprecated, and you\n shouldn't use it in your apps. It doesn't include any policy type supported by Organizations\n other than SCPs. In the China (Ningxia) Region, no policy type is included.\n To determine which policy types are enabled in your organization,\n use the \n ListRoots\n operation.

\n
" + "smithy.api#documentation": "

A structure that contains information about the organization.

\n \n

The AvailablePolicyTypes part of the response is deprecated, and you\n shouldn't use it in your apps. It doesn't include any policy type supported by Organizations\n other than SCPs. In the China (Ningxia) Region, no policy type is included. To\n determine which policy types are enabled in your organization, use the \n ListRoots\n operation.

\n
" } } }, @@ -4456,7 +4459,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables an organizational policy type in a root. A policy of a certain type can be\n attached to entities in a root only if that type is enabled in the root. After you\n perform this operation, you no longer can attach policies of the specified type to that\n root or to any organizational unit (OU) or account in that root. You can undo this by\n using the EnablePolicyType operation.

\n

This is an asynchronous request that Amazon Web Services performs in the background. If you disable\n a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. Amazon Web Services recommends that you\n first use ListRoots to see the status of policy types for a specified\n root, and then use this operation.

\n

This operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator.

\n

To view the status of available policy types in the organization, use DescribeOrganization.

", + "smithy.api#documentation": "

Disables an organizational policy type in a root. A policy of a certain type can be\n attached to entities in a root only if that type is enabled in the root. After you\n perform this operation, you no longer can attach policies of the specified type to that\n root or to any organizational unit (OU) or account in that root. You can undo this by\n using the EnablePolicyType operation.

\n

This is an asynchronous request that Amazon Web Services performs in the background. If you disable\n a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. Amazon Web Services recommends that you\n first use ListRoots to see the status of policy types for a specified\n root, and then use this operation.

\n

This operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator.

\n

To view the status of available policy types in the organization, use ListRoots.

", "smithy.api#examples": [ { "title": "To disable a policy type in a root", @@ -4663,6 +4666,44 @@ } } }, + "com.amazonaws.organizations#EffectivePolicyValidationError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.organizations#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code for the validation error. For example,\n ELEMENTS_TOO_MANY.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.organizations#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message for the validation error.

" + } + }, + "PathToError": { + "target": "com.amazonaws.organizations#PathToError", + "traits": { + "smithy.api#documentation": "

The path within the effective policy where the validation error occurred.

" + } + }, + "ContributingPolicies": { + "target": "com.amazonaws.organizations#PolicyIds", + "traits": { + "smithy.api#documentation": "

The individual policies inherited and attached to\n the account which contributed to the validation error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the validation errors that occurred when generating or\n enforcing an effective\n policy, such as which policies contributed to the error and location of the\n error.

" + } + }, + "com.amazonaws.organizations#EffectivePolicyValidationErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.organizations#EffectivePolicyValidationError" + } + }, "com.amazonaws.organizations#Email": { "type": "string", "traits": { @@ -4709,7 +4750,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides an Amazon Web Services service (the service that is specified by\n ServicePrincipal) with permissions to view the structure of an organization, \n create a service-linked role in all the accounts in the organization,\n and allow the service to perform operations\n on behalf of the organization and its accounts. Establishing these permissions can be a first step\n in enabling the integration of an Amazon Web Services service with Organizations.

\n \n

We recommend that you enable integration between Organizations and the specified Amazon Web Services\n service by using the console or commands that are provided by the specified service.\n Doing so ensures that the service is aware that it can create the resources that are\n required for the integration. How the service creates those resources in the\n organization's accounts depends on that service. For more information, see the\n documentation for the other Amazon Web Services service.

\n
\n

For more information about enabling services to integrate with Organizations, see Using\n Organizations with other Amazon Web Services services in the\n Organizations User Guide.

\n

This operation can be called only from the organization's management account.

" + "smithy.api#documentation": "

Provides an Amazon Web Services service (the service that is specified by\n ServicePrincipal) with permissions to view the structure of an\n organization, create a service-linked role in\n all the accounts in the organization, and allow the service to perform operations on\n behalf of the organization and its accounts. Establishing these permissions can be a\n first step in enabling the integration of an Amazon Web Services service with Organizations.

\n \n

We recommend that you enable integration between Organizations and the specified Amazon Web Services\n service by using the console or commands that are provided by the specified service.\n Doing so ensures that the service is aware that it can create the resources that are\n required for the integration. How the service creates those resources in the\n organization's accounts depends on that service. For more information, see the\n documentation for the other Amazon Web Services service.

\n
\n

For more information about enabling services to integrate with Organizations, see Using\n Organizations with other Amazon Web Services services in the\n Organizations User Guide.

\n

This operation can be called only from the organization's management account.

" } }, "com.amazonaws.organizations#EnableAWSServiceAccessRequest": { @@ -4861,7 +4902,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables a policy type in a root. After you enable a policy type in a root, you can\n attach policies of that type to the root, any organizational unit (OU), or account in\n that root. You can undo this by using the DisablePolicyType\n operation.

\n

This is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services\n recommends that you first use ListRoots to see the status of policy\n types for a specified root, and then use this operation.

\n

This operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator.

\n

You can enable a policy type in a root only if that policy type is available in the\n organization. To view the status of available policy types in the organization, use\n DescribeOrganization.

", + "smithy.api#documentation": "

Enables a policy type in a root. After you enable a policy type in a root, you can\n attach policies of that type to the root, any organizational unit (OU), or account in\n that root. You can undo this by using the DisablePolicyType\n operation.

\n

This is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services\n recommends that you first use ListRoots to see the status of policy\n types for a specified root, and then use this operation.

\n

This operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator.

\n

You can enable a policy type in a root only if that policy type is available in the\n organization. To view the status of available policy types in the organization, use\n ListRoots.

", "smithy.api#examples": [ { "title": "To enable a policy type in a root", @@ -4949,6 +4990,12 @@ "target": "com.amazonaws.organizations#EnabledServicePrincipal" } }, + "com.amazonaws.organizations#ErrorCode": { + "type": "string" + }, + "com.amazonaws.organizations#ErrorMessage": { + "type": "string" + }, "com.amazonaws.organizations#ExceptionMessage": { "type": "string" }, @@ -5659,7 +5706,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends an invitation to another account to join your organization as a member account.\n Organizations sends email on your behalf to the email address that is associated with the\n other account's owner. The invitation is implemented as a Handshake\n whose details are in the response.

\n \n

If you receive an exception that indicates that you exceeded your account\n limits for the organization or that the operation failed because your\n organization is still initializing, wait one hour and then try again. If the\n error persists after an hour, contact Amazon Web Services Support.

\n
\n

If the request includes tags, then the requester must have the\n organizations:TagResource permission.

\n

This operation can be called only from the organization's management account.

", + "smithy.api#documentation": "

Sends an invitation to another account to join your organization as a member account.\n Organizations sends email on your behalf to the email address that is associated with the\n other account's owner. The invitation is implemented as a Handshake\n whose details are in the response.

\n \n

If you receive an exception that indicates that you exceeded your account limits\n for the organization or that the operation failed because your organization is still\n initializing, wait one hour and then try again. If the error persists after an hour,\n contact Amazon Web Services\n Support.

\n
\n

If the request includes tags, then the requester must have the\n organizations:TagResource permission.

\n

This operation can be called only from the organization's management account.

", "smithy.api#examples": [ { "title": "To invite an account to join an organization", @@ -5798,7 +5845,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a member account from its parent organization. This version of the operation\n is performed by the account that wants to leave. To remove a member account as a user in\n the management account, use RemoveAccountFromOrganization\n instead.

\n

This operation can be called only from a member account in the organization.

\n \n
    \n
  • \n

    The management account in an organization with all features enabled can\n set service control policies (SCPs) that can restrict what administrators of\n member accounts can do. This includes preventing them from successfully\n calling LeaveOrganization and leaving the organization.

    \n
  • \n
  • \n

    You can leave an organization as a member account only if the account is\n configured with the information required to operate as a standalone account.\n When you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required of standalone accounts is\n not automatically collected. For each account that\n you want to make standalone, you must perform the following steps. If any of\n the steps are already completed for this account, that step doesn't\n appear.

    \n
      \n
    • \n

      Choose a support plan

      \n
    • \n
    • \n

      Provide and verify the required contact information

      \n
    • \n
    • \n

      Provide a current payment method

      \n
    • \n
    \n

    Amazon Web Services uses the payment method to charge for any billable (not free tier)\n Amazon Web Services activity that occurs while the account isn't attached to an\n organization. For more information, see Considerations before removing an account from an organization\n in the Organizations User Guide.

    \n
  • \n
  • \n

    The account that you want to leave must not be a delegated administrator\n account for any Amazon Web Services service enabled for your organization. If the account\n is a delegated administrator, you must first change the delegated\n administrator account to another account that is remaining in the\n organization.

    \n
  • \n
  • \n

    After the account leaves the organization, all tags that were attached to\n the account object in the organization are deleted. Amazon Web Services accounts outside\n of an organization do not support tags.

    \n
  • \n
  • \n

    A newly created account has a waiting period before it can be removed from\n its organization.\n You must wait until at least seven days after the account was created. Invited accounts aren't subject to this waiting period.

    \n
  • \n
  • \n

    If you are using an organization principal to call\n LeaveOrganization across multiple accounts, you can only do\n this up to 5 accounts per second in a single organization.

    \n
  • \n
\n
", + "smithy.api#documentation": "

Removes a member account from its parent organization. This version of the operation\n is performed by the account that wants to leave. To remove a member account as a user in\n the management account, use RemoveAccountFromOrganization\n instead.

\n

This operation can be called only from a member account in the organization.

\n \n
    \n
  • \n

    The management account in an organization with all features enabled can\n set service control policies (SCPs) that can restrict what administrators of\n member accounts can do. This includes preventing them from successfully\n calling LeaveOrganization and leaving the organization.

    \n
  • \n
  • \n

    You can leave an organization as a member account only if the account is\n configured with the information required to operate as a standalone account.\n When you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required of standalone accounts is\n not automatically collected. For each account that\n you want to make standalone, you must perform the following steps. If any of\n the steps are already completed for this account, that step doesn't\n appear.

    \n
      \n
    • \n

      Choose a support plan

      \n
    • \n
    • \n

      Provide and verify the required contact information

      \n
    • \n
    • \n

      Provide a current payment method

      \n
    • \n
    \n

    Amazon Web Services uses the payment method to charge for any billable (not free tier)\n Amazon Web Services activity that occurs while the account isn't attached to an\n organization. For more information, see Considerations before removing an account from an organization\n in the Organizations User Guide.

    \n
  • \n
  • \n

    The account that you want to leave must not be a delegated administrator\n account for any Amazon Web Services service enabled for your organization. If the account\n is a delegated administrator, you must first change the delegated\n administrator account to another account that is remaining in the\n organization.

    \n
  • \n
  • \n

    After the account leaves the organization, all tags that were attached to\n the account object in the organization are deleted. Amazon Web Services accounts outside\n of an organization do not support tags.

    \n
  • \n
  • \n

    A newly created account has a waiting period before it can be removed from\n its organization. You must wait until at least seven days after the account\n was created. Invited accounts aren't subject to this waiting period.

    \n
  • \n
  • \n

    If you are using an organization principal to call\n LeaveOrganization across multiple accounts, you can only do\n this up to 5 accounts per second in a single organization.

    \n
  • \n
\n
", "smithy.api#examples": [ { "title": "To leave an organization as a member account", @@ -6022,7 +6069,7 @@ "Accounts": { "target": "com.amazonaws.organizations#Accounts", "traits": { - "smithy.api#documentation": "

A list of the accounts in the specified root or OU.

" + "smithy.api#documentation": "

A list of the accounts in the specified root or OU.

\n \n

The Status parameter in the API response will be retired on September 9, 2026.\n Although both the account State and account Status parameters are currently\n available in the Organizations APIs (DescribeAccount, ListAccounts,\n ListAccountsForParent), we recommend that you update your scripts or other code to\n use the State parameter instead of Status before September 9, 2026.

\n
" } }, "NextToken": { @@ -6062,7 +6109,137 @@ "Accounts": { "target": "com.amazonaws.organizations#Accounts", "traits": { - "smithy.api#documentation": "

A list of objects in the organization.

" + "smithy.api#documentation": "

A list of objects in the organization.

\n \n

The Status parameter in the API response will be retired on September 9, 2026.\n Although both the account State and account Status parameters are currently\n available in the Organizations APIs (DescribeAccount, ListAccounts,\n ListAccountsForParent), we recommend that you update your scripts or other code to\n use the State parameter instead of Status before September 9, 2026.

\n
" + } + }, + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.organizations#ListAccountsWithInvalidEffectivePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.organizations#ListAccountsWithInvalidEffectivePolicyRequest" + }, + "output": { + "target": "com.amazonaws.organizations#ListAccountsWithInvalidEffectivePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.organizations#AccessDeniedException" + }, + { + "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.organizations#ConstraintViolationException" + }, + { + "target": "com.amazonaws.organizations#EffectivePolicyNotFoundException" + }, + { + "target": "com.amazonaws.organizations#InvalidInputException" + }, + { + "target": "com.amazonaws.organizations#ServiceException" + }, + { + "target": "com.amazonaws.organizations#TooManyRequestsException" + }, + { + "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the accounts in an organization that have invalid effective policies. An\n invalid effective policy is an effective\n policy that fails validation checks, resulting in the effective policy not\n being fully enforced on all the intended accounts within an organization.

\n

This operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator.

", + "smithy.api#examples": [ + { + "title": "To list all accounts in an organization with invalid effective policy", + "documentation": "The following example shows you how to request a list of the accounts in an organization having invalid effective policy for a policy type:", + "input": { + "PolicyType": "BACKUP_POLICY" + }, + "output": { + "Accounts": [ + { + "Id": "111111111111", + "Name": "Management Account", + "Email": "bill@example.com" + }, + { + "Id": "222222222222", + "Name": "Developer Account", + "Email": "alice@example.com" + }, + { + "Id": "333333333333", + "Name": "Test Account", + "Email": "juan@example.com" + }, + { + "Id": "444444444444", + "Name": "Production Account", + "Email": "anika@example.com" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Accounts", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.organizations#ListAccountsWithInvalidEffectivePolicyRequest": { + "type": "structure", + "members": { + "PolicyType": { + "target": "com.amazonaws.organizations#EffectivePolicyType", + "traits": { + "smithy.api#documentation": "

The type of policy that you want information about. You can specify one of the\n following values:

\n ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.organizations#MaxResults", + "traits": { + "smithy.api#documentation": "

The total number of results that you want included on each page of the \n response. If you do not include this parameter, it defaults to a value that is specific to the \n operation. If additional items exist beyond the maximum you specify, the NextToken \n response element is present and has a value (is not null). Include that value as the \n NextToken request parameter in the next call to the operation to get the next part \n of the results. Note that Organizations might return fewer results than the maximum even when there are \n more results available. You should check NextToken after every operation to ensure \n that you receive all of the results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.organizations#ListAccountsWithInvalidEffectivePolicyResponse": { + "type": "structure", + "members": { + "Accounts": { + "target": "com.amazonaws.organizations#Accounts", + "traits": { + "smithy.api#documentation": "

The accounts in the organization which have an invalid effective policy for the specified policy type.

" + } + }, + "PolicyType": { + "target": "com.amazonaws.organizations#EffectivePolicyType", + "traits": { + "smithy.api#documentation": "

The specified policy type. One of the\n following values:

\n " } }, "NextToken": { @@ -6495,6 +6672,131 @@ "smithy.api#output": {} } }, + "com.amazonaws.organizations#ListEffectivePolicyValidationErrors": { + "type": "operation", + "input": { + "target": "com.amazonaws.organizations#ListEffectivePolicyValidationErrorsRequest" + }, + "output": { + "target": "com.amazonaws.organizations#ListEffectivePolicyValidationErrorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.organizations#AccessDeniedException" + }, + { + "target": "com.amazonaws.organizations#AccountNotFoundException" + }, + { + "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.organizations#ConstraintViolationException" + }, + { + "target": "com.amazonaws.organizations#EffectivePolicyNotFoundException" + }, + { + "target": "com.amazonaws.organizations#InvalidInputException" + }, + { + "target": "com.amazonaws.organizations#ServiceException" + }, + { + "target": "com.amazonaws.organizations#TooManyRequestsException" + }, + { + "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the validation errors on an effective\n policy for a specified account and policy type.

\n

This operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "EffectivePolicyValidationErrors", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.organizations#ListEffectivePolicyValidationErrorsRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.organizations#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account that you want details about. Specifying an organization root or\n organizational unit (OU) as the target is not supported.

", + "smithy.api#required": {} + } + }, + "PolicyType": { + "target": "com.amazonaws.organizations#EffectivePolicyType", + "traits": { + "smithy.api#documentation": "

The type of policy that you want information about. You can specify one of the\n following values:

\n ", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.organizations#MaxResults", + "traits": { + "smithy.api#documentation": "

The total number of results that you want included on each page of the \n response. If you do not include this parameter, it defaults to a value that is specific to the \n operation. If additional items exist beyond the maximum you specify, the NextToken \n response element is present and has a value (is not null). Include that value as the \n NextToken request parameter in the next call to the operation to get the next part \n of the results. Note that Organizations might return fewer results than the maximum even when there are \n more results available. You should check NextToken after every operation to ensure \n that you receive all of the results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.organizations#ListEffectivePolicyValidationErrorsResponse": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.organizations#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the specified account.

" + } + }, + "PolicyType": { + "target": "com.amazonaws.organizations#EffectivePolicyType", + "traits": { + "smithy.api#documentation": "

The specified policy type. One of the following values:

\n " + } + }, + "Path": { + "target": "com.amazonaws.organizations#Path", + "traits": { + "smithy.api#documentation": "

The path in the organization where the specified account exists.

" + } + }, + "EvaluationTimestamp": { + "target": "com.amazonaws.organizations#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the latest effective policy was generated for the specified\n account.

" + } + }, + "NextToken": { + "target": "com.amazonaws.organizations#NextToken", + "traits": { + "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" + } + }, + "EffectivePolicyValidationErrors": { + "target": "com.amazonaws.organizations#EffectivePolicyValidationErrors", + "traits": { + "smithy.api#documentation": "

The EffectivePolicyValidationError object contains details about the\n validation errors that occurred when generating or enforcing an effective policy, such\n as which policies contributed to the error and location of the error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.organizations#ListHandshakesForAccount": { "type": "operation", "input": { @@ -7767,7 +8069,7 @@ "Id": { "target": "com.amazonaws.organizations#OrganizationalUnitId", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) associated with this OU. The ID is unique to the organization only.

\n

The regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters \n or digits.

" + "smithy.api#documentation": "

The unique identifier (ID) associated with this OU. The ID is unique to the\n organization only.

\n

The regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters \n or digits.

" } }, "Arn": { @@ -7911,6 +8213,15 @@ "target": "com.amazonaws.organizations#Parent" } }, + "com.amazonaws.organizations#Path": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(o-[a-z0-9]{10,32}\\/r-[0-9a-z]{4,32}(\\/ou\\-[0-9a-z]{4,32}-[a-z0-9]{8,32})*(\\/\\d{12})*)\\/$" + } + }, + "com.amazonaws.organizations#PathToError": { + "type": "string" + }, "com.amazonaws.organizations#Policies": { "type": "list", "member": { @@ -7984,6 +8295,12 @@ "smithy.api#pattern": "^p-[0-9a-zA-Z_]{8,128}$" } }, + "com.amazonaws.organizations#PolicyIds": { + "type": "list", + "member": { + "target": "com.amazonaws.organizations#PolicyId" + } + }, "com.amazonaws.organizations#PolicyInUseException": { "type": "structure", "members": { @@ -8566,7 +8883,7 @@ "Id": { "target": "com.amazonaws.organizations#RootId", "traits": { - "smithy.api#documentation": "

The unique identifier (ID) for the root. The ID is unique to the organization only.

\n

The regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.

" + "smithy.api#documentation": "

The unique identifier (ID) for the root. The ID is unique to the organization\n only.

\n

The regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.

" } }, "Arn": { diff --git a/codegen/sdk/aws-models/osis.json b/codegen/sdk/aws-models/osis.json index e65a6910f52..94f684074c6 100644 --- a/codegen/sdk/aws-models/osis.json +++ b/codegen/sdk/aws-models/osis.json @@ -49,9 +49,18 @@ { "target": "com.amazonaws.osis#CreatePipeline" }, + { + "target": "com.amazonaws.osis#CreatePipelineEndpoint" + }, { "target": "com.amazonaws.osis#DeletePipeline" }, + { + "target": "com.amazonaws.osis#DeletePipelineEndpoint" + }, + { + "target": "com.amazonaws.osis#DeleteResourcePolicy" + }, { "target": "com.amazonaws.osis#GetPipeline" }, @@ -61,15 +70,30 @@ { "target": "com.amazonaws.osis#GetPipelineChangeProgress" }, + { + "target": "com.amazonaws.osis#GetResourcePolicy" + }, { "target": "com.amazonaws.osis#ListPipelineBlueprints" }, + { + "target": "com.amazonaws.osis#ListPipelineEndpointConnections" + }, + { + "target": "com.amazonaws.osis#ListPipelineEndpoints" + }, { "target": "com.amazonaws.osis#ListPipelines" }, { "target": "com.amazonaws.osis#ListTagsForResource" }, + { + "target": "com.amazonaws.osis#PutResourcePolicy" + }, + { + "target": "com.amazonaws.osis#RevokePipelineEndpointConnections" + }, { "target": "com.amazonaws.osis#StartPipeline" }, @@ -614,17 +638,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -638,17 +651,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -662,17 +664,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -686,17 +677,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -772,6 +752,16 @@ } } }, + "com.amazonaws.osis#AwsAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\\\d{12}$" + } + }, "com.amazonaws.osis#BlueprintFormat": { "type": "string", "traits": { @@ -997,7 +987,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.

", + "smithy.api#documentation": "

Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch\n Ingestion pipelines.

", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/createPipeline", @@ -1005,13 +995,104 @@ } } }, + "com.amazonaws.osis#CreatePipelineEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.osis#CreatePipelineEndpointRequest" + }, + "output": { + "target": "com.amazonaws.osis#CreatePipelineEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.osis#AccessDeniedException" + }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, + { + "target": "com.amazonaws.osis#InternalException" + }, + { + "target": "com.amazonaws.osis#LimitExceededException" + }, + { + "target": "com.amazonaws.osis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.osis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a VPC endpoint for an OpenSearch Ingestion pipeline. Pipeline endpoints allow you to\n ingest data from your VPC into pipelines that you have access to.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2022-01-01/osis/createPipelineEndpoint", + "code": 200 + } + } + }, + "com.amazonaws.osis#CreatePipelineEndpointRequest": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.osis#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline to create the endpoint for.

", + "smithy.api#required": {} + } + }, + "VpcOptions": { + "target": "com.amazonaws.osis#PipelineEndpointVpcOptions", + "traits": { + "smithy.api#documentation": "

Container for the VPC configuration for the pipeline endpoint, including subnet IDs and\n security group IDs.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.osis#CreatePipelineEndpointResponse": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.osis#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline associated with the endpoint.

" + } + }, + "EndpointId": { + "target": "com.amazonaws.osis#PipelineEndpointId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the pipeline endpoint.

" + } + }, + "Status": { + "target": "com.amazonaws.osis#PipelineEndpointStatus", + "traits": { + "smithy.api#documentation": "

The current status of the pipeline endpoint.

" + } + }, + "VpcId": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "

The ID of the VPC where the pipeline endpoint was created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.osis#CreatePipelineRequest": { "type": "structure", "members": { "PipelineName": { "target": "com.amazonaws.osis#PipelineName", "traits": { - "smithy.api#documentation": "

The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines\n owned by an account within an Amazon Web Services Region.

", + "smithy.api#documentation": "

The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the\n pipelines owned by an account within an Amazon Web Services Region.

", "smithy.api#required": {} } }, @@ -1045,7 +1126,7 @@ "VpcOptions": { "target": "com.amazonaws.osis#VpcOptions", "traits": { - "smithy.api#documentation": "

Container for the values required to configure VPC access for the pipeline. If you don't specify\n these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

" + "smithy.api#documentation": "

Container for the values required to configure VPC access for the pipeline. If you don't\n specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

" } }, "BufferOptions": { @@ -1057,7 +1138,7 @@ "EncryptionAtRestOptions": { "target": "com.amazonaws.osis#EncryptionAtRestOptions", "traits": { - "smithy.api#documentation": "

Key-value pairs to configure encryption for data that is written to a persistent buffer.

" + "smithy.api#documentation": "

Key-value pairs to configure encryption for data that is written to a persistent\n buffer.

" } }, "Tags": { @@ -1069,7 +1150,7 @@ "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.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that grants the pipeline permission to access\n Amazon Web Services resources.

" } } }, @@ -1120,7 +1201,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.

", + "smithy.api#documentation": "

Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch\n Ingestion pipelines.

", "smithy.api#http": { "method": "DELETE", "uri": "/2022-01-01/osis/deletePipeline/{PipelineName}", @@ -1128,6 +1209,61 @@ } } }, + "com.amazonaws.osis#DeletePipelineEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.osis#DeletePipelineEndpointRequest" + }, + "output": { + "target": "com.amazonaws.osis#DeletePipelineEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.osis#AccessDeniedException" + }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, + { + "target": "com.amazonaws.osis#InternalException" + }, + { + "target": "com.amazonaws.osis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a VPC endpoint for an OpenSearch Ingestion pipeline.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2022-01-01/osis/deletePipelineEndpoint/{EndpointId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.osis#DeletePipelineEndpointRequest": { + "type": "structure", + "members": { + "EndpointId": { + "target": "com.amazonaws.osis#PipelineEndpointId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the pipeline endpoint to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.osis#DeletePipelineEndpointResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.osis#DeletePipelineRequest": { "type": "structure", "members": { @@ -1151,6 +1287,67 @@ "smithy.api#output": {} } }, + "com.amazonaws.osis#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.osis#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.osis#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.osis#AccessDeniedException" + }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, + { + "target": "com.amazonaws.osis#InternalException" + }, + { + "target": "com.amazonaws.osis#LimitExceededException" + }, + { + "target": "com.amazonaws.osis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.osis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a resource-based policy from an OpenSearch Ingestion resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2022-01-01/osis/resourcePolicy/{ResourceArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.osis#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.osis#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which to delete the policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.osis#DeleteResourcePolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.osis#DisabledOperationException": { "type": "structure", "members": { @@ -1387,33 +1584,106 @@ "smithy.api#output": {} } }, - "com.amazonaws.osis#IngestEndpointUrlsList": { - "type": "list", - "member": { - "target": "com.amazonaws.osis#String" - } - }, - "com.amazonaws.osis#Integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.osis#InternalException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.osis#ErrorMessage" - } + "com.amazonaws.osis#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.osis#GetResourcePolicyRequest" }, - "traits": { - "smithy.api#documentation": "

The request failed because of an unknown error, exception, or failure (the failure is\n internal to the service).

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.osis#InvalidPaginationTokenException": { - "type": "structure", + "output": { + "target": "com.amazonaws.osis#GetResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.osis#AccessDeniedException" + }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, + { + "target": "com.amazonaws.osis#InternalException" + }, + { + "target": "com.amazonaws.osis#LimitExceededException" + }, + { + "target": "com.amazonaws.osis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.osis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the resource-based policy attached to an OpenSearch Ingestion resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2022-01-01/osis/resourcePolicy/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.osis#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.osis#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which to retrieve the policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.osis#GetResourcePolicyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.osis#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "Policy": { + "target": "com.amazonaws.osis#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The resource-based policy document in JSON format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.osis#IngestEndpointUrlsList": { + "type": "list", + "member": { + "target": "com.amazonaws.osis#String" + } + }, + "com.amazonaws.osis#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.osis#InternalException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.osis#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request failed because of an unknown error, exception, or failure (the failure is\n internal to the service).

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.osis#InvalidPaginationTokenException": { + "type": "structure", "members": { "message": { "target": "com.amazonaws.osis#ErrorMessage" @@ -1473,7 +1743,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of all available blueprints for Data Prepper. For more information, see\n Using blueprints to create a pipeline.

", + "smithy.api#documentation": "

Retrieves a list of all available blueprints for Data Prepper. For more information, see\n Using\n blueprints to create a pipeline.

", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/listPipelineBlueprints", @@ -1502,6 +1772,170 @@ "smithy.api#output": {} } }, + "com.amazonaws.osis#ListPipelineEndpointConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.osis#ListPipelineEndpointConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.osis#ListPipelineEndpointConnectionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.osis#AccessDeniedException" + }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, + { + "target": "com.amazonaws.osis#InternalException" + }, + { + "target": "com.amazonaws.osis#LimitExceededException" + }, + { + "target": "com.amazonaws.osis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the pipeline endpoints connected to pipelines in your account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2022-01-01/osis/listPipelineEndpointConnections", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PipelineEndpointConnections", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.osis#ListPipelineEndpointConnectionsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.osis#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of pipeline endpoint connections to return in the response.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.osis#NextToken", + "traits": { + "smithy.api#documentation": "

If your initial ListPipelineEndpointConnections operation returns a\n nextToken, you can include the returned nextToken in subsequent\n ListPipelineEndpointConnections operations, which returns results in the next\n page.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.osis#ListPipelineEndpointConnectionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.osis#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. Make the call again using the\n returned token to retrieve the next page.

" + } + }, + "PipelineEndpointConnections": { + "target": "com.amazonaws.osis#PipelineEndpointConnectionsSummaryList", + "traits": { + "smithy.api#documentation": "

A list of pipeline endpoint connections.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.osis#ListPipelineEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.osis#ListPipelineEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.osis#ListPipelineEndpointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.osis#AccessDeniedException" + }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, + { + "target": "com.amazonaws.osis#InternalException" + }, + { + "target": "com.amazonaws.osis#LimitExceededException" + }, + { + "target": "com.amazonaws.osis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all pipeline endpoints in your account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2022-01-01/osis/listPipelineEndpoints", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PipelineEndpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.osis#ListPipelineEndpointsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.osis#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of pipeline endpoints to return in the response.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.osis#NextToken", + "traits": { + "smithy.api#documentation": "

If your initial ListPipelineEndpoints operation returns a\n NextToken, you can include the returned NextToken in subsequent\n ListPipelineEndpoints operations, which returns results in the next page.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.osis#ListPipelineEndpointsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.osis#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. Make the call again using the\n returned token to retrieve the next page.

" + } + }, + "PipelineEndpoints": { + "target": "com.amazonaws.osis#PipelineEndpointsSummaryList", + "traits": { + "smithy.api#documentation": "

A list of pipeline endpoints.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.osis#ListPipelines": { "type": "operation", "input": { @@ -1528,7 +1962,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For\n more information, see Viewing Amazon OpenSearch Ingestion pipelines.

", + "smithy.api#documentation": "

Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.\n For more information, see Viewing Amazon OpenSearch\n Ingestion pipelines.

", "smithy.api#http": { "method": "GET", "uri": "/2022-01-01/osis/listPipelines", @@ -1547,7 +1981,7 @@ "MaxResults": { "target": "com.amazonaws.osis#MaxResults", "traits": { - "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" } }, @@ -1569,7 +2003,7 @@ "NextToken": { "target": "com.amazonaws.osis#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. Make the call 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. Make the call again using the\n returned token to retrieve the next page.

" } }, "Pipelines": { @@ -1806,7 +2240,7 @@ "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.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS\n resources.

" } } }, @@ -1947,6 +2381,171 @@ "target": "com.amazonaws.osis#PipelineDestination" } }, + "com.amazonaws.osis#PipelineEndpoint": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.osis#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline associated with this endpoint.

" + } + }, + "EndpointId": { + "target": "com.amazonaws.osis#PipelineEndpointId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the pipeline endpoint.

" + } + }, + "Status": { + "target": "com.amazonaws.osis#PipelineEndpointStatus", + "traits": { + "smithy.api#documentation": "

The current status of the pipeline endpoint.

" + } + }, + "VpcId": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "

The ID of the VPC where the pipeline endpoint is created.

" + } + }, + "VpcOptions": { + "target": "com.amazonaws.osis#PipelineEndpointVpcOptions", + "traits": { + "smithy.api#documentation": "

Configuration options for the VPC endpoint, including subnet and security group\n settings.

" + } + }, + "IngestEndpointUrl": { + "target": "com.amazonaws.osis#String", + "traits": { + "smithy.api#documentation": "

The URL used to ingest data to the pipeline through the VPC endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a VPC endpoint for an OpenSearch Ingestion pipeline, enabling private\n connectivity between your VPC and the pipeline.

" + } + }, + "com.amazonaws.osis#PipelineEndpointConnection": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.osis#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline in the endpoint connection.

" + } + }, + "EndpointId": { + "target": "com.amazonaws.osis#PipelineEndpointId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the endpoint in the connection.

" + } + }, + "Status": { + "target": "com.amazonaws.osis#PipelineEndpointStatus", + "traits": { + "smithy.api#documentation": "

The current status of the pipeline endpoint connection.

" + } + }, + "VpcEndpointOwner": { + "target": "com.amazonaws.osis#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the VPC endpoint used in this connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a connection to a pipeline endpoint, containing details about the endpoint\n association.

" + } + }, + "com.amazonaws.osis#PipelineEndpointConnectionsSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.osis#PipelineEndpointConnection" + } + }, + "com.amazonaws.osis#PipelineEndpointId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.osis#PipelineEndpointIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.osis#PipelineEndpointId" + } + }, + "com.amazonaws.osis#PipelineEndpointStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "REVOKING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKING" + } + }, + "REVOKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKED" + } + } + } + }, + "com.amazonaws.osis#PipelineEndpointVpcOptions": { + "type": "structure", + "members": { + "SubnetIds": { + "target": "com.amazonaws.osis#SubnetIds", + "traits": { + "smithy.api#documentation": "

A list of subnet IDs where the pipeline endpoint network interfaces are created.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.osis#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

A list of security group IDs that control network access to the pipeline endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration settings for the VPC endpoint, specifying network access controls.

" + } + }, + "com.amazonaws.osis#PipelineEndpointsSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.osis#PipelineEndpoint" + } + }, "com.amazonaws.osis#PipelineName": { "type": "string", "traits": { @@ -2125,6 +2724,87 @@ } } }, + "com.amazonaws.osis#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.osis#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.osis#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.osis#AccessDeniedException" + }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, + { + "target": "com.amazonaws.osis#InternalException" + }, + { + "target": "com.amazonaws.osis#LimitExceededException" + }, + { + "target": "com.amazonaws.osis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.osis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches a resource-based policy to an OpenSearch Ingestion resource. Resource-based\n policies grant permissions to principals to perform actions on the resource.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/2022-01-01/osis/resourcePolicy/{ResourceArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.osis#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.osis#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to attach the policy to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.osis#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The resource-based policy document in JSON format.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.osis#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.osis#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "Policy": { + "target": "com.amazonaws.osis#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The resource-based policy document that was attached to the resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.osis#ResourceAlreadyExistsException": { "type": "structure", "members": { @@ -2151,6 +2831,86 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.osis#ResourcePolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 204800 + } + } + }, + "com.amazonaws.osis#RevokePipelineEndpointConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.osis#RevokePipelineEndpointConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.osis#RevokePipelineEndpointConnectionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.osis#AccessDeniedException" + }, + { + "target": "com.amazonaws.osis#DisabledOperationException" + }, + { + "target": "com.amazonaws.osis#InternalException" + }, + { + "target": "com.amazonaws.osis#LimitExceededException" + }, + { + "target": "com.amazonaws.osis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Revokes pipeline endpoints from specified endpoint IDs.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2022-01-01/osis/revokePipelineEndpointConnections", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.osis#RevokePipelineEndpointConnectionsRequest": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.osis#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline from which to revoke endpoint\n connections.

", + "smithy.api#required": {} + } + }, + "EndpointIds": { + "target": "com.amazonaws.osis#PipelineEndpointIdsList", + "traits": { + "smithy.api#documentation": "

A list of endpoint IDs for which to revoke access to the pipeline.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.osis#RevokePipelineEndpointConnectionsResponse": { + "type": "structure", + "members": { + "PipelineArn": { + "target": "com.amazonaws.osis#PipelineArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pipeline from which endpoint connections were\n revoked.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.osis#SecurityGroupId": { "type": "string", "traits": { @@ -2292,7 +3052,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.

", + "smithy.api#documentation": "

Stops an OpenSearch Ingestion pipeline. For more information, see Stopping\n an OpenSearch Ingestion pipeline.

", "smithy.api#http": { "method": "PUT", "uri": "/2022-01-01/osis/stopPipeline/{PipelineName}", @@ -2425,7 +3185,7 @@ } ], "traits": { - "smithy.api#documentation": "

Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

", + "smithy.api#documentation": "

Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch\n Ingestion pipelines.

", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/tagResource", @@ -2502,7 +3262,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon\n OpenSearch Ingestion pipelines.

", + "smithy.api#documentation": "

Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging\n Amazon OpenSearch Ingestion pipelines.

", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/untagResource", @@ -2569,7 +3329,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.

", + "smithy.api#documentation": "

Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch\n Ingestion pipelines.

", "smithy.api#http": { "method": "PUT", "uri": "/2022-01-01/osis/updatePipeline/{PipelineName}", @@ -2621,13 +3381,13 @@ "EncryptionAtRestOptions": { "target": "com.amazonaws.osis#EncryptionAtRestOptions", "traits": { - "smithy.api#documentation": "

Key-value pairs to configure encryption for data that is written to a persistent buffer.

" + "smithy.api#documentation": "

Key-value pairs to configure encryption for data that is written to a persistent\n 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.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that grants the pipeline permission to access\n Amazon Web Services resources.

" } } }, diff --git a/codegen/sdk/aws-models/outposts.json b/codegen/sdk/aws-models/outposts.json index 00238a21373..451ccb0a0ef 100644 --- a/codegen/sdk/aws-models/outposts.json +++ b/codegen/sdk/aws-models/outposts.json @@ -5089,17 +5089,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5113,28 +5102,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5148,17 +5115,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/panorama.json b/codegen/sdk/aws-models/panorama.json index 967fc3bbced..67ba4e57247 100644 --- a/codegen/sdk/aws-models/panorama.json +++ b/codegen/sdk/aws-models/panorama.json @@ -5030,17 +5030,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5054,17 +5043,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5078,17 +5056,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5102,17 +5069,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/partnercentral-selling.json b/codegen/sdk/aws-models/partnercentral-selling.json index 95b2f67b733..6b01ce8bc7e 100644 --- a/codegen/sdk/aws-models/partnercentral-selling.json +++ b/codegen/sdk/aws-models/partnercentral-selling.json @@ -328,102 +328,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://partnercentral-selling-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://partnercentral-selling.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://partnercentral-selling-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://partnercentral-selling.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://partnercentral-selling-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://partnercentral-selling.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://partnercentral-selling-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://partnercentral-selling.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { @@ -737,6 +641,13 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.partnercentralselling#Amount": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(0|([1-9][0-9]{0,30}))(\\.[0-9]{0,2})?$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.partnercentralselling#ApnPrograms": { "type": "list", "member": { @@ -882,8 +793,8 @@ ], "traits": { "aws.iam#conditionKeys": [ - "partnercentral:RelatedEntityType", - "partnercentral:Catalog" + "partnercentral:Catalog", + "partnercentral:RelatedEntityType" ], "aws.iam#iamAction": { "documentation": "Grants permission to associate Opportunities on AWS Partner Central with other entities" @@ -3778,7 +3689,9 @@ ], "traits": { "aws.iam#conditionKeys": [ - "partnercentral:Catalog" + "partnercentral:Catalog", + "aws:RequestTag/${TagKey}", + "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create new Opportunities on AWS Partner Central" @@ -3881,6 +3794,12 @@ "traits": { "smithy.api#documentation": "

Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.

" } + }, + "Tags": { + "target": "com.amazonaws.partnercentralselling#TagList", + "traits": { + "smithy.api#documentation": "

A map of the key-value pairs of the tag or tags to assign.

" + } } }, "traits": { @@ -5266,9 +5185,7 @@ ], "traits": { "aws.iam#conditionKeys": [ - "partnercentral:Catalog", - "aws:ResourceTag/${TagKey}", - "aws:TagKeys" + "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to deleting resource snapshot jobs on AWS Partner Central" @@ -5379,8 +5296,8 @@ ], "traits": { "aws.iam#conditionKeys": [ - "partnercentral:RelatedEntityType", - "partnercentral:Catalog" + "partnercentral:Catalog", + "partnercentral:RelatedEntityType" ], "aws.iam#iamAction": { "documentation": "Grants permission to disassociate Opportunities on AWS Partner Central from other entities" @@ -6153,7 +6070,7 @@ "type": "structure", "members": { "Amount": { - "target": "smithy.api#String", + "target": "com.amazonaws.partnercentralselling#Amount", "traits": { "smithy.api#documentation": "

Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.

", "smithy.api#required": {} @@ -6170,14 +6087,14 @@ "Frequency": { "target": "com.amazonaws.partnercentralselling#PaymentFrequency", "traits": { - "smithy.api#documentation": "

Indicates how frequently the customer is expected to spend the projected amount. This can include values such as Monthly, Quarterly, or Annually. The default value is Monthly, representing recurring monthly spend.

", + "smithy.api#documentation": "

Indicates how frequently the customer is expected to spend the projected amount. Only the value Monthly is allowed for the Frequency field, representing recurring monthly spend.

", "smithy.api#required": {} } }, "TargetCompany": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity.

", + "smithy.api#documentation": "

Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity. This field only accepts the value AWS. If any other value is provided, the system will automatically set it to AWS.

", "smithy.api#length": { "min": 1, "max": 80 @@ -6908,9 +6825,7 @@ ], "traits": { "aws.iam#conditionKeys": [ - "partnercentral:Catalog", - "aws:ResourceTag/${TagKey}", - "aws:TagKeys" + "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to retrieving resource snapshot job details in AWS Partner Central" @@ -7584,13 +7499,13 @@ "ReviewComments": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Indicates why an opportunity was sent back for further details. Partners must take corrective action based on the ReviewComments.

" + "smithy.api#documentation": "

Contains detailed feedback from Amazon Web Services when requesting additional information from partners. Provides specific guidance on what partners need to provide or clarify for opportunity validation, complementing the ReviewStatusReason field.

" } }, "ReviewStatusReason": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Indicates the reason a decision was made during the opportunity review process. This field combines the reasons for both disqualified and action required statuses, and provide clarity for why an opportunity was disqualified or requires further action.

" + "smithy.api#documentation": "

Code indicating the validation decision during the Amazon Web Services opportunity review. Applies when status is Rejected or Action Required. Used to document validation results for AWS Partner Referrals and indicate when additional information is needed from partners as part of the APN Customer Engagement (ACE) program.

" } }, "NextStepsHistory": { @@ -8593,7 +8508,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to list Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "

This request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from Partner Central using the ListOpportunities API action.

To synchronize your system with Amazon Web Services, only list the opportunities that were newly created or updated. We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default event bus, you can also use the ListOpportunities action.

We recommend the following approach:

  1. Find the latest LastModifiedDate that you stored, and only use the values that came from Amazon Web Services. Don’t use values generated by your system.

  2. When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter.

  3. Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.

", + "smithy.api#documentation": "

This request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from Partner Central using the ListOpportunities API action.

To synchronize your system with Amazon Web Services, list only the opportunities that were newly created or updated. We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default event bus. You can also use the ListOpportunities action.

We recommend the following approach:

  1. Find the latest LastModifiedDate that you stored, and only use the values that came from Amazon Web Services. Don’t use values generated by your system.

  2. When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter.

  3. Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.

", "smithy.api#http": { "method": "POST", "uri": "/ListOpportunities", @@ -9390,6 +9305,9 @@ "aws.api#arn": { "template": "catalog/{Catalog}/opportunity/{Identifier}" }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "relativeDocumentation": "working-with-your-opportunities.html" @@ -9726,7 +9644,7 @@ }, "traits": { "smithy.api#length": { - "max": 1 + "max": 2 } } }, @@ -10546,6 +10464,9 @@ "aws.api#arn": { "template": "catalog/{Catalog}/resource-snapshot-job/{Identifier}" }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "relativeDocumentation": "working-with-multi-partner-opportunities.html", @@ -11288,6 +11209,7 @@ "aws.iam#conditionKeys": [ "partnercentral:Catalog", "aws:RequestTag/${TagKey}", + "aws:ResourceTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { @@ -11445,6 +11367,7 @@ "aws.iam#conditionKeys": [ "partnercentral:Catalog", "aws:RequestTag/${TagKey}", + "aws:ResourceTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { @@ -11458,7 +11381,7 @@ ], "documentation": "Grants permission to initiate tasks that start Engagements from Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "

This action initiates the engagement process from an existing opportunity by accepting the engagement invitation and creating a corresponding opportunity in the partner’s system. Similar to StartEngagementByAcceptingInvitationTask, this action is asynchronous and performs multiple steps before completion.

", + "smithy.api#documentation": "

Similar to StartEngagementByAcceptingInvitationTask, this action is asynchronous and performs multiple steps before completion. This action orchestrates a comprehensive workflow that combines multiple API operations into a single task to create and initiate an engagement from an existing opportunity. It automatically executes a sequence of operations including GetOpportunity, CreateEngagement (if it doesn't exist), CreateResourceSnapshot, CreateResourceSnapshotJob, CreateEngagementInvitation (if not already invited/accepted), and SubmitOpportunity.

", "smithy.api#http": { "method": "POST", "uri": "/StartEngagementFromOpportunityTask", @@ -11603,9 +11526,7 @@ ], "traits": { "aws.iam#conditionKeys": [ - "partnercentral:Catalog", - "aws:ResourceTag/${TagKey}", - "aws:TagKeys" + "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to starting resource snapshot jobs in AWS Partner Central" @@ -11666,9 +11587,7 @@ ], "traits": { "aws.iam#conditionKeys": [ - "partnercentral:Catalog", - "aws:ResourceTag/${TagKey}", - "aws:TagKeys" + "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to stopping resource snapshot jobs in AWS Partner Central" diff --git a/codegen/sdk/aws-models/payment-cryptography-data.json b/codegen/sdk/aws-models/payment-cryptography-data.json index 921142b0afc..5b1cfdf28d4 100644 --- a/codegen/sdk/aws-models/payment-cryptography-data.json +++ b/codegen/sdk/aws-models/payment-cryptography-data.json @@ -2992,17 +2992,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3016,17 +3005,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3040,17 +3018,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3064,17 +3031,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/payment-cryptography.json b/codegen/sdk/aws-models/payment-cryptography.json index 7d21900b53c..4906eb0b4b7 100644 --- a/codegen/sdk/aws-models/payment-cryptography.json +++ b/codegen/sdk/aws-models/payment-cryptography.json @@ -9,11 +9,90 @@ } }, "traits": { - "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

This exception is thrown when the caller lacks the necessary IAM permissions to perform the requested operation. Verify that your IAM policy includes the required permissions for the specific Amazon Web Services Payment Cryptography action you're attempting.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, + "com.amazonaws.paymentcryptography#AddKeyReplicationRegions": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#AddKeyReplicationRegionsInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#AddKeyReplicationRegionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Adds replication Amazon Web Services Regions to an existing Amazon Web Services Payment Cryptography key, enabling the key to be used for cryptographic operations in additional Amazon Web Services Regions.

Multi-region keys allow you to use the same key material across multiple Amazon Web Services Regions, providing lower latency for applications distributed across regions. When you add Replication Regions, Amazon Web Services Payment Cryptography securely replicates the key material to the specified Amazon Web Services Regions.

The key must be in an active state to add Replication Regions. You can add multiple regions in a single operation, and the key will be available for use in those regions once replication is complete.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

" + } + }, + "com.amazonaws.paymentcryptography#AddKeyReplicationRegionsInput": { + "type": "structure", + "members": { + "KeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "

The key identifier (ARN or alias) of the key for which to add replication regions.

This key must exist and be in a valid state for replication operations.

", + "smithy.api#required": {} + } + }, + "ReplicationRegions": { + "target": "com.amazonaws.paymentcryptography#Regions", + "traits": { + "smithy.api#documentation": "

The list of Amazon Web Services Regions to add to the key's replication configuration.

Each region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available. The key will be replicated to these regions, allowing cryptographic operations to be performed closer to your applications.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input parameters for adding replication regions to a specific key.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#AddKeyReplicationRegionsOutput": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.paymentcryptography#Key", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The updated key metadata after adding the replication regions.

This includes the current state of the key and its replication configuration.

", + "smithy.api#required": {}, + "smithy.api#suppress": [ + "UnstableTrait" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "

Output from adding replication regions to a key.

", + "smithy.api#output": {} + } + }, "com.amazonaws.paymentcryptography#Alias": { "type": "structure", "members": { @@ -86,7 +165,7 @@ "target": "com.amazonaws.paymentcryptography#Alias" } }, - "com.amazonaws.paymentcryptography#CertificateType": { + "com.amazonaws.paymentcryptography#CertificateSigningRequestType": { "type": "string", "traits": { "smithy.api#length": { @@ -97,6 +176,102 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.paymentcryptography#CertificateSubjectType": { + "type": "structure", + "members": { + "CommonName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Common Name to be used in the certificate signing request", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z]+$", + "smithy.api#required": {} + } + }, + "OrganizationUnit": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Organization Unit to be used in the certificate signing request", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z]+$" + } + }, + "Organization": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Organization to be used in the certificate signing request", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z]+$" + } + }, + "City": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "City to be used in the certificate signing request", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z]+$" + } + }, + "Country": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Country to be used in the certificate signing request", + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#pattern": "^[A-Za-z]+$" + } + }, + "StateOrProvince": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "State Or Province to be used in the certificate signing request", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z]+$" + } + }, + "EmailAddress": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Email to be used in the certificate signing request", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata used in generating the CSR" + } + }, + "com.amazonaws.paymentcryptography#CertificateType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32768 + }, + "smithy.api#pattern": "^[^\\[;\\]<>]+$" + } + }, "com.amazonaws.paymentcryptography#ConflictException": { "type": "structure", "members": { @@ -105,7 +280,7 @@ } }, "traits": { - "smithy.api#documentation": "

This request can cause an inconsistent state for the resource.

", + "smithy.api#documentation": "

This request can cause an inconsistent state for the resource.

The requested operation conflicts with the current state of the resource. For example, attempting to delete a key that is currently being used, or trying to create a resource that already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -301,6 +476,15 @@ "UnstableTrait" ] } + }, + "ReplicationRegions": { + "target": "com.amazonaws.paymentcryptography#Regions", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#suppress": [ + "UnstableTrait" + ] + } } }, "traits": { @@ -563,6 +747,142 @@ "smithy.api#documentation": "

The shared information used when deriving a key using ECDH.

" } }, + "com.amazonaws.paymentcryptography#DisableDefaultKeyReplicationRegions": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#DisableDefaultKeyReplicationRegionsInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#DisableDefaultKeyReplicationRegionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Disables multi-region key replication settings for the specified Amazon Web Services Regions in your account, preventing new keys from being automatically replicated to those regions.

After disabling default replication for specific regions, new keys created in your account will not be automatically replicated to those regions. You can still manually add replication to those regions for individual keys using the AddKeyReplicationRegions operation.

This operation does not affect existing keys or their current replication configuration.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

" + } + }, + "com.amazonaws.paymentcryptography#DisableDefaultKeyReplicationRegionsInput": { + "type": "structure", + "members": { + "ReplicationRegions": { + "target": "com.amazonaws.paymentcryptography#Regions", + "traits": { + "smithy.api#documentation": "

The list of Amazon Web Services Regions to remove from the account's default replication regions.

New keys created after this operation will not automatically be replicated to these regions, though existing keys with replication to these regions will be unaffected.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input parameters for disabling default key replication regions for the account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#DisableDefaultKeyReplicationRegionsOutput": { + "type": "structure", + "members": { + "EnabledReplicationRegions": { + "target": "com.amazonaws.paymentcryptography#Regions", + "traits": { + "smithy.api#documentation": "

The remaining list of regions where default key replication is still enabled for the account.

This reflects the account's default replication configuration after removing the specified regions.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Output from disabling default key replication regions for the account.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#EnableDefaultKeyReplicationRegions": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#EnableDefaultKeyReplicationRegionsInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#EnableDefaultKeyReplicationRegionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Enables multi-region key replication settings for your account, causing new keys to be automatically replicated to the specified Amazon Web Services Regions when created.

When default Replication Regions are enabled, any new keys created in your account will automatically be replicated to these regions unless you explicitly override this behavior during key creation. This simplifies key management for applications that operate across multiple regions.

Existing keys are not affected by this operation - only keys created after enabling default replication will be automatically replicated.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

" + } + }, + "com.amazonaws.paymentcryptography#EnableDefaultKeyReplicationRegionsInput": { + "type": "structure", + "members": { + "ReplicationRegions": { + "target": "com.amazonaws.paymentcryptography#Regions", + "traits": { + "smithy.api#documentation": "

The list of Amazon Web Services Regions to enable as default replication regions for the account.

New keys created in this account will automatically be replicated to these regions unless explicitly overridden during key creation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input parameters for enabling default key replication regions for the account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#EnableDefaultKeyReplicationRegionsOutput": { + "type": "structure", + "members": { + "EnabledReplicationRegions": { + "target": "com.amazonaws.paymentcryptography#Regions", + "traits": { + "smithy.api#documentation": "

The complete list of regions where default key replication is now enabled for the account.

This includes both previously enabled regions and the newly added regions from this operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Output from enabling default key replication regions for the account.

", + "smithy.api#output": {} + } + }, "com.amazonaws.paymentcryptography#EvenHexLengthBetween16And32": { "type": "string", "traits": { @@ -809,7 +1129,7 @@ "com.amazonaws.paymentcryptography#ExportTokenId": { "type": "string", "traits": { - "smithy.api#pattern": "^export-token-[0-9a-zA-Z]{16,64}$" + "smithy.api#pattern": "^(export-token-[0-9a-zA-Z]{16,64})?$" } }, "com.amazonaws.paymentcryptography#ExportTr31KeyBlock": { @@ -853,8 +1173,21 @@ "ExportToken": { "target": "com.amazonaws.paymentcryptography#ExportTokenId", "traits": { - "smithy.api#documentation": "

The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 30 days. You can use the same export token to export multiple keys from the same service account.

", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "

The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 30 days. You can use the same export token to export multiple keys from the same service account.

" + } + }, + "SigningKeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "Key Identifier used for signing the export key" + } + }, + "SigningKeyCertificate": { + "target": "com.amazonaws.paymentcryptography#CertificateType", + "traits": { + "smithy.api#documentation": "Certificate used for signing the export key" } }, "KeyBlockFormat": { @@ -891,7 +1224,155 @@ }, "errors": [ { - "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Gets the Amazon Web Services Payment Cryptography key associated with the alias.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.paymentcryptography#GetAliasInput": { + "type": "structure", + "members": { + "AliasName": { + "target": "com.amazonaws.paymentcryptography#AliasName", + "traits": { + "smithy.api#documentation": "

The alias of the Amazon Web Services Payment Cryptography key.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#GetAliasOutput": { + "type": "structure", + "members": { + "Alias": { + "target": "com.amazonaws.paymentcryptography#Alias", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The alias of the Amazon Web Services Payment Cryptography key.

", + "smithy.api#required": {}, + "smithy.api#suppress": [ + "UnstableTrait" + ] + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#GetCertificateSigningRequest": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#GetCertificateSigningRequestInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#GetCertificateSigningRequestOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Used to retrieve the public key for a keypair." + } + }, + "com.amazonaws.paymentcryptography#GetCertificateSigningRequestInput": { + "type": "structure", + "members": { + "KeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "Asymmetric key used for generating the certificate signing request", + "smithy.api#required": {} + } + }, + "SigningAlgorithm": { + "target": "com.amazonaws.paymentcryptography#SigningAlgorithmType", + "traits": { + "smithy.api#documentation": "Algorithm used to generate the certificate signing request", + "smithy.api#required": {} + } + }, + "CertificateSubject": { + "target": "com.amazonaws.paymentcryptography#CertificateSubjectType", + "traits": { + "smithy.api#documentation": "Certificate subject data", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#GetCertificateSigningRequestOutput": { + "type": "structure", + "members": { + "CertificateSigningRequest": { + "target": "com.amazonaws.paymentcryptography#CertificateSigningRequestType", + "traits": { + "smithy.api#documentation": "Certificate signing request", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#GetDefaultKeyReplicationRegions": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#GetDefaultKeyReplicationRegionsInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#GetDefaultKeyReplicationRegionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" }, { "target": "com.amazonaws.paymentcryptography#InternalServerException" @@ -900,7 +1381,7 @@ "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" }, { - "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" }, { "target": "com.amazonaws.paymentcryptography#ThrottlingException" @@ -911,41 +1392,30 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "

Gets the Amazon Web Services Payment Cryptography key associated with the alias.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

", - "smithy.api#readonly": {} + "smithy.api#documentation": "

Retrieves the list of regions where default key replication is currently enabled for your account.

This operation returns the current configuration of default Replication Regions. New keys created in your account will be automatically replicated to these regions unless explicitly overridden during key creation.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

" } }, - "com.amazonaws.paymentcryptography#GetAliasInput": { + "com.amazonaws.paymentcryptography#GetDefaultKeyReplicationRegionsInput": { "type": "structure", - "members": { - "AliasName": { - "target": "com.amazonaws.paymentcryptography#AliasName", - "traits": { - "smithy.api#documentation": "

The alias of the Amazon Web Services Payment Cryptography key.

", - "smithy.api#required": {} - } - } - }, + "members": {}, "traits": { + "smithy.api#documentation": "

Input parameters for retrieving the account's default key replication regions. This operation requires no input parameters.

", "smithy.api#input": {} } }, - "com.amazonaws.paymentcryptography#GetAliasOutput": { + "com.amazonaws.paymentcryptography#GetDefaultKeyReplicationRegionsOutput": { "type": "structure", "members": { - "Alias": { - "target": "com.amazonaws.paymentcryptography#Alias", + "EnabledReplicationRegions": { + "target": "com.amazonaws.paymentcryptography#Regions", "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The alias of the Amazon Web Services Payment Cryptography key.

", - "smithy.api#required": {}, - "smithy.api#suppress": [ - "UnstableTrait" - ] + "smithy.api#documentation": "

The list of regions where default key replication is currently enabled for the account.

New keys created in this account will automatically be replicated to these regions unless explicitly configured otherwise during key creation.

", + "smithy.api#required": {} } } }, "traits": { + "smithy.api#documentation": "

Output containing the account's current default key replication configuration.

", "smithy.api#output": {} } }, @@ -979,7 +1449,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "

Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

", + "smithy.api#documentation": "

Gets the key metadata for an Amazon Web Services Payment Cryptography key, including the immutable and mutable attributes specified when the key was created. Returns key metadata including attributes, state, and timestamps, but does not return the actual cryptographic key material.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

", "smithy.api#readonly": {} } }, @@ -1005,7 +1475,7 @@ "target": "com.amazonaws.paymentcryptography#Key", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The key material, including the immutable and mutable data for the key.

", + "smithy.api#documentation": "

Contains the key metadata, including both immutable and mutable attributes for the key, but does not include actual cryptographic key material.

", "smithy.api#required": {}, "smithy.api#suppress": [ "UnstableTrait" @@ -1477,6 +1947,9 @@ "traits": { "smithy.api#documentation": "

Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is imported. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.

Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

" } + }, + "ReplicationRegions": { + "target": "com.amazonaws.paymentcryptography#Regions" } }, "traits": { @@ -1545,7 +2018,7 @@ "com.amazonaws.paymentcryptography#ImportTokenId": { "type": "string", "traits": { - "smithy.api#pattern": "^import-token-[0-9a-zA-Z]{16,64}$" + "smithy.api#pattern": "^(import-token-[0-9a-zA-Z]{16,64})?$" } }, "com.amazonaws.paymentcryptography#ImportTr31KeyBlock": { @@ -1590,8 +2063,21 @@ "ImportToken": { "target": "com.amazonaws.paymentcryptography#ImportTokenId", "traits": { - "smithy.api#documentation": "

The import token that initiates key import using the asymmetric TR-34 key exchange method into Amazon Web Services Payment Cryptography. It expires after 30 days. You can use the same import token to import multiple keys to the same service account.

", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "

The import token that initiates key import using the asymmetric TR-34 key exchange method into Amazon Web Services Payment Cryptography. It expires after 30 days. You can use the same import token to import multiple keys to the same service account.

" + } + }, + "WrappingKeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "Key Identifier used for unwrapping the import key" + } + }, + "WrappingKeyCertificate": { + "target": "com.amazonaws.paymentcryptography#CertificateType", + "traits": { + "smithy.api#documentation": "Key Identifier used for unwrapping the import key" } }, "WrappedKeyBlock": { @@ -1627,7 +2113,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception, or failure.

", + "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception, or failure.

This indicates a server-side error within the Amazon Web Services Payment Cryptography service. If this error persists, contact support for assistance.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1767,6 +2253,45 @@ "UnstableTrait" ] } + }, + "MultiRegionKeyType": { + "target": "com.amazonaws.paymentcryptography#MultiRegionKeyType", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

Indicates whether this key is a multi-region key and its role in the multi-region key hierarchy.

Multi-region keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a primary key (which can be replicated to other regions) or a replica key (which is a copy of a primary key in another region).

", + "smithy.api#suppress": [ + "UnstableTrait" + ] + } + }, + "PrimaryRegion": { + "target": "com.amazonaws.paymentcryptography#Region", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#suppress": [ + "UnstableTrait" + ] + } + }, + "ReplicationStatus": { + "target": "com.amazonaws.paymentcryptography#ReplicationStatus", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

Information about the replication status of the key across different regions.

This field provides details about the current state of key replication, including any status messages or operational information. It helps track the progress and health of key replication operations.

", + "smithy.api#suppress": [ + "UnstableTrait" + ] + } + }, + "UsingDefaultReplicationRegions": { + "target": "smithy.api#Boolean", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

Indicates whether this key is using the account's default replication regions configuration.

When set to true, the key automatically replicates to the regions specified in the account's default replication settings. When set to false, the key has a custom replication configuration that overrides the account defaults.

", + "smithy.api#suppress": [ + "UnstableTrait" + ] + } } }, "traits": { @@ -1862,6 +2387,7 @@ "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType": { "type": "string", "traits": { + "smithy.api#documentation": "

A key identifier that can be either a key ARN or an alias name. This allows flexible key identification in operations.

When using a key ARN, it must be a fully qualified ARN in the format: arn:aws:payment-cryptography:region:account:key/key-id.

When using an alias, it must begin with alias/ followed by the alias name.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

", "smithy.api#length": { "min": 7, "max": 322 @@ -1959,6 +2485,10 @@ { "value": "HMAC", "name": "HMAC" + }, + { + "value": "SHA_1", + "name": "SHA_1" } ] } @@ -2169,6 +2699,30 @@ ] } }, + "com.amazonaws.paymentcryptography#KeyReplicationState": { + "type": "string", + "traits": { + "smithy.api#documentation": "Defines the replication state of a key", + "smithy.api#enum": [ + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "SYNCHRONIZED", + "name": "SYNCHRONIZED" + } + ] + } + }, "com.amazonaws.paymentcryptography#KeyResource": { "type": "resource", "identifiers": { @@ -2189,6 +2743,12 @@ "target": "com.amazonaws.paymentcryptography#ListKeys" }, "operations": [ + { + "target": "com.amazonaws.paymentcryptography#AddKeyReplicationRegions" + }, + { + "target": "com.amazonaws.paymentcryptography#RemoveKeyReplicationRegions" + }, { "target": "com.amazonaws.paymentcryptography#RestoreKey" }, @@ -2279,6 +2839,15 @@ "smithy.api#documentation": "

Specifies whether the key is enabled.

", "smithy.api#required": {} } + }, + "MultiRegionKeyType": { + "target": "com.amazonaws.paymentcryptography#MultiRegionKeyType", + "traits": { + "smithy.api#documentation": "

Indicates whether this key is a multi-region key and its role in the multi-region key hierarchy.

Multi-region keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a primary key (which can be replicated to other regions) or a replica key (which is a copy of a primary key in another region).

" + } + }, + "PrimaryRegion": { + "target": "com.amazonaws.paymentcryptography#Region" } }, "traits": { @@ -2679,6 +3248,22 @@ } } }, + "com.amazonaws.paymentcryptography#MultiRegionKeyType": { + "type": "string", + "traits": { + "smithy.api#documentation": "Defines the replication type of a key", + "smithy.api#enum": [ + { + "value": "PRIMARY", + "name": "PRIMARY" + }, + { + "value": "REPLICA", + "name": "REPLICA" + } + ] + } + }, "com.amazonaws.paymentcryptography#NextToken": { "type": "string", "traits": { @@ -2706,7 +3291,7 @@ "min": 1, "max": 108 }, - "smithy.api#pattern": "^[0-9A-Z]+$", + "smithy.api#pattern": "^[0-9a-zA-Z]+$", "smithy.api#sensitive": {} } }, @@ -2723,9 +3308,21 @@ "type": "service", "version": "2021-09-14", "operations": [ + { + "target": "com.amazonaws.paymentcryptography#DisableDefaultKeyReplicationRegions" + }, + { + "target": "com.amazonaws.paymentcryptography#EnableDefaultKeyReplicationRegions" + }, { "target": "com.amazonaws.paymentcryptography#ExportKey" }, + { + "target": "com.amazonaws.paymentcryptography#GetCertificateSigningRequest" + }, + { + "target": "com.amazonaws.paymentcryptography#GetDefaultKeyReplicationRegions" + }, { "target": "com.amazonaws.paymentcryptography#GetParametersForExport" }, @@ -3278,17 +3875,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3302,17 +3888,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3326,17 +3901,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3350,17 +3914,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3436,6 +3989,131 @@ } } }, + "com.amazonaws.paymentcryptography#Region": { + "type": "string", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Region identifier in the standard format (e.g., us-east-1, eu-west-1).

Used to specify regions for key replication operations. The region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available.

", + "smithy.api#pattern": "^[a-z]{2}-[a-z]{1,16}-[0-9]+$" + } + }, + "com.amazonaws.paymentcryptography#Regions": { + "type": "list", + "member": { + "target": "com.amazonaws.paymentcryptography#Region" + }, + "traits": { + "smithy.api#documentation": "

A list of Amazon Web Services Regions for key replication operations.

Each region in the list must be a valid Amazon Web Services Region identifier where Amazon Web Services Payment Cryptography is available. This list is used to specify which regions should be added to or removed from a key's replication configuration.

" + } + }, + "com.amazonaws.paymentcryptography#RemoveKeyReplicationRegions": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#RemoveKeyReplicationRegionsInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#RemoveKeyReplicationRegionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Removes Replication Regions from an existing Amazon Web Services Payment Cryptography key, disabling the key's availability for cryptographic operations in the specified Amazon Web Services Regions.

When you remove Replication Regions, the key material is securely deleted from those regions and can no longer be used for cryptographic operations there. This operation is irreversible for the specified Amazon Web Services Regions.

Ensure that no active cryptographic operations or applications depend on the key in the regions you're removing before performing this operation.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

" + } + }, + "com.amazonaws.paymentcryptography#RemoveKeyReplicationRegionsInput": { + "type": "structure", + "members": { + "KeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "

The key identifier (ARN or alias) of the key from which to remove replication regions.

This key must exist and have replication enabled in the specified regions.

", + "smithy.api#required": {} + } + }, + "ReplicationRegions": { + "target": "com.amazonaws.paymentcryptography#Regions", + "traits": { + "smithy.api#documentation": "

The list of Amazon Web Services Regions to remove from the key's replication configuration.

The key will no longer be available for cryptographic operations in these regions after removal. Ensure no active operations depend on the key in these regions before removal.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input parameters for removing replication regions from a specific key.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#RemoveKeyReplicationRegionsOutput": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.paymentcryptography#Key", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The updated key metadata after removing the replication regions.

This reflects the current state of the key and its updated replication configuration.

", + "smithy.api#required": {}, + "smithy.api#suppress": [ + "UnstableTrait" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "

Output from removing replication regions from a key.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#ReplicationStatus": { + "type": "map", + "key": { + "target": "com.amazonaws.paymentcryptography#Region" + }, + "value": { + "target": "com.amazonaws.paymentcryptography#ReplicationStatusType" + } + }, + "com.amazonaws.paymentcryptography#ReplicationStatusType": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.paymentcryptography#KeyReplicationState", + "traits": { + "smithy.api#documentation": "

The current status of key replication in this region.

This field indicates whether the key replication is in progress, completed successfully, or has encountered an error. Possible values include states such as SYNCRHONIZED, IN_PROGRESS, DELETE_IN_PROGRESS, or FAILED. This provides visibility into the replication process for monitoring and troubleshooting purposes.

", + "smithy.api#required": {} + } + }, + "StatusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A message that provides additional information about the current replication status of the key.

This field contains details about any issues or progress updates related to key replication operations. It may include information about replication failures, synchronization status, or other operational details.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the replication status information for a key in a replication region.

This structure contains details about the current state of key replication, including any status messages and operational information about the replication process.

" + } + }, "com.amazonaws.paymentcryptography#ResourceArn": { "type": "string", "traits": { @@ -3452,12 +4130,12 @@ "ResourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The string for the exception.

" + "smithy.api#documentation": "

The identifier of the resource that was not found.

This field contains the specific resource identifier (such as a key ARN or alias name) that could not be located.

" } } }, "traits": { - "smithy.api#documentation": "

The request was denied due to an invalid resource error.

", + "smithy.api#documentation": "

The request was denied due to resource not found.

The specified key, alias, or other resource does not exist in your account or region. Verify that the resource identifier is correct and that the resource exists in the expected region.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -3565,7 +4243,7 @@ } }, "traits": { - "smithy.api#documentation": "

This request would cause a service quota to be exceeded.

", + "smithy.api#documentation": "

This request would cause a service quota to be exceeded.

You have reached the maximum number of keys, aliases, or other resources allowed in your account. Review your current usage and consider deleting unused resources or requesting a quota increase.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -3578,7 +4256,7 @@ } }, "traits": { - "smithy.api#documentation": "

The service cannot complete the request.

", + "smithy.api#documentation": "

The service cannot complete the request.

The Amazon Web Services Payment Cryptography service is temporarily unavailable. This is typically a temporary condition - retry your request after a brief delay.

", "smithy.api#error": "server", "smithy.api#httpError": 503 } @@ -3593,6 +4271,30 @@ "smithy.api#pattern": "^(?:[0-9a-fA-F][0-9a-fA-F])+$" } }, + "com.amazonaws.paymentcryptography#SigningAlgorithmType": { + "type": "string", + "traits": { + "smithy.api#documentation": "Defines the Algorithm used to generate the certificate signing request", + "smithy.api#enum": [ + { + "value": "SHA224", + "name": "SHA224" + }, + { + "value": "SHA256", + "name": "SHA256" + }, + { + "value": "SHA384", + "name": "SHA384" + }, + { + "value": "SHA512", + "name": "SHA512" + } + ] + } + }, "com.amazonaws.paymentcryptography#StartKeyUsage": { "type": "operation", "input": { @@ -3939,7 +4641,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request was denied due to request throttling.

", + "smithy.api#documentation": "

The request was denied due to request throttling.

You have exceeded the rate limits for Amazon Web Services Payment Cryptography API calls. Implement exponential backoff and retry logic in your application to handle throttling gracefully.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -3954,7 +4656,7 @@ "min": 56, "max": 9984 }, - "smithy.api#pattern": "^[0-9A-Z]+$", + "smithy.api#pattern": "^[0-9a-zA-Z]+$", "smithy.api#sensitive": {} } }, @@ -4158,7 +4860,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request was denied due to an invalid request error.

", + "smithy.api#documentation": "

The request was denied due to an invalid request error.

One or more parameters in your request are invalid. Check the parameter values, formats, and constraints specified in the API documentation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/codegen/sdk/aws-models/pca-connector-ad.json b/codegen/sdk/aws-models/pca-connector-ad.json index 134c53a1dca..2f2f2053231 100644 --- a/codegen/sdk/aws-models/pca-connector-ad.json +++ b/codegen/sdk/aws-models/pca-connector-ad.json @@ -3866,17 +3866,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3890,17 +3879,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3914,17 +3892,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3938,17 +3905,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/pca-connector-scep.json b/codegen/sdk/aws-models/pca-connector-scep.json index 66dbec4d5be..c023a7f5d38 100644 --- a/codegen/sdk/aws-models/pca-connector-scep.json +++ b/codegen/sdk/aws-models/pca-connector-scep.json @@ -1878,17 +1878,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1902,17 +1891,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1926,17 +1904,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1950,17 +1917,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/pcs.json b/codegen/sdk/aws-models/pcs.json index f71421dc502..3eb97da8af9 100644 --- a/codegen/sdk/aws-models/pcs.json +++ b/codegen/sdk/aws-models/pcs.json @@ -56,7 +56,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 Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for you to run and scale your high performance computing (HPC) workloads, and build scientific and engineering models on Amazon Web Services using Slurm. For more information, see the Amazon Web Services Parallel Computing Service User Guide.

This reference describes the actions and data types of the service management API. You can use the Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API actions manually. These API actions manage the service through an Amazon Web Services account.

The API actions operate on Amazon Web Services PCS resources. A resource is an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute node groups, and queues. For more information about resources in Amazon Web Services, see Resource in the Resource Explorer User Guide.

An Amazon Web Services PCS compute node is an Amazon EC2 instance. You don't launch compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes. Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources related to those compute nodes.

", + "smithy.api#documentation": "

Parallel Computing Service (PCS) is a managed service that makes it easier for you to run and scale your high performance computing (HPC) workloads, and build scientific and engineering models on Amazon Web Services using Slurm. For more information, see the Parallel Computing Service User Guide.

This reference describes the actions and data types of the service management API. You can use the Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API actions manually. These API actions manage the service through an Amazon Web Services account.

The API actions operate on PCS resources. A resource is an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use the features of the service. Examples of PCS resources include clusters, compute node groups, and queues. For more information about resources in Amazon Web Services, see Resource in the Resource Explorer User Guide.

An PCS compute node is an Amazon EC2 instance. You don't launch compute nodes directly. PCS uses configuration information that you provide to launch compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes. PCS automatically terminates your compute nodes when you delete the PCS resources related to those compute nodes.

", "smithy.api#title": "AWS Parallel Computing Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -566,17 +566,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -590,17 +579,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -614,17 +592,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -638,17 +605,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -743,13 +699,6 @@ "com.amazonaws.pcs#Accounting": { "type": "structure", "members": { - "mode": { - "target": "com.amazonaws.pcs#AccountingMode", - "traits": { - "smithy.api#documentation": "

The default value for mode is STANDARD. A value of STANDARD means Slurm accounting is enabled.

", - "smithy.api#required": {} - } - }, "defaultPurgeTimeInDays": { "target": "smithy.api#Integer", "traits": { @@ -759,6 +708,13 @@ "max": 10000 } } + }, + "mode": { + "target": "com.amazonaws.pcs#AccountingMode", + "traits": { + "smithy.api#documentation": "

The default value for mode is STANDARD. A value of STANDARD means Slurm accounting is enabled.

", + "smithy.api#required": {} + } } }, "traits": { @@ -785,13 +741,6 @@ "com.amazonaws.pcs#AccountingRequest": { "type": "structure", "members": { - "mode": { - "target": "com.amazonaws.pcs#AccountingMode", - "traits": { - "smithy.api#documentation": "

The default value for mode is STANDARD. A value of STANDARD means Slurm accounting is enabled.

", - "smithy.api#required": {} - } - }, "defaultPurgeTimeInDays": { "target": "smithy.api#Integer", "traits": { @@ -801,6 +750,13 @@ "max": 10000 } } + }, + "mode": { + "target": "com.amazonaws.pcs#AccountingMode", + "traits": { + "smithy.api#documentation": "

The default value for mode is STANDARD. A value of STANDARD means Slurm accounting is enabled.

", + "smithy.api#required": {} + } } }, "traits": { @@ -954,6 +910,9 @@ "create": { "target": "com.amazonaws.pcs#CreateCluster" }, + "update": { + "target": "com.amazonaws.pcs#UpdateCluster" + }, "operations": [ { "target": "com.amazonaws.pcs#DeleteCluster" @@ -1222,7 +1181,7 @@ "amiId": { "target": "com.amazonaws.pcs#AmiId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.

" + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. If not provided, PCS uses the AMI ID specified in the custom launch template.

" } }, "subnetIds": { @@ -1235,7 +1194,7 @@ "purchaseOption": { "target": "com.amazonaws.pcs#PurchaseOption", "traits": { - "smithy.api#documentation": "

Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.

" + "smithy.api#documentation": "

Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. If you don't provide this option, it defaults to On-Demand.

" } }, "customLaunchTemplate": { @@ -1247,7 +1206,7 @@ "iamInstanceProfileArn": { "target": "com.amazonaws.pcs#InstanceProfileArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.

Examples

  • arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1

  • arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission and the role name must start with AWSPCS or must have the path /aws-pcs/. For more information, see IAM instance profiles for PCS in the PCS User Guide.

", "smithy.api#required": {} } }, @@ -1260,7 +1219,7 @@ "instanceConfigs": { "target": "com.amazonaws.pcs#InstanceList", "traits": { - "smithy.api#documentation": "

A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.

", + "smithy.api#documentation": "

A list of EC2 instance configurations that PCS can provision in the compute node group.

", "smithy.api#required": {} } }, @@ -1579,7 +1538,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "

Creates a cluster in your account. Amazon Web Services PCS creates the cluster controller in a service-owned account. The cluster controller communicates with the cluster resources in your account. The subnets and security groups for the cluster must already exist before you use this API action.

It takes time for Amazon Web Services PCS to create the cluster. The cluster is in a Creating state until it is ready to use. There can only be 1 cluster in a Creating state per Amazon Web Services Region per Amazon Web Services account. CreateCluster fails with a ServiceQuotaExceededException if there is already a cluster in a Creating state.

", + "smithy.api#documentation": "

Creates a cluster in your account. PCS creates the cluster controller in a service-owned account. The cluster controller communicates with the cluster resources in your account. The subnets and security groups for the cluster must already exist before you use this API action.

It takes time for PCS to create the cluster. The cluster is in a Creating state until it is ready to use. There can only be 1 cluster in a Creating state per Amazon Web Services Region per Amazon Web Services account. CreateCluster fails with a ServiceQuotaExceededException if there is already a cluster in a Creating state.

", "smithy.api#idempotent": {}, "smithy.api#tags": [ "Cluster" @@ -1692,7 +1651,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "

Creates a managed set of compute nodes. You associate a compute node group with a cluster through 1 or more Amazon Web Services PCS queues or as part of the login fleet. A compute node group includes the definition of the compute properties and lifecycle management. Amazon Web Services PCS uses the information you provide to this API action to launch compute nodes in your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive billing charges for the compute nodes that Amazon Web Services PCS launches in your account. You must already have a launch template before you call this API. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

", + "smithy.api#documentation": "

Creates a managed set of compute nodes. You associate a compute node group with a cluster through 1 or more PCS queues or as part of the login fleet. A compute node group includes the definition of the compute properties and lifecycle management. PCS uses the information you provide to this API action to launch compute nodes in your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive billing charges for the compute nodes that PCS launches in your account. You must already have a launch template before you call this API. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

", "smithy.api#idempotent": {}, "smithy.api#tags": [ "ComputeNodeGroup" @@ -1755,7 +1714,7 @@ "amiId": { "target": "com.amazonaws.pcs#AmiId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.

" + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) that PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, PCS uses the AMI ID specified in the custom launch template.

" } }, "subnetIds": { @@ -1768,7 +1727,7 @@ "purchaseOption": { "target": "com.amazonaws.pcs#PurchaseOption", "traits": { - "smithy.api#documentation": "

Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.

" + "smithy.api#documentation": "

Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. If you don't provide this option, it defaults to On-Demand.

" } }, "customLaunchTemplate": { @@ -1780,7 +1739,7 @@ "iamInstanceProfileArn": { "target": "com.amazonaws.pcs#InstanceProfileArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.

Examples

  • arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1

  • arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission and the role name must start with AWSPCS or must have the path /aws-pcs/. For more information, see IAM instance profiles for PCS in the PCS User Guide.

", "smithy.api#required": {} } }, @@ -1794,7 +1753,7 @@ "instanceConfigs": { "target": "com.amazonaws.pcs#InstanceList", "traits": { - "smithy.api#documentation": "

A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.

", + "smithy.api#documentation": "

A list of EC2 instance configurations that PCS can provision in the compute node group.

", "smithy.api#required": {} } }, @@ -1903,6 +1862,12 @@ "smithy.api#documentation": "

The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.

" } }, + "slurmConfiguration": { + "target": "com.amazonaws.pcs#QueueSlurmConfigurationRequest", + "traits": { + "smithy.api#documentation": "

Additional options related to the Slurm scheduler.

" + } + }, "clientToken": { "target": "com.amazonaws.pcs#SBClientToken", "traits": { @@ -1951,7 +1916,7 @@ } }, "traits": { - "smithy.api#documentation": "

An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.

" + "smithy.api#documentation": "

An Amazon EC2 launch template PCS uses to launch compute nodes.

" } }, "com.amazonaws.pcs#DeleteCluster": { @@ -2120,7 +2085,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a job queue. If the compute node group associated with this queue isn't associated with any other queues, Amazon Web Services PCS terminates all the compute nodes for this queue.

", + "smithy.api#documentation": "

Deletes a job queue. If the compute node group associated with this queue isn't associated with any other queues, PCS terminates all the compute nodes for this queue.

", "smithy.api#idempotent": {}, "smithy.api#tags": [ "Queue" @@ -2312,7 +2277,7 @@ "clusterIdentifier": { "target": "com.amazonaws.pcs#ClusterIdentifier", "traits": { - "smithy.api#documentation": "

The name or ID of the cluster of the queue.

", + "smithy.api#documentation": "

The name or ID of the cluster.

", "smithy.api#required": {} } } @@ -2515,12 +2480,12 @@ "instanceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The EC2 instance type that Amazon Web Services PCS can provision in the compute node group.

Example: t2.xlarge

" + "smithy.api#documentation": "

The EC2 instance type that PCS can provision in the compute node group.

Example: t2.xlarge

" } } }, "traits": { - "smithy.api#documentation": "

An EC2 instance configuration Amazon Web Services PCS uses to launch compute nodes.

" + "smithy.api#documentation": "

An EC2 instance configuration PCS uses to launch compute nodes.

" } }, "com.amazonaws.pcs#InstanceList": { @@ -2532,7 +2497,7 @@ "com.amazonaws.pcs#InstanceProfileArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws([a-zA-Z-]{0,10})?:iam::[0-9]{12}:instance-profile/[/\\w+=,.@-]{1,128}$" + "smithy.api#pattern": "^arn:aws([a-zA-Z-]{0,10})?:iam::[0-9]{12}:instance-profile/([!-~]{1,510}/)?([\\w+=,.@-]{1,128})$" } }, "com.amazonaws.pcs#InternalServerException": { @@ -2546,7 +2511,7 @@ } }, "traits": { - "smithy.api#documentation": "

Amazon Web Services PCS can't process your request right now. Try again later.

", + "smithy.api#documentation": "

PCS can't process your request right now. Try again later.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} @@ -2884,7 +2849,7 @@ "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], - "smithy.api#documentation": "

Returns a list of all tags on an Amazon Web Services PCS resource.

", + "smithy.api#documentation": "

Returns a list of all tags on an PCS resource.

", "smithy.api#readonly": {} } }, @@ -2972,7 +2937,7 @@ "subnetIds": { "target": "com.amazonaws.pcs#SubnetIdList", "traits": { - "smithy.api#documentation": "

The ID of the subnet where Amazon Web Services PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and Amazon Web Services PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone.

Example: subnet-abcd1234

" + "smithy.api#documentation": "

The ID of the subnet where PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and PCS resources. The subnet must have an available IP address, cannot reside in Outposts, Wavelength, or an Amazon Web Services Local Zone.

Example: subnet-abcd1234

" } }, "securityGroupIds": { @@ -2998,7 +2963,7 @@ "subnetIds": { "target": "com.amazonaws.pcs#SubnetIdList", "traits": { - "smithy.api#documentation": "

The list of subnet IDs where Amazon Web Services PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and Amazon Web Services PCS resources. Subnet IDs have the form subnet-0123456789abcdef0.

Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.

Amazon Web Services PCS currently supports only 1 subnet in this list.

" + "smithy.api#documentation": "

The list of subnet IDs where PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and PCS resources. Subnet IDs have the form subnet-0123456789abcdef0.

Subnets can't be in Outposts, Wavelength or an Amazon Web Services Local Zone.

PCS currently supports only 1 subnet in this list.

" } }, "securityGroupIds": { @@ -3032,6 +2997,12 @@ "traits": { "smithy.api#enumValue": "SPOT" } + }, + "CAPACITY_BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAPACITY_BLOCK" + } } } }, @@ -3096,6 +3067,12 @@ "smithy.api#required": {} } }, + "slurmConfiguration": { + "target": "com.amazonaws.pcs#QueueSlurmConfiguration", + "traits": { + "smithy.api#documentation": "

Additional options related to the Slurm scheduler.

" + } + }, "errorInfo": { "target": "com.amazonaws.pcs#ErrorInfoList", "traits": { @@ -3170,6 +3147,34 @@ } } }, + "com.amazonaws.pcs#QueueSlurmConfiguration": { + "type": "structure", + "members": { + "slurmCustomSettings": { + "target": "com.amazonaws.pcs#SlurmCustomSettings", + "traits": { + "smithy.api#documentation": "

Additional Slurm-specific configuration that directly maps to Slurm settings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Additional options related to the Slurm scheduler.

" + } + }, + "com.amazonaws.pcs#QueueSlurmConfigurationRequest": { + "type": "structure", + "members": { + "slurmCustomSettings": { + "target": "com.amazonaws.pcs#SlurmCustomSettings", + "traits": { + "smithy.api#documentation": "

Additional Slurm-specific configuration that directly maps to Slurm settings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Additional options related to the Slurm scheduler.

" + } + }, "com.amazonaws.pcs#QueueStatus": { "type": "enum", "members": { @@ -3305,7 +3310,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API action isn't intended for you to use.

Amazon Web Services PCS uses this API action to register the compute nodes it launches in your account.

" + "smithy.api#documentation": "

This API action isn't intended for you to use.

PCS uses this API action to register the compute nodes it launches in your account.

" } }, "com.amazonaws.pcs#RegisterComputeNodeGroupInstanceRequest": { @@ -3488,14 +3493,14 @@ "type": { "target": "com.amazonaws.pcs#SchedulerType", "traits": { - "smithy.api#documentation": "

The software Amazon Web Services PCS uses to manage cluster scaling and job scheduling.

", + "smithy.api#documentation": "

The software PCS uses to manage cluster scaling and job scheduling.

", "smithy.api#required": {} } }, "version": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in Amazon Web Services PCS in the Amazon Web Services PCS User Guide.

Valid Values: 23.11 | 24.05 | 24.11

", + "smithy.api#documentation": "

The version of the specified scheduling software that PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in PCS in the PCS User Guide.

Valid Values: 23.11 | 24.05 | 24.11

", "smithy.api#required": {} } } @@ -3510,14 +3515,14 @@ "type": { "target": "com.amazonaws.pcs#SchedulerType", "traits": { - "smithy.api#documentation": "

The software Amazon Web Services PCS uses to manage cluster scaling and job scheduling.

", + "smithy.api#documentation": "

The software PCS uses to manage cluster scaling and job scheduling.

", "smithy.api#required": {} } }, "version": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in Amazon Web Services PCS in the Amazon Web Services PCS User Guide.

Valid Values: 23.11 | 24.05 | 24.11

", + "smithy.api#documentation": "

The version of the specified scheduling software that PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in PCS in the PCS User Guide.

Valid Values: 23.11 | 24.05 | 24.11

", "smithy.api#required": {} } } @@ -3625,7 +3630,7 @@ "secretArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the the shared Slurm key.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the shared Slurm key.

", "smithy.api#required": {} } }, @@ -3647,7 +3652,7 @@ "parameterName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Amazon Web Services PCS supports configuration of the following Slurm parameters:

", + "smithy.api#documentation": "

PCS supports custom Slurm settings for clusters, compute node groups, and queues. For more information, see Configuring custom Slurm settings in PCS in the PCS User Guide.

", "smithy.api#required": {} } }, @@ -3660,7 +3665,7 @@ } }, "traits": { - "smithy.api#documentation": "

Additional settings that directly map to Slurm settings.

" + "smithy.api#documentation": "

Additional settings that directly map to Slurm settings.

PCS supports a subset of Slurm settings. For more information, see Configuring custom Slurm settings in PCS in the PCS User Guide.

" } }, "com.amazonaws.pcs#SlurmCustomSettings": { @@ -3698,7 +3703,7 @@ "allocationStrategy": { "target": "com.amazonaws.pcs#SpotAllocationStrategy", "traits": { - "smithy.api#documentation": "

The Amazon EC2 allocation strategy Amazon Web Services PCS uses to provision EC2 instances. Amazon Web Services PCS supports lowest price, capacity optimized, and price capacity optimized. For more information, see Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to price capacity optimized.

" + "smithy.api#documentation": "

The Amazon EC2 allocation strategy PCS uses to provision EC2 instances. PCS supports lowest price, capacity optimized, and price capacity optimized. For more information, see Use allocation strategies to determine how EC2 Fleet or Spot Fleet fulfills Spot and On-Demand capacity in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to price capacity optimized.

" } } }, @@ -3772,7 +3777,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "

Adds or edits tags on an Amazon Web Services PCS resource. Each tag consists of a tag key and a tag value. The tag key and tag value are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.

", + "smithy.api#documentation": "

Adds or edits tags on an PCS resource. Each tag consists of a tag key and a tag value. The tag key and tag value are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.

", "smithy.api#idempotent": {} } }, @@ -3871,7 +3876,7 @@ "aws:ResourceTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "

Deletes tags from an Amazon Web Services PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the Amazon Web Services PCS resource.

", + "smithy.api#documentation": "

Deletes tags from an PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the PCS resource.

", "smithy.api#idempotent": {} } }, @@ -3921,6 +3926,151 @@ ] } }, + "com.amazonaws.pcs#UpdateAccountingRequest": { + "type": "structure", + "members": { + "defaultPurgeTimeInDays": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The default value for all purge settings for slurmdbd.conf. For more information, see the slurmdbd.conf documentation at SchedMD.

The default value for defaultPurgeTimeInDays is -1.

A value of -1 means there is no purge time and records persist as long as the cluster exists.

0 isn't a valid value.

", + "smithy.api#range": { + "min": -1, + "max": 10000 + } + } + }, + "mode": { + "target": "com.amazonaws.pcs#AccountingMode", + "traits": { + "smithy.api#documentation": "

The default value for mode is STANDARD. A value of STANDARD means Slurm accounting is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The accounting configuration includes configurable settings for Slurm accounting.

" + } + }, + "com.amazonaws.pcs#UpdateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcs#UpdateClusterRequest" + }, + "output": { + "target": "com.amazonaws.pcs#UpdateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcs#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcs#ConflictException" + }, + { + "target": "com.amazonaws.pcs#InternalServerException" + }, + { + "target": "com.amazonaws.pcs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcs#ThrottlingException" + }, + { + "target": "com.amazonaws.pcs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a cluster configuration. You can modify Slurm scheduler settings, accounting configuration, and security groups for an existing cluster.

You can only update clusters that are in ACTIVE, UPDATE_FAILED, or SUSPENDED state. All associated resources (queues and compute node groups) must be in ACTIVE state before you can update the cluster.

", + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "Cluster" + ], + "smithy.test#smokeTests": [ + { + "id": "UpdateCluster_AccessDeniedException", + "params": { + "clusterIdentifier": "pcs_donotexist" + }, + "expect": { + "failure": { + "errorId": "com.amazonaws.pcs#AccessDeniedException" + } + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.pcs#UpdateClusterRequest": { + "type": "structure", + "members": { + "clusterIdentifier": { + "target": "com.amazonaws.pcs#ClusterIdentifier", + "traits": { + "smithy.api#documentation": "

The name or ID of the cluster to update.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.pcs#SBClientToken", + "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, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.

", + "smithy.api#idempotencyToken": {} + } + }, + "slurmConfiguration": { + "target": "com.amazonaws.pcs#UpdateClusterSlurmConfigurationRequest", + "traits": { + "smithy.api#documentation": "

Additional options related to the Slurm scheduler.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcs#UpdateClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.pcs#Cluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcs#UpdateClusterSlurmConfigurationRequest": { + "type": "structure", + "members": { + "scaleDownIdleTimeInSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The time (in seconds) before an idle node is scaled down.

Default: 600

", + "smithy.api#range": { + "min": 1 + } + } + }, + "slurmCustomSettings": { + "target": "com.amazonaws.pcs#SlurmCustomSettings", + "traits": { + "smithy.api#documentation": "

Additional Slurm-specific configuration that directly maps to Slurm settings.

" + } + }, + "accounting": { + "target": "com.amazonaws.pcs#UpdateAccountingRequest", + "traits": { + "smithy.api#documentation": "

The accounting configuration includes configurable settings for Slurm accounting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Additional options related to the Slurm scheduler.

" + } + }, "com.amazonaws.pcs#UpdateComputeNodeGroup": { "type": "operation", "input": { @@ -3980,7 +4130,7 @@ "amiId": { "target": "com.amazonaws.pcs#AmiId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.

" + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. If not provided, PCS uses the AMI ID specified in the custom launch template.

" } }, "subnetIds": { @@ -3995,7 +4145,7 @@ "purchaseOption": { "target": "com.amazonaws.pcs#PurchaseOption", "traits": { - "smithy.api#documentation": "

Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.

" + "smithy.api#documentation": "

Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. If you don't provide this option, it defaults to On-Demand.

" } }, "spotOptions": { @@ -4010,7 +4160,7 @@ "iamInstanceProfileArn": { "target": "com.amazonaws.pcs#InstanceProfileArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.

Examples

  • arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1

  • arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission and the role name must start with AWSPCS or must have the path /aws-pcs/. For more information, see IAM instance profiles for PCS in the PCS User Guide.

" } }, "slurmConfiguration": { @@ -4118,6 +4268,12 @@ "smithy.api#documentation": "

The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.

" } }, + "slurmConfiguration": { + "target": "com.amazonaws.pcs#UpdateQueueSlurmConfigurationRequest", + "traits": { + "smithy.api#documentation": "

Additional options related to the Slurm scheduler.

" + } + }, "clientToken": { "target": "com.amazonaws.pcs#SBClientToken", "traits": { @@ -4141,6 +4297,20 @@ "smithy.api#output": {} } }, + "com.amazonaws.pcs#UpdateQueueSlurmConfigurationRequest": { + "type": "structure", + "members": { + "slurmCustomSettings": { + "target": "com.amazonaws.pcs#SlurmCustomSettings", + "traits": { + "smithy.api#documentation": "

Additional Slurm-specific configuration that directly maps to Slurm settings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Additional options related to the Slurm scheduler.

" + } + }, "com.amazonaws.pcs#ValidationException": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/personalize-events.json b/codegen/sdk/aws-models/personalize-events.json index fe4258c9349..bce06cd6b8b 100644 --- a/codegen/sdk/aws-models/personalize-events.json +++ b/codegen/sdk/aws-models/personalize-events.json @@ -668,17 +668,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -692,17 +681,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -716,17 +694,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -740,17 +707,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/personalize-runtime.json b/codegen/sdk/aws-models/personalize-runtime.json index b3d5f46816a..41eefe2f954 100644 --- a/codegen/sdk/aws-models/personalize-runtime.json +++ b/codegen/sdk/aws-models/personalize-runtime.json @@ -544,17 +544,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -568,17 +557,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -592,17 +570,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -616,17 +583,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/personalize.json b/codegen/sdk/aws-models/personalize.json index 74a44951f95..17a2332c782 100644 --- a/codegen/sdk/aws-models/personalize.json +++ b/codegen/sdk/aws-models/personalize.json @@ -961,17 +961,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -985,17 +974,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1009,17 +987,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1033,17 +1000,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/pi.json b/codegen/sdk/aws-models/pi.json index b32c90bdab4..deb82f4669a 100644 --- a/codegen/sdk/aws-models/pi.json +++ b/codegen/sdk/aws-models/pi.json @@ -2703,17 +2703,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2727,17 +2716,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2751,17 +2729,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2775,17 +2742,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/pinpoint-email.json b/codegen/sdk/aws-models/pinpoint-email.json index dd6096d937a..2afc96106b2 100644 --- a/codegen/sdk/aws-models/pinpoint-email.json +++ b/codegen/sdk/aws-models/pinpoint-email.json @@ -958,17 +958,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -982,17 +971,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1006,17 +984,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1030,17 +997,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/pinpoint-sms-voice-v2.json b/codegen/sdk/aws-models/pinpoint-sms-voice-v2.json index bcf63beb7be..9cb49bc0d64 100644 --- a/codegen/sdk/aws-models/pinpoint-sms-voice-v2.json +++ b/codegen/sdk/aws-models/pinpoint-sms-voice-v2.json @@ -7324,6 +7324,13 @@ "smithy.api#required": {} } }, + "InternationalSendingEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When set to true the international sending of phone number is Enabled.

" + } + }, "DeletionProtectionEnabled": { "target": "smithy.api#PrimitiveBoolean", "traits": { @@ -8276,17 +8283,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -8300,17 +8296,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -8324,17 +8309,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -8348,17 +8322,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -11032,6 +10995,12 @@ "smithy.api#documentation": "

Use this field to attach your phone number for an external registration process.

" } }, + "InternationalSendingEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

By default this is set to false. When set to true the international sending of phone number is Enabled.

" + } + }, "DeletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { @@ -11145,6 +11114,13 @@ "smithy.api#documentation": "

The name of the OptOutList that is associated with the requested phone number.

" } }, + "InternationalSendingEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

By default this is set to false. When set to true the international sending of phone number is Enabled.

" + } + }, "DeletionProtectionEnabled": { "target": "smithy.api#PrimitiveBoolean", "traits": { @@ -11447,6 +11423,10 @@ "value": "protect-configuration", "name": "PROTECT_CONFIGURATION" }, + { + "value": "message-template", + "name": "MESSAGE_TEMPLATE" + }, { "value": "policy", "name": "POLICY" @@ -13513,6 +13493,12 @@ "smithy.api#documentation": "

The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

" } }, + "InternationalSendingEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

By default this is set to false. When set to true the international sending of phone number is Enabled.

" + } + }, "DeletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { @@ -13613,6 +13599,13 @@ "smithy.api#documentation": "

The name of the OptOutList associated with the phone number.

" } }, + "InternationalSendingEnabled": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When set to true the international sending of phone number is Enabled.

" + } + }, "DeletionProtectionEnabled": { "target": "smithy.api#PrimitiveBoolean", "traits": { @@ -14201,6 +14194,10 @@ "value": "ATTACHMENT_TYPE_NOT_SUPPORTED", "name": "ATTACHMENT_TYPE_NOT_SUPPORTED" }, + { + "value": "INTERNATIONAL_SENDING_NOT_SUPPORTED", + "name": "INTERNATIONAL_SENDING_NOT_SUPPORTED" + }, { "value": "INVALID_ARN", "name": "INVALID_ARN" diff --git a/codegen/sdk/aws-models/pinpoint-sms-voice.json b/codegen/sdk/aws-models/pinpoint-sms-voice.json index 4ecf60bffd0..16542aff60e 100644 --- a/codegen/sdk/aws-models/pinpoint-sms-voice.json +++ b/codegen/sdk/aws-models/pinpoint-sms-voice.json @@ -709,6 +709,9 @@ "name": "sms-voice" }, "aws.protocols#restJson1": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], "smithy.api#documentation": "Pinpoint SMS and Voice Messaging public facing APIs", "smithy.api#title": "Amazon Pinpoint SMS and Voice Service", "smithy.rules#endpointRuleSet": { @@ -1219,17 +1222,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1243,17 +1235,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1267,17 +1248,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1291,17 +1261,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/pinpoint.json b/codegen/sdk/aws-models/pinpoint.json index 88844d00aa5..4b6dd4b3b4b 100644 --- a/codegen/sdk/aws-models/pinpoint.json +++ b/codegen/sdk/aws-models/pinpoint.json @@ -15983,17 +15983,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -16007,17 +15996,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -16031,17 +16009,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -16055,17 +16022,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/pipes.json b/codegen/sdk/aws-models/pipes.json index 5a73f9d8295..1e8e2913280 100644 --- a/codegen/sdk/aws-models/pipes.json +++ b/codegen/sdk/aws-models/pipes.json @@ -4022,17 +4022,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4046,17 +4035,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4070,17 +4048,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4094,17 +4061,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/polly.json b/codegen/sdk/aws-models/polly.json index 7eea92e0b34..d0e18abbf0d 100644 --- a/codegen/sdk/aws-models/polly.json +++ b/codegen/sdk/aws-models/polly.json @@ -1193,6 +1193,12 @@ "smithy.api#enumValue": "mp3" } }, + "OGG_OPUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ogg_opus" + } + }, "OGG_VORBIS": { "target": "smithy.api#Unit", "traits": { @@ -2055,17 +2061,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2079,17 +2074,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2103,17 +2087,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2127,17 +2100,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2726,7 +2688,7 @@ "Engine": { "target": "com.amazonaws.polly#Engine", "traits": { - "smithy.api#documentation": "

Specifies the engine (standard, neural,\n long-form, or generative) for Amazon Polly\n to use when processing input text for speech synthesis. Provide an engine\n that is supported by the voice you select. If you don't provide an engine,\n the standard engine is selected by default. If a chosen voice isn't supported\n by the standard engine, this will result in an error. For information on\n Amazon Polly voices and which voices are available for each engine, see Available Voices.

\n

Type: String

\n

Valid Values: standard | neural |\n long-form | generative\n

\n

Required: Yes

" + "smithy.api#documentation": "

Specifies the engine (standard, neural,\n long-form, or generative) for Amazon Polly\n to use when processing input text for speech synthesis. Provide an engine\n that is supported by the voice you select. If you don't provide an engine,\n the standard engine is selected by default. If a chosen voice isn't supported\n by the standard engine, this will result in an error. For information on\n Amazon Polly voices and which voices are available for each engine, see Available Voices.

" } }, "LanguageCode": { @@ -2751,7 +2713,7 @@ "SampleRate": { "target": "com.amazonaws.polly#SampleRate", "traits": { - "smithy.api#documentation": "

The audio frequency specified in Hz.

\n

The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\". The default value for long-form voices\n is \"24000\". The default value for generative voices is \"24000\".

\n

Valid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".

" + "smithy.api#documentation": "

The audio frequency specified in Hz.

\n

The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", \"24000\", \"44100\" and \"48000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\". The default value for long-form voices\n is \"24000\". The default value for generative voices is \"24000\".

\n

Valid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".

" } }, "SpeechMarkTypes": { diff --git a/codegen/sdk/aws-models/pricing.json b/codegen/sdk/aws-models/pricing.json index cd898ea2298..f734f803e89 100644 --- a/codegen/sdk/aws-models/pricing.json +++ b/codegen/sdk/aws-models/pricing.json @@ -545,17 +545,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -569,17 +558,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -593,17 +571,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -617,17 +584,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/proton.json b/codegen/sdk/aws-models/proton.json index 72b528550dd..fff8154957a 100644 --- a/codegen/sdk/aws-models/proton.json +++ b/codegen/sdk/aws-models/proton.json @@ -785,17 +785,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -809,17 +798,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -833,17 +811,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -857,17 +824,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/qapps.json b/codegen/sdk/aws-models/qapps.json index 4a56bb3d546..4d5b13f1394 100644 --- a/codegen/sdk/aws-models/qapps.json +++ b/codegen/sdk/aws-models/qapps.json @@ -206,7 +206,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a rating or review for a library item with the user submitting the request.\n This increments the rating count for the specified library item.

", + "smithy.api#documentation": "

Associates a rating or review for a library item with the user submitting the request. This increments the rating count for the specified library item.

", "smithy.api#examples": [ { "title": "Increase the rating counter by 1 for the related app for this user", @@ -277,7 +277,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation creates a link between the user's identity calling the operation and a\n specific Q App. This is useful to mark the Q App as a favorite for the\n user if the user doesn't own the Amazon Q App so they can still run it and see it in their\n inventory of Q Apps.

", + "smithy.api#documentation": "

This operation creates a link between the user's identity calling the operation and a specific Q App. This is useful to mark the Q App as a favorite for the user if the user doesn't own the Amazon Q App so they can still run it and see it in their inventory of Q Apps.

", "smithy.api#examples": [ { "title": "Links an Amazon Q App to the invoker's list of apps", @@ -340,48 +340,48 @@ "equalsTo": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs an equals operation on two document attributes or metadata\n fields. Supported for the following document attribute value types: dateValue, longValue,\n stringListValue and stringValue.

" + "smithy.api#documentation": "

Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

" } }, "containsAll": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Returns true when a document contains all the specified document attributes\n or metadata fields. Supported for the following document attribute value types: stringListValue.

" + "smithy.api#documentation": "

Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

" } }, "containsAny": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Returns true when a document contains any of the specified document\n attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

" + "smithy.api#documentation": "

Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

" } }, "greaterThan": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a greater than operation on two document attributes or\n metadata fields. Supported for the following document attribute value types: dateValue and\n longValue.

" + "smithy.api#documentation": "

Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

" } }, "greaterThanOrEquals": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a greater than or equals operation on two document\n attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.\n

" + "smithy.api#documentation": "

Performs a greater than or equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

" } }, "lessThan": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a less than operation on two document attributes or metadata\n fields. Supported for the following document attribute value types: dateValue and\n longValue.

" + "smithy.api#documentation": "

Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

" } }, "lessThanOrEquals": { "target": "com.amazonaws.qapps#DocumentAttribute", "traits": { - "smithy.api#documentation": "

Performs a less than or equals operation on two document attributes\n or metadata fields.Supported for the following document attribute value type: dateValue and longValue.\n

" + "smithy.api#documentation": "

Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.

" } } }, "traits": { - "smithy.api#documentation": "

The filter criteria used on responses based on document attributes or metadata\n fields.

" + "smithy.api#documentation": "

The filter criteria used on responses based on document attributes or metadata fields.

" } }, "com.amazonaws.qapps#AttributeFilters": { @@ -422,7 +422,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates Categories for the Amazon Q Business application environment instance. Web experience users use\n Categories to tag and filter library items. For more information, see Custom\n labels for Amazon Q Apps.

", + "smithy.api#documentation": "

Creates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

", "smithy.api#examples": [ { "title": "Creates the categories for the library", @@ -476,7 +476,7 @@ "id": { "target": "com.amazonaws.qapps#UUID", "traits": { - "smithy.api#documentation": "

The unique identifier to be associated with a category. If you don't include a value, the\n category is automatically assigned a unique identifier.

" + "smithy.api#documentation": "

The unique identifier to be associated with a category. If you don't include a value, the category is automatically assigned a unique identifier.

" } }, "title": { @@ -494,7 +494,7 @@ "color": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The color to be associated with a category. The color must be a hexadecimal value of\n either 3 or 6 digits.

", + "smithy.api#documentation": "

The color to be associated with a category. The color must be a hexadecimal value of either 3 or 6 digits.

", "smithy.api#length": { "min": 4, "max": 7 @@ -550,7 +550,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes Categories for the Amazon Q Business application environment instance. Web experience users use\n Categories to tag and filter library items. For more information, see Custom\n labels for Amazon Q Apps.

", + "smithy.api#documentation": "

Deletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

", "smithy.api#examples": [ { "title": "Deletes the categories in the library", @@ -623,7 +623,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates Categories for the Amazon Q Business application environment instance. Web experience users use\n Categories to tag and filter library items. For more information, see Custom\n labels for Amazon Q Apps.

", + "smithy.api#documentation": "

Updates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

", "smithy.api#examples": [ { "title": "Updates the categories in the library", @@ -881,7 +881,7 @@ "submissionMutation": { "target": "com.amazonaws.qapps#SubmissionMutation", "traits": { - "smithy.api#documentation": "

The structure that describes how the current form card value is mutated. Only applies for\n form cards when multiple responses are allowed.

" + "smithy.api#documentation": "

The structure that describes how the current form card value is mutated. Only applies for form cards when multiple responses are allowed.

" } } }, @@ -981,7 +981,7 @@ "color": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The color of the category, represented as a hexadecimal value of either 3 or 6\n digits.

", + "smithy.api#documentation": "

The color of the category, represented as a hexadecimal value of either 3 or 6 digits.

", "smithy.api#length": { "min": 4, "max": 7 @@ -991,7 +991,7 @@ } }, "traits": { - "smithy.api#documentation": "

A label that web experience users associate with a library item. Web experience users use\n Categories to tag and filter library items.

" + "smithy.api#documentation": "

A label that web experience users associate with a library item. Web experience users use Categories to tag and filter library items.

" } }, "com.amazonaws.qapps#CategoryList": { @@ -1041,7 +1041,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation could not be completed due to a conflict with the current state of\n the resource.

", + "smithy.api#documentation": "

The requested operation could not be completed due to a conflict with the current state of the resource.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1071,7 +1071,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation could not be completed because the content exceeds the maximum\n allowed size.

", + "smithy.api#documentation": "

The requested operation could not be completed because the content exceeds the maximum allowed size.

", "smithy.api#error": "client", "smithy.api#httpError": 413 } @@ -1133,7 +1133,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new library item for an Amazon Q App, allowing it to be discovered and used by\n other allowed users.

", + "smithy.api#documentation": "

Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.

", "smithy.api#examples": [ { "title": "Create a Library Item", @@ -1287,7 +1287,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to\n set a default file for a FileUploadCard in a Q App definition or to provide a\n file for a single Q App run. The scope parameter determines how the file will be\n used, either at the app definition level or the app session level.

", + "smithy.api#documentation": "

Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to set a default file for a FileUploadCard in a Q App definition or to provide a file for a single Q App run. The scope parameter determines how the file will be used, either at the app definition level or the app session level.

The IAM permissions are derived from the qapps:ImportDocument action. For more information on the IAM policy for Amazon Q Apps, see IAM permissions for using Amazon Q Apps.

", "smithy.api#examples": [ { "title": "Upload a file to a specific session", @@ -1384,14 +1384,14 @@ "scope": { "target": "com.amazonaws.qapps#DocumentScope", "traits": { - "smithy.api#documentation": "

Whether the file is associated with a Q App definition or a specific Q App\n session.

", + "smithy.api#documentation": "

Whether the file is associated with a Q App definition or a specific Q App session.

", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.qapps#UUID", "traits": { - "smithy.api#documentation": "

The unique identifier of the Q App session the file is associated with, if\n applicable.

" + "smithy.api#documentation": "

The unique identifier of the Q App session the file is associated with, if applicable.

" } } }, @@ -1419,7 +1419,7 @@ "presignedUrlFields": { "target": "com.amazonaws.qapps#PresignedUrlFields", "traits": { - "smithy.api#documentation": "

The form fields to include in the presigned S3 POST operation used to upload a\n file.

", + "smithy.api#documentation": "

The form fields to include in the presigned S3 POST operation used to upload a file.

", "smithy.api#required": {} } }, @@ -1470,7 +1470,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon Q App based on the provided definition. The Q App definition specifies\n the cards and flow of the Q App. This operation also calculates the dependencies between the\n cards by inspecting the references in the prompts.

", + "smithy.api#documentation": "

Creates a new Amazon Q App based on the provided definition. The Q App definition specifies the cards and flow of the Q App. This operation also calculates the dependencies between the cards by inspecting the references in the prompts.

", "smithy.api#examples": [ { "title": "A basic application with 1 text input card and 1 output card", @@ -1644,7 +1644,7 @@ "requiredCapabilities": { "target": "com.amazonaws.qapps#AppRequiredCapabilities", "traits": { - "smithy.api#documentation": "

The capabilities required to run the Q App, such as file upload or third-party\n integrations.

" + "smithy.api#documentation": "

The capabilities required to run the Q App, such as file upload or third-party integrations.

" } } }, @@ -1703,7 +1703,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a library item for an Amazon Q App, removing it from the library so it can no longer\n be discovered or used by other users.

", + "smithy.api#documentation": "

Deletes a library item for an Amazon Q App, removing it from the library so it can no longer be discovered or used by other users.

", "smithy.api#examples": [ { "title": "Delete a library item", @@ -1772,7 +1772,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Amazon Q App owned by the user. If the Q App was previously published to the\n library, it is also removed from the library.

", + "smithy.api#documentation": "

Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.

", "smithy.api#examples": [ { "title": "Delete an Amazon Q App", @@ -1914,7 +1914,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are\n returned.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are returned.

" } }, "appId": { @@ -2157,12 +2157,12 @@ "dateValue": { "target": "com.amazonaws.qapps#Timestamp", "traits": { - "smithy.api#documentation": "

A date expressed as an ISO 8601 string.

\n

It's important for the time zone to be included in the ISO 8601\n date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601\n date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.\n

" + "smithy.api#documentation": "

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

" } } }, "traits": { - "smithy.api#documentation": "

The value of a document attribute. You can only provide one value for a document\n attribute.

" + "smithy.api#documentation": "

The value of a document attribute. You can only provide one value for a document attribute.

" } }, "com.amazonaws.qapps#DocumentScope": { @@ -2404,7 +2404,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a file upload card. It can optionally receive a filename and\n fileId to set a default file. If not received, the user must provide the file\n when the Q App runs.

" + "smithy.api#documentation": "

Represents a file upload card. It can optionally receive a filename and fileId to set a default file. If not received, the user must provide the file when the Q App runs.

" } }, "com.amazonaws.qapps#Filename": { @@ -2456,7 +2456,7 @@ "computeMode": { "target": "com.amazonaws.qapps#InputCardComputeMode", "traits": { - "smithy.api#documentation": "

The compute mode of the form input card. This property determines whether individual\n participants of a data collection session can submit multiple response or one response. A\n compute mode of append shall allow participants to submit the same form multiple\n times with different values. A compute mode of replacecode> shall overwrite the\n current value for each participant.

" + "smithy.api#documentation": "

The compute mode of the form input card. This property determines whether individual participants of a data collection session can submit multiple response or one response. A compute mode of append shall allow participants to submit the same form multiple times with different values. A compute mode of replacecode> shall overwrite the current value for each participant.

" } } }, @@ -2499,7 +2499,7 @@ "computeMode": { "target": "com.amazonaws.qapps#InputCardComputeMode", "traits": { - "smithy.api#documentation": "

The compute mode of the form input card. This property determines whether individual\n participants of a data collection session can submit multiple response or one response. A\n compute mode of append shall allow participants to submit the same form multiple\n times with different values. A compute mode of replacecode> shall overwrite the\n current value for each participant.

" + "smithy.api#documentation": "

The compute mode of the form input card. This property determines whether individual participants of a data collection session can submit multiple response or one response. A compute mode of append shall allow participants to submit the same form multiple times with different values. A compute mode of replacecode> shall overwrite the current value for each participant.

" } } }, @@ -2554,7 +2554,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves details about a library item for an Amazon Q App, including its metadata,\n categories, ratings, and usage statistics.

", + "smithy.api#documentation": "

Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.

", "smithy.api#examples": [ { "title": "Retrieve a library item", @@ -2753,7 +2753,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the full details of an Q App, including its definition specifying the cards and\n flow.

", + "smithy.api#documentation": "

Retrieves the full details of an Q App, including its definition specifying the cards and flow.

", "smithy.api#examples": [ { "title": "A basic application with 1 text input card and 1 output card", @@ -2918,7 +2918,7 @@ "requiredCapabilities": { "target": "com.amazonaws.qapps#AppRequiredCapabilities", "traits": { - "smithy.api#documentation": "

The capabilities required to run the Q App, such as file upload or third-party\n integrations.

" + "smithy.api#documentation": "

The capabilities required to run the Q App, such as file upload or third-party integrations.

" } }, "appDefinition": { @@ -3208,7 +3208,7 @@ "userIsHost": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the current user is the owner of the Q App data collection\n session.

" + "smithy.api#documentation": "

Indicates whether the current user is the owner of the Q App data collection session.

" } } }, @@ -3251,7 +3251,7 @@ } ], "traits": { - "smithy.api#documentation": "

Uploads a file that can then be used either as a default in a FileUploadCard\n from Q App definition or as a file that is used inside a single Q App run. The purpose of\n the document is determined by a scope parameter that indicates whether it is at the app\n definition level or at the app session level.

", + "smithy.api#documentation": "

Uploads a file that can then be used either as a default in a FileUploadCard from Q App definition or as a file that is used inside a single Q App run. The purpose of the document is determined by a scope parameter that indicates whether it is at the app definition level or at the app session level.

", "smithy.api#examples": [ { "title": "Upload a file to a specific session", @@ -3331,14 +3331,14 @@ "scope": { "target": "com.amazonaws.qapps#DocumentScope", "traits": { - "smithy.api#documentation": "

Whether the file is associated with a Q App definition or a specific Q App\n session.

", + "smithy.api#documentation": "

Whether the file is associated with a Q App definition or a specific Q App session.

", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.qapps#UUID", "traits": { - "smithy.api#documentation": "

The unique identifier of the Q App session the file is associated with, if\n applicable.

" + "smithy.api#documentation": "

The unique identifier of the Q App session the file is associated with, if applicable.

" } } }, @@ -3509,7 +3509,7 @@ } }, "traits": { - "smithy.api#documentation": "

A library item is a snapshot of an Amazon Q App that can be published so the users in their\n Amazon Q Apps library can discover it, clone it, and run it.

" + "smithy.api#documentation": "

A library item is a snapshot of an Amazon Q App that can be published so the users in their Amazon Q Apps library can discover it, clone it, and run it.

" } }, "com.amazonaws.qapps#LibraryItemStatus": { @@ -3558,7 +3558,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the categories of a Amazon Q Business application environment instance. For more information, see\n Custom labels for Amazon Q Apps.

", + "smithy.api#documentation": "

Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.

", "smithy.api#examples": [ { "title": "List categories available for the library items in this instance", @@ -3649,7 +3649,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the library items for Amazon Q Apps that are published and available for users in your\n Amazon Web Services account.

", + "smithy.api#documentation": "

Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.

", "smithy.api#examples": [ { "title": "List at most 3 library items for this instance", @@ -3922,7 +3922,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Amazon Q Apps owned by or associated with the user either because they created it\n or because they used it from the library in the past. The user identity is extracted from the\n credentials used to invoke this operation..

", + "smithy.api#documentation": "

Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user identity is extracted from the credentials used to invoke this operation..

", "smithy.api#examples": [ { "title": "List at most 3 Amazon Q Apps in an Q Business application", @@ -4410,7 +4410,7 @@ } }, "traits": { - "smithy.api#documentation": "

The definition of an Amazon Q App generated based on input such as a conversation or problem\n statement.

" + "smithy.api#documentation": "

The definition of an Amazon Q App generated based on input such as a conversation or problem statement.

" } }, "com.amazonaws.qapps#PredictQApp": { @@ -4439,7 +4439,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates an Amazon Q App definition based on either a conversation or a problem statement\n provided as input.The resulting app definition can be used to call CreateQApp.\n This API doesn't create Amazon Q Apps directly.

", + "smithy.api#documentation": "

Generates an Amazon Q App definition based on either a conversation or a problem statement provided as input.The resulting app definition can be used to call CreateQApp. This API doesn't create Amazon Q Apps directly.

", "smithy.api#http": { "method": "POST", "uri": "/apps.predictQApp" @@ -4463,7 +4463,7 @@ "options": { "target": "com.amazonaws.qapps#PredictQAppInputOptions", "traits": { - "smithy.api#documentation": "

The input to generate the Q App definition from, either a conversation or problem\n statement.

" + "smithy.api#documentation": "

The input to generate the Q App definition from, either a conversation or problem statement.

" } } }, @@ -4612,7 +4612,7 @@ } }, "traits": { - "smithy.api#documentation": "

The response collected for a Amazon Q App session. This container represents a single\n response to a Q App session.

" + "smithy.api#documentation": "

The response collected for a Amazon Q App session. This container represents a single response to a Q App session.

" } }, "com.amazonaws.qapps#QAppSessionDataList": { @@ -4741,7 +4741,7 @@ "name": "qapps" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create\n lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience.\n For example, users can create a Q App that exclusively generates marketing-related content to\n improve your marketing team's productivity or a Q App for writing customer emails and\n creating promotional content using a certain style of voice, tone, and branding. For more\n information on the capabilities, see Amazon Q Apps capabilities in the Amazon Q Business User\n Guide.

\n

For an overview of the Amazon Q App APIs, see Overview of Amazon Q Apps API\n operations.

\n

For information about the IAM access control permissions you need to use\n the Amazon Q Apps API, see \n IAM role for the Amazon Q Business web experience including Amazon Q Apps in\n the Amazon Q Business User Guide.

", + "smithy.api#documentation": "

The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience. For example, users can create a Q App that exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more information on the capabilities, see Amazon Q Apps capabilities in the Amazon Q Business User Guide.

For an overview of the Amazon Q App APIs, see Overview of Amazon Q Apps API operations.

For information about the IAM access control permissions you need to use the Amazon Q Apps API, see IAM role for the Amazon Q Business web experience including Amazon Q Apps in the Amazon Q Business User Guide.

", "smithy.api#title": "QApps", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -5251,17 +5251,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5275,17 +5264,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5299,17 +5277,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5323,17 +5290,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5582,7 +5538,7 @@ "memoryReferences": { "target": "com.amazonaws.qapps#MemoryReferenceList", "traits": { - "smithy.api#documentation": "

Any dependencies for the query card, where the dependencies are references to the\n collected responses.

" + "smithy.api#documentation": "

Any dependencies for the query card, where the dependencies are references to the collected responses.

" } } }, @@ -5726,7 +5682,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation could not be completed because it would exceed the service's quota\n or limit.

", + "smithy.api#documentation": "

The requested operation could not be completed because it would exceed the service's quota or limit.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -5761,7 +5717,7 @@ "revealCards": { "target": "com.amazonaws.qapps#SessionSharingRevealCards", "traits": { - "smithy.api#documentation": "

Indicates whether collected responses for an Q App session are revealed for all\n users.

" + "smithy.api#documentation": "

Indicates whether collected responses for an Q App session are revealed for all users.

" } } }, @@ -5807,7 +5763,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be\n run.

\n \n

Each Q App session will be condensed into a single conversation in the web\n experience.

\n
", + "smithy.api#documentation": "

Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.

Each Q App session will be condensed into a single conversation in the web experience.

", "smithy.api#examples": [ { "title": "Start a session for an Amazon Q App using version 1, passing in initial values for one card", @@ -5936,7 +5892,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops an active session for an Amazon Q App.This deletes all data related to the session and\n makes it invalid for future uses. The results of the session will be persisted as part of the\n conversation.

", + "smithy.api#documentation": "

Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. The results of the session will be persisted as part of the conversation.

", "smithy.api#http": { "method": "POST", "uri": "/runtime.deleteMiniAppRun" @@ -6295,7 +6251,7 @@ } }, "traits": { - "smithy.api#documentation": "

The requested operation could not be completed because too many requests were sent at\n once. Wait a bit and try again later.

", + "smithy.api#documentation": "

The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { @@ -6731,7 +6687,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing Amazon Q App, allowing modifications to its title, description, and\n definition.

", + "smithy.api#documentation": "

Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.

", "smithy.api#examples": [ { "title": "Updating the title of an app", @@ -7071,7 +7027,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were\n updated.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were updated.

" } }, "appId": { @@ -7123,7 +7079,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the session for a given Q App sessionId. This is only valid when at\n least one card of the session is in the WAITING state. Data for each\n WAITING card can be provided as input. If inputs are not provided, the call\n will be accepted but session will not move forward. Inputs for cards that are not in the\n WAITING status will be ignored.

", + "smithy.api#documentation": "

Updates the session for a given Q App sessionId. This is only valid when at least one card of the session is in the WAITING state. Data for each WAITING card can be provided as input. If inputs are not provided, the call will be accepted but session will not move forward. Inputs for cards that are not in the WAITING status will be ignored.

", "smithy.api#http": { "method": "POST", "uri": "/runtime.updateQAppSession" @@ -7191,7 +7147,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the configuration metadata of a session for a given Q App\n sessionId.

", + "smithy.api#documentation": "

Updates the configuration metadata of a session for a given Q App sessionId.

", "smithy.api#examples": [ { "title": "Updates an existing session metadata for an Amazon Q App", diff --git a/codegen/sdk/aws-models/qbusiness.json b/codegen/sdk/aws-models/qbusiness.json index f84732423d8..d0578c13e5c 100644 --- a/codegen/sdk/aws-models/qbusiness.json +++ b/codegen/sdk/aws-models/qbusiness.json @@ -1591,7 +1591,7 @@ "documents": { "target": "com.amazonaws.qbusiness#Documents", "traits": { - "smithy.api#documentation": "

One or more documents to add to the index.

", + "smithy.api#documentation": "

One or more documents to add to the index.

Ensure that the name of your document doesn't contain any confidential information. Amazon Q Business returns document names in chat responses and citations when relevant.

", "smithy.api#required": {} } }, @@ -1650,7 +1650,7 @@ "blockedPhrases": { "target": "com.amazonaws.qbusiness#BlockedPhrases", "traits": { - "smithy.api#documentation": "

A list of phrases blocked from a Amazon Q Business web experience chat.

" + "smithy.api#documentation": "

A list of phrases blocked from a Amazon Q Business web experience chat.

Each phrase can contain a maximum of 36 characters. The list can contain a maximum of 20 phrases.

" } }, "systemMessageOverride": { @@ -3417,7 +3417,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. This field is required for all connector types except custom connectors, where it is optional.

" } }, "clientToken": { @@ -3878,7 +3878,7 @@ } ], "traits": { - "smithy.api#documentation": "

Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.

Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.

", + "smithy.api#documentation": "

Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.

Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.

For an example IAM role policy for assigning subscriptions, see Set up required permissions in the Amazon Q Business User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/subscriptions" @@ -4137,7 +4137,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role attached to your web experience.

You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role attached to your web experience.

The roleArn parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.

" } }, "tags": { @@ -5179,6 +5179,9 @@ { "target": "com.amazonaws.qbusiness#AccessDeniedException" }, + { + "target": "com.amazonaws.qbusiness#ConflictException" + }, { "target": "com.amazonaws.qbusiness#InternalServerException" }, @@ -6406,7 +6409,7 @@ } }, "traits": { - "smithy.api#documentation": "

The contents of a document.

" + "smithy.api#documentation": "

The contents of a document.

Documents have size limitations. The maximum file size for a document is 50 MB. The maximum amount of text that can be extracted from a single document is 5 MB. For more information, see Supported document formats in Amazon Q Business.

" } }, "com.amazonaws.qbusiness#DocumentContentOperator": { @@ -6845,6 +6848,9 @@ { "target": "com.amazonaws.qbusiness#GetChatResponseConfiguration" }, + { + "target": "com.amazonaws.qbusiness#GetDocumentContent" + }, { "target": "com.amazonaws.qbusiness#GetGroup" }, @@ -8130,6 +8136,108 @@ "smithy.api#output": {} } }, + "com.amazonaws.qbusiness#GetDocumentContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#GetDocumentContentRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#GetDocumentContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a pre-signed URL for secure document access. You can download or view source documents referenced in chat responses through the URL.

", + "smithy.api#http": { + "uri": "/applications/{applicationId}/index/{indexId}/documents/{documentId}/content", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qbusiness#GetDocumentContentRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#IndexId", + "traits": { + "smithy.api#documentation": "

The identifier of the index where documents are indexed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.qbusiness#DataSourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be \"uploaded-docs-file-stat-datasourceid\".

", + "smithy.api#httpQuery": "dataSourceId" + } + }, + "documentId": { + "target": "com.amazonaws.qbusiness#DocumentId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "outputFormat": { + "target": "com.amazonaws.qbusiness#OutputFormat", + "traits": { + "smithy.api#documentation": "

Document outputFormat. Defaults to RAW if not selected.

", + "smithy.api#httpQuery": "outputFormat" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#GetDocumentContentResponse": { + "type": "structure", + "members": { + "presignedUrl": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

A pre-signed URL that provides temporary access to download the document content directly from Amazon Q Business. The URL expires after 5 minutes for security purposes. This URL is generated only after successful ACL validation.

", + "smithy.api#required": {} + } + }, + "mimeType": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The MIME type of the document content. When outputFormat is RAW, this corresponds to the original document's MIME type (e.g., application/pdf, text/plain, application/vnd.openxmlformats-officedocument.wordprocessingml.document). When outputFormat is EXTRACTED, the MIME type is always application/json.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qbusiness#GetGroup": { "type": "operation", "input": { @@ -11656,7 +11764,13 @@ "type": "long" }, "com.amazonaws.qbusiness#MaxResults": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } }, "com.amazonaws.qbusiness#MaxResultsIntegerForGetTopicConfigurations": { "type": "integer", @@ -12423,6 +12537,23 @@ "smithy.api#pattern": "^(http://|https://)[a-zA-Z0-9-_.]+(?::[0-9]{1,5})?$" } }, + "com.amazonaws.qbusiness#OutputFormat": { + "type": "enum", + "members": { + "RAW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RAW" + } + }, + "EXTRACTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTRACTED" + } + } + } + }, "com.amazonaws.qbusiness#Payload": { "type": "string", "traits": { @@ -13971,6 +14102,8 @@ "maxResults": { "target": "com.amazonaws.qbusiness#MaxResults", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 10, "smithy.api#documentation": "

The maximum number of results to return.

" } }, @@ -14132,6 +14265,24 @@ "traits": { "smithy.api#documentation": "

A text extract from a source document that is used for source attribution.

" } + }, + "documentId": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the source document used in the citation, obtained from the Amazon Q Business index during chat response generation. This ID is used as input to the GetDocumentContent API to retrieve the actual document content for user verification.

" + } + }, + "indexId": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The identifier of the index containing the source document's metadata and access control information. This links the citation back to the specific Amazon Q Business index where the document's searchable content and permissions are stored.

" + } + }, + "datasourceId": { + "target": "com.amazonaws.qbusiness#String", + "traits": { + "smithy.api#documentation": "

The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API (similar to checkDocumentAccess). If the document is from a file-upload data source, the datasource will be \"uploaded-docs-file-stat-datasourceid\".

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/qconnect.json b/codegen/sdk/aws-models/qconnect.json index 7ede9425ef9..22ff5f1f9ef 100644 --- a/codegen/sdk/aws-models/qconnect.json +++ b/codegen/sdk/aws-models/qconnect.json @@ -3337,7 +3337,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Q in Connect AI Prompt.

", + "smithy.api#documentation": "

Creates an Amazon Q in Connect AI Prompt.

For more information on supported models, see Supported models for system and custom prompts.

", "smithy.api#http": { "uri": "/assistants/{assistantId}/aiprompts", "method": "POST" @@ -15656,6 +15656,12 @@ "traits": { "smithy.api#documentation": "

The description of the Amazon Q in Connect AI Prompt.

" } + }, + "modelId": { + "target": "com.amazonaws.qconnect#AIPromptModelIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the model used for this AI Prompt.

For more information on supported models, see Supported models for system and custom prompts.

" + } } }, "traits": { @@ -17189,17 +17195,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -17213,17 +17208,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -17237,17 +17221,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -17261,17 +17234,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/qldb-session.json b/codegen/sdk/aws-models/qldb-session.json index ce7bbdaedba..4fcbb5c2ac6 100644 --- a/codegen/sdk/aws-models/qldb-session.json +++ b/codegen/sdk/aws-models/qldb-session.json @@ -1039,17 +1039,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1063,17 +1052,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1087,17 +1065,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1111,17 +1078,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/qldb.json b/codegen/sdk/aws-models/qldb.json index 638deaab8a0..0700c7607d1 100644 --- a/codegen/sdk/aws-models/qldb.json +++ b/codegen/sdk/aws-models/qldb.json @@ -752,17 +752,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -776,17 +765,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -800,17 +778,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -824,17 +791,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/quicksight.json b/codegen/sdk/aws-models/quicksight.json index efa948f619a..e4176b9cc62 100644 --- a/codegen/sdk/aws-models/quicksight.json +++ b/codegen/sdk/aws-models/quicksight.json @@ -54,7 +54,7 @@ "DefaultTheme": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

The default theme for this Amazon QuickSight subscription.

" + "smithy.api#documentation": "

The default theme for this QuickSight subscription.

" } }, "DefaultEmailCustomizationTemplate": { @@ -74,25 +74,25 @@ "AccountName": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The account name that you provided for the Amazon QuickSight subscription in your\n Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It's unique over all of Amazon Web Services, and it appears only when\n users sign in.

" + "smithy.api#documentation": "

The account name that you provided for the QuickSight subscription in your\n Amazon Web Services account. You create this name when you sign up for QuickSight. It's unique over all of Amazon Web Services, and it appears only when\n users sign in.

" } }, "Edition": { "target": "com.amazonaws.quicksight#Edition", "traits": { - "smithy.api#documentation": "

The edition of your Amazon QuickSight account.

" + "smithy.api#documentation": "

The edition of your QuickSight account.

" } }, "NotificationEmail": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.

" + "smithy.api#documentation": "

The email address that will be used for QuickSight to send notifications regarding your Amazon Web Services account or QuickSight subscription.

" } }, "AuthenticationType": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The way that your Amazon QuickSight account is authenticated.

" + "smithy.api#documentation": "

The way that your QuickSight account is authenticated.

" } }, "AccountSubscriptionStatus": { @@ -109,7 +109,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that contains the following account information\n elements:

\n
    \n
  • \n

    Your Amazon QuickSight account name.

    \n
  • \n
  • \n

    The edition of Amazon QuickSight that your account is using.

    \n
  • \n
  • \n

    The notification email address that is associated with the Amazon QuickSight account.\n

    \n
  • \n
  • \n

    The authentication type of the Amazon QuickSight account.

    \n
  • \n
  • \n

    The status of the Amazon QuickSight account's subscription.

    \n
  • \n
" + "smithy.api#documentation": "

A structure that contains the following account information\n elements:

\n
    \n
  • \n

    Your QuickSight account name.

    \n
  • \n
  • \n

    The edition of QuickSight that your account is using.

    \n
  • \n
  • \n

    The notification email address that is associated with the QuickSight account.\n

    \n
  • \n
  • \n

    The authentication type of the QuickSight account.

    \n
  • \n
  • \n

    The status of the QuickSight account's subscription.

    \n
  • \n
" } }, "com.amazonaws.quicksight#AccountName": { @@ -128,44 +128,44 @@ "AccountName": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The \"account name\" you provided for the Amazon QuickSight subscription in your Amazon Web Services account.\n You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and\n it appears only when users sign in.

" + "smithy.api#documentation": "

The \"account name\" you provided for the QuickSight subscription in your Amazon Web Services account.\n You create this name when you sign up for QuickSight. It is unique in all of Amazon Web Services and\n it appears only when users sign in.

" } }, "Edition": { "target": "com.amazonaws.quicksight#Edition", "traits": { - "smithy.api#documentation": "

The edition of Amazon QuickSight that you're currently subscribed to:\n Enterprise edition or Standard edition.

" + "smithy.api#documentation": "

The edition of QuickSight that you're currently subscribed to:\n Enterprise edition or Standard edition.

" } }, "DefaultNamespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The default Amazon QuickSight namespace for your Amazon Web Services account.

" + "smithy.api#documentation": "

The default QuickSight namespace for your Amazon Web Services account.

" } }, "NotificationEmail": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The main notification email for your Amazon QuickSight subscription.

" + "smithy.api#documentation": "

The main notification email for your QuickSight subscription.

" } }, "PublicSharingEnabled": { "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.

" + "smithy.api#documentation": "

A Boolean value that indicates whether public sharing is turned on for an QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.

" } }, "TerminationProtectionEnabled": { "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.

" + "smithy.api#documentation": "

A boolean value that determines whether or not an QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.

" } } }, "traits": { - "smithy.api#documentation": "

The Amazon QuickSight settings associated with your Amazon Web Services account.

" + "smithy.api#documentation": "

The QuickSight settings associated with your Amazon Web Services account.

" } }, "com.amazonaws.quicksight#ActionList": { @@ -592,30 +592,30 @@ "DataQnA": { "target": "com.amazonaws.quicksight#DataQnAConfigurations", "traits": { - "smithy.api#documentation": "

Adds generative Q&A capabilitiees to an embedded Amazon QuickSight console.

" + "smithy.api#documentation": "

Adds generative Q&A capabilitiees to an embedded QuickSight console.

" } }, "GenerativeAuthoring": { "target": "com.amazonaws.quicksight#GenerativeAuthoringConfigurations", "traits": { - "smithy.api#documentation": "

Adds the generative BI authoring experience to an embedded Amazon QuickSight console.

" + "smithy.api#documentation": "

Adds the generative BI authoring experience to an embedded QuickSight console.

" } }, "ExecutiveSummary": { "target": "com.amazonaws.quicksight#ExecutiveSummaryConfigurations", "traits": { - "smithy.api#documentation": "

Adds the executive summaries feature to an embedded Amazon QuickSight console.

" + "smithy.api#documentation": "

Adds the executive summaries feature to an embedded QuickSight console.

" } }, "DataStories": { "target": "com.amazonaws.quicksight#DataStoriesConfigurations", "traits": { - "smithy.api#documentation": "

Adds the data stories feature to an embedded Amazon QuickSight console.

" + "smithy.api#documentation": "

Adds the data stories feature to an embedded QuickSight console.

" } } }, "traits": { - "smithy.api#documentation": "

A collection of Amazon Q feature configurations in an embedded Amazon QuickSight console.

" + "smithy.api#documentation": "

A collection of Amazon Q feature configurations in an embedded QuickSight console.

" } }, "com.amazonaws.quicksight#AmazonQInQuickSightDashboardConfigurations": { @@ -624,12 +624,12 @@ "ExecutiveSummary": { "target": "com.amazonaws.quicksight#ExecutiveSummaryConfigurations", "traits": { - "smithy.api#documentation": "

A generated executive summary of an embedded Amazon QuickSight dashboard.

" + "smithy.api#documentation": "

A generated executive summary of an embedded QuickSight dashboard.

" } } }, "traits": { - "smithy.api#documentation": "

A collection of Amazon Q feature configurations in an embedded Amazon QuickSight dashboard.

" + "smithy.api#documentation": "

A collection of Amazon Q feature configurations in an embedded QuickSight dashboard.

" } }, "com.amazonaws.quicksight#Analysis": { @@ -1028,7 +1028,7 @@ "Name": { "target": "com.amazonaws.quicksight#AnalysisName", "traits": { - "smithy.api#documentation": "

The name of the analysis. This name is displayed in the Amazon QuickSight console.\n

" + "smithy.api#documentation": "

The name of the analysis. This name is displayed in the QuickSight console.\n

" } }, "Status": { @@ -1141,7 +1141,7 @@ "InitialDashboardId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.

\n

The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", + "smithy.api#documentation": "

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders this dashboard.

\n

The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", "smithy.api#required": {} } }, @@ -1222,7 +1222,7 @@ "InitialDashboardVisualId": { "target": "com.amazonaws.quicksight#DashboardVisualId", "traits": { - "smithy.api#documentation": "

The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

\n

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", + "smithy.api#documentation": "

The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders this visual.

\n

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", "smithy.api#required": {} } } @@ -1237,13 +1237,13 @@ "Dashboard": { "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfiguration", "traits": { - "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight dashboards.

" + "smithy.api#documentation": "

The type of embedding experience. In this case, QuickSight dashboards.

" } }, "DashboardVisual": { "target": "com.amazonaws.quicksight#AnonymousUserDashboardVisualEmbeddingConfiguration", "traits": { - "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight visuals.

" + "smithy.api#documentation": "

The type of embedding experience. In this case, QuickSight visuals.

" } }, "QSearchBar": { @@ -1260,7 +1260,7 @@ } }, "traits": { - "smithy.api#documentation": "

The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.

" + "smithy.api#documentation": "

The type of experience you want to embed. For anonymous users, you can embed QuickSight dashboards.

" } }, "com.amazonaws.quicksight#AnonymousUserGenerativeQnAEmbeddingConfiguration": { @@ -1269,7 +1269,7 @@ "InitialTopicId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Generative Q&A experience with this new reader experience topic pre selected.

\n

The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

", + "smithy.api#documentation": "

The QuickSight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders the Generative Q&A experience with this new reader experience topic pre selected.

\n

The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

", "smithy.api#required": {} } } @@ -1284,7 +1284,7 @@ "InitialTopicId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this legacy topic pre-selected.

\n

The Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

", + "smithy.api#documentation": "

The QuickSight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders the Q search bar with this legacy topic pre-selected.

\n

The Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

", "smithy.api#required": {} } } @@ -3572,7 +3572,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.

" + "smithy.api#documentation": "

A structure that contains the configuration of a shared link to an QuickSight dashboard.

" } }, "com.amazonaws.quicksight#AssetBundleResourcePermissions": { @@ -3694,7 +3694,7 @@ "IdentityCenterConfiguration": { "target": "com.amazonaws.quicksight#IdentityCenterConfiguration", "traits": { - "smithy.api#documentation": "

An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup.

\n

This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.

" + "smithy.api#documentation": "

An optional parameter that configures IAM Identity Center authentication to grant QuickSight access to your workgroup.

\n

This parameter can only be specified if your QuickSight account is configured with IAM Identity Center.

" } } }, @@ -5482,7 +5482,7 @@ "BrandId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

", + "smithy.api#documentation": "

The ID of the QuickSight brand.

", "smithy.api#required": {} } }, @@ -5600,7 +5600,7 @@ "BrandId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

" + "smithy.api#documentation": "

The ID of the QuickSight brand.

" } }, "BrandName": { @@ -5773,7 +5773,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 500 + "max": 2000 } } }, @@ -6042,10 +6042,22 @@ "traits": { "smithy.api#documentation": "

The ability to include content in scheduled email reports.

" } + }, + "Dashboard": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to perform dashboard-related actions.

" + } + }, + "Analysis": { + "target": "com.amazonaws.quicksight#CapabilityState", + "traits": { + "smithy.api#documentation": "

The ability to perform analysis-related actions.

" + } } }, "traits": { - "smithy.api#documentation": "

A set of actions that correspond to Amazon QuickSight permissions.

" + "smithy.api#documentation": "

A set of actions that correspond to QuickSight permissions.

" } }, "com.amazonaws.quicksight#CapabilityState": { @@ -6296,13 +6308,13 @@ "FilterListConfiguration": { "target": "com.amazonaws.quicksight#FilterListConfiguration", "traits": { - "smithy.api#documentation": "

A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.

" + "smithy.api#documentation": "

A list of filter configurations. In the QuickSight console, this filter type is called a filter list.

" } }, "CustomFilterListConfiguration": { "target": "com.amazonaws.quicksight#CustomFilterListConfiguration", "traits": { - "smithy.api#documentation": "

A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.

" + "smithy.api#documentation": "

A list of custom filter values. In the QuickSight console, this filter type is called a custom filter list.

" } }, "CustomFilterConfiguration": { @@ -6970,7 +6982,7 @@ "Principals": { "target": "com.amazonaws.quicksight#PrincipalList", "traits": { - "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

" + "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) for QuickSight users or groups.

" } }, "ColumnNames": { @@ -8239,7 +8251,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the\n CreateAccountCustomization or UpdateAccountCustomization\n API operation. To further customize Amazon QuickSight by removing Amazon QuickSight\n sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.\n

\n

You can create customizations for your Amazon Web Services account or, if you specify a namespace, for\n a QuickSight namespace instead. Customizations that apply to a namespace always override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.

\n

Before you use the CreateAccountCustomization API operation to add a theme\n as the namespace default, make sure that you first share the theme with the namespace.\n If you don't share it with the namespace, the theme isn't visible to your users\n even if you make it the default theme.\n To check if the theme is shared, view the current permissions by using the\n \n DescribeThemePermissions\n \n API operation.\n To share the theme, grant permissions by using the\n \n UpdateThemePermissions\n \n API operation.

", + "smithy.api#documentation": "

Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the\n CreateAccountCustomization or UpdateAccountCustomization\n API operation. To further customize QuickSight by removing QuickSight\n sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User Guide.\n

\n

You can create customizations for your Amazon Web Services account or, if you specify a namespace, for\n a QuickSight namespace instead. Customizations that apply to a namespace always override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.

\n

Before you use the CreateAccountCustomization API operation to add a theme\n as the namespace default, make sure that you first share the theme with the namespace.\n If you don't share it with the namespace, the theme isn't visible to your users\n even if you make it the default theme.\n To check if the theme is shared, view the current permissions by using the\n \n DescribeThemePermissions\n \n API operation.\n To share the theme, grant permissions by using the\n \n UpdateThemePermissions\n \n API operation.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/customizations", @@ -8253,7 +8265,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

", + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to customize QuickSight for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8261,14 +8273,14 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that you want to add customizations to.

", + "smithy.api#documentation": "

The QuickSight namespace that you want to add customizations to.

", "smithy.api#httpQuery": "namespace" } }, "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add\n these to an Amazon Web Services account and a QuickSight namespace.

\n

For example, you can add a default theme by setting AccountCustomization\n to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by\n specifying \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }.

", + "smithy.api#documentation": "

The QuickSight customizations you're adding in the current Amazon Web Services Region. You can add\n these to an Amazon Web Services account and a QuickSight namespace.

\n

For example, you can add a default theme by setting AccountCustomization\n to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by\n specifying \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }.

", "smithy.api#required": {} } }, @@ -8295,7 +8307,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

" + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to customize QuickSight for.

" } }, "Namespace": { @@ -8307,7 +8319,7 @@ "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.

" + "smithy.api#documentation": "

The QuickSight customizations you're adding in the current Amazon Web Services Region.

" } }, "RequestId": { @@ -8367,7 +8379,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.

\n

The Amazon Web Services Region for the account is derived from what is configured in the\n CLI or SDK.

\n

Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign\n up for Amazon Web Services in the Amazon QuickSight User\n Guide. The person who signs up for Amazon QuickSight needs to have the\n correct Identity and Access Management (IAM) permissions. For more information,\n see IAM Policy Examples for Amazon QuickSight in the\n Amazon QuickSight User Guide.

\n

If your IAM policy includes both the Subscribe and\n CreateAccountSubscription actions, make sure that both actions are set\n to Allow. If either action is set to Deny, the\n Deny action prevails and your API call fails.

\n

You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to\n Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the\n Amazon QuickSight User Guide.

\n

You can't set default resource access on the new account from the Amazon QuickSight\n API. Instead, add default resource access from the Amazon QuickSight console. For more\n information about setting default resource access to Amazon Web Services services, see\n Setting default resource\n access to Amazon Web Services services in the Amazon QuickSight\n User Guide.

", + "smithy.api#documentation": "

Creates an QuickSight account, or subscribes to QuickSight Q.

\n

The Amazon Web Services Region for the account is derived from what is configured in the\n CLI or SDK.

\n

Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign\n up for Amazon Web Services in the Amazon QuickSight User\n Guide. The person who signs up for QuickSight needs to have the\n correct Identity and Access Management (IAM) permissions. For more information,\n see IAM Policy Examples for QuickSight in the\n QuickSight User Guide.

\n

If your IAM policy includes both the Subscribe and\n CreateAccountSubscription actions, make sure that both actions are set\n to Allow. If either action is set to Deny, the\n Deny action prevails and your API call fails.

\n

You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to\n QuickSight, see Passing IAM roles to QuickSight in the\n QuickSight User Guide.

\n

You can't set default resource access on the new account from the QuickSight\n API. Instead, add default resource access from the QuickSight console. For more\n information about setting default resource access to Amazon Web Services services, see\n Setting default resource\n access to Amazon Web Services services in the QuickSight\n User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/account/{AwsAccountId}", @@ -8381,20 +8393,20 @@ "Edition": { "target": "com.amazonaws.quicksight#Edition", "traits": { - "smithy.api#documentation": "

The edition of Amazon QuickSight that you want your account to have. Currently, you can\n choose from ENTERPRISE or\n ENTERPRISE_AND_Q.

\n

If you choose ENTERPRISE_AND_Q, the following parameters are\n required:

\n
    \n
  • \n

    \n FirstName\n

    \n
  • \n
  • \n

    \n LastName\n

    \n
  • \n
  • \n

    \n EmailAddress\n

    \n
  • \n
  • \n

    \n ContactNumber\n

    \n
  • \n
" + "smithy.api#documentation": "

The edition of QuickSight that you want your account to have. Currently, you can\n choose from ENTERPRISE or\n ENTERPRISE_AND_Q.

\n

If you choose ENTERPRISE_AND_Q, the following parameters are\n required:

\n
    \n
  • \n

    \n FirstName\n

    \n
  • \n
  • \n

    \n LastName\n

    \n
  • \n
  • \n

    \n EmailAddress\n

    \n
  • \n
  • \n

    \n ContactNumber\n

    \n
  • \n
" } }, "AuthenticationMethod": { "target": "com.amazonaws.quicksight#AuthenticationMethodOption", "traits": { - "smithy.api#documentation": "

The method that you want to use to authenticate your Amazon QuickSight account.

\n

If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName\n and an AdminGroup associated with your Active Directory.

\n

If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

", + "smithy.api#documentation": "

The method that you want to use to authenticate your QuickSight account.

\n

If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName\n and an AdminGroup associated with your Active Directory.

\n

If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

", "smithy.api#required": {} } }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.

", + "smithy.api#documentation": "

The Amazon Web Services account ID of the account that you're using to create your QuickSight account.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8402,93 +8414,93 @@ "AccountName": { "target": "com.amazonaws.quicksight#AccountName", "traits": { - "smithy.api#documentation": "

The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change\n AccountName value after the Amazon QuickSight account is\n created.

", + "smithy.api#documentation": "

The name of your QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change\n AccountName value after the QuickSight account is\n created.

", "smithy.api#required": {} } }, "NotificationEmail": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

", + "smithy.api#documentation": "

The email address that you want QuickSight to send notifications to regarding your QuickSight account or QuickSight subscription.

", "smithy.api#required": {} } }, "ActiveDirectoryName": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

" + "smithy.api#documentation": "

The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new QuickSight account.

" } }, "Realm": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

" + "smithy.api#documentation": "

The realm of the Active Directory that is associated with your QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new QuickSight account.

" } }, "DirectoryId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The ID of the Active Directory that is associated with your Amazon QuickSight account.

" + "smithy.api#documentation": "

The ID of the Active Directory that is associated with your QuickSight account.

" } }, "AdminGroup": { "target": "com.amazonaws.quicksight#GroupsList", "traits": { - "smithy.api#documentation": "

The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + "smithy.api#documentation": "

The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new QuickSight account.

\n

For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.

" } }, "AuthorGroup": { "target": "com.amazonaws.quicksight#GroupsList", "traits": { - "smithy.api#documentation": "

The author group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + "smithy.api#documentation": "

The author group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.

" } }, "ReaderGroup": { "target": "com.amazonaws.quicksight#GroupsList", "traits": { - "smithy.api#documentation": "

The reader group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + "smithy.api#documentation": "

The reader group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.

" } }, "AdminProGroup": { "target": "com.amazonaws.quicksight#GroupsList", "traits": { - "smithy.api#documentation": "

The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + "smithy.api#documentation": "

The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new QuickSight account.

\n

For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.

" } }, "AuthorProGroup": { "target": "com.amazonaws.quicksight#GroupsList", "traits": { - "smithy.api#documentation": "

The author pro group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + "smithy.api#documentation": "

The author pro group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.

" } }, "ReaderProGroup": { "target": "com.amazonaws.quicksight#GroupsList", "traits": { - "smithy.api#documentation": "

The reader pro group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + "smithy.api#documentation": "

The reader pro group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in QuickSight, see Using IAM Identity Center with QuickSight Enterprise Edition in the QuickSight User Guide. For more information about using Active Directory in QuickSight, see Using Active Directory with QuickSight Enterprise Edition in the QuickSight User Guide.

" } }, "FirstName": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The first name of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" + "smithy.api#documentation": "

The first name of the author of the QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new QuickSight account.

" } }, "LastName": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The last name of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" + "smithy.api#documentation": "

The last name of the author of the QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new QuickSight account.

" } }, "EmailAddress": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The email address of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" + "smithy.api#documentation": "

The email address of the author of the QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new QuickSight account.

" } }, "ContactNumber": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

A 10-digit phone number for the author of the Amazon QuickSight account to use for\n future communications. This field is required if ENTERPPRISE_AND_Q is the\n selected edition of the new Amazon QuickSight account.

" + "smithy.api#documentation": "

A 10-digit phone number for the author of the QuickSight account to use for\n future communications. This field is required if ENTERPPRISE_AND_Q is the\n selected edition of the new QuickSight account.

" } }, "IAMIdentityCenterInstanceArn": { @@ -8508,7 +8520,7 @@ "SignupResponse": { "target": "com.amazonaws.quicksight#SignupResponse", "traits": { - "smithy.api#documentation": "

A SignupResponse object that returns information about a newly created Amazon QuickSight account.

" + "smithy.api#documentation": "

A SignupResponse object that returns information about a newly created QuickSight account.

" } }, "Status": { @@ -8595,7 +8607,7 @@ "Name": { "target": "com.amazonaws.quicksight#AnalysisName", "traits": { - "smithy.api#documentation": "

A descriptive name for the analysis that you're creating. This name displays for the\n analysis in the Amazon QuickSight console.

", + "smithy.api#documentation": "

A descriptive name for the analysis that you're creating. This name displays for the\n analysis in the QuickSight console.

", "smithy.api#required": {} } }, @@ -8620,7 +8632,7 @@ "ThemeArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

The ARN for the theme to apply to the analysis that you're creating. To see the theme\n in the Amazon QuickSight console, make sure that you have access to it.

" + "smithy.api#documentation": "

The ARN for the theme to apply to the analysis that you're creating. To see the theme\n in the QuickSight console, make sure that you have access to it.

" } }, "Tags": { @@ -8644,7 +8656,7 @@ "FolderArns": { "target": "com.amazonaws.quicksight#FolderArnList", "traits": { - "smithy.api#documentation": "

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

" + "smithy.api#documentation": "

When you create the analysis, QuickSight adds the analysis to these folders.

" } } }, @@ -8721,7 +8733,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon QuickSight brand.

", + "smithy.api#documentation": "

Creates an QuickSight brand.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/brands/{BrandId}", @@ -8743,7 +8755,7 @@ "BrandId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

", + "smithy.api#documentation": "

The ID of the QuickSight brand.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8952,7 +8964,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the \n \n CreateTemplate\n \n API operation.

\n

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created\n from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can\n create scheduled email reports from them. If you have the correct permissions, you can\n create a dashboard from a template that exists in a different Amazon Web Services account.

", + "smithy.api#documentation": "

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the \n \n CreateTemplate\n \n API operation.

\n

A dashboard is an entity in QuickSight that identifies QuickSight reports, created\n from analyses. You can share QuickSight dashboards. With the right permissions, you can\n create scheduled email reports from them. If you have the correct permissions, you can\n create a dashboard from a template that exists in a different Amazon Web Services account.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", @@ -9001,7 +9013,7 @@ "SourceEntity": { "target": "com.amazonaws.quicksight#DashboardSourceEntity", "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you create the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only create a dashboard from a template, so you use a SourceTemplate\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the \n CreateTemplate\n \n API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplateARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" + "smithy.api#documentation": "

The entity that you are using as a source when you create the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only create a dashboard from a template, so you use a SourceTemplate\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the \n CreateTemplate\n \n API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplateARN can contain any Amazon Web Services account and any\n QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" } }, "Tags": { @@ -9019,7 +9031,7 @@ "DashboardPublishOptions": { "target": "com.amazonaws.quicksight#DashboardPublishOptions", "traits": { - "smithy.api#documentation": "

Options for publishing the dashboard when you create it:

\n
    \n
  • \n

    \n AvailabilityStatus for AdHocFilteringOption - This\n status can be either ENABLED or DISABLED. When this is\n set to DISABLED, Amazon QuickSight disables the left filter pane on the\n published dashboard, which can be used for ad hoc (one-time) filtering. This\n option is ENABLED by default.

    \n
  • \n
  • \n

    \n AvailabilityStatus for ExportToCSVOption - This\n status can be either ENABLED or DISABLED. The visual\n option to export data to .CSV format isn't enabled when this is set to\n DISABLED. This option is ENABLED by default.

    \n
  • \n
  • \n

    \n VisibilityState for SheetControlsOption - This\n visibility state can be either COLLAPSED or EXPANDED.\n This option is COLLAPSED by default.

    \n
  • \n
" + "smithy.api#documentation": "

Options for publishing the dashboard when you create it:

\n
    \n
  • \n

    \n AvailabilityStatus for AdHocFilteringOption - This\n status can be either ENABLED or DISABLED. When this is\n set to DISABLED, QuickSight disables the left filter pane on the\n published dashboard, which can be used for ad hoc (one-time) filtering. This\n option is ENABLED by default.

    \n
  • \n
  • \n

    \n AvailabilityStatus for ExportToCSVOption - This\n status can be either ENABLED or DISABLED. The visual\n option to export data to .CSV format isn't enabled when this is set to\n DISABLED. This option is ENABLED by default.

    \n
  • \n
  • \n

    \n VisibilityState for SheetControlsOption - This\n visibility state can be either COLLAPSED or EXPANDED.\n This option is COLLAPSED by default.

    \n
  • \n
  • \n

    \n AvailabilityStatus for ExecutiveSummaryOption - This status\n can be either ENABLED or DISABLED. The option to build an executive\n summary is disabled when this is set to DISABLED. This option is ENABLED\n by default.

    \n
  • \n
  • \n

    \n AvailabilityStatus for DataStoriesSharingOption - This status\n can be either ENABLED or DISABLED. The option to share a data story is\n disabled when this is set to DISABLED. This option is ENABLED\n by default.

    \n
  • \n
" } }, "ThemeArn": { @@ -9043,7 +9055,7 @@ "FolderArns": { "target": "com.amazonaws.quicksight#FolderArnList", "traits": { - "smithy.api#documentation": "

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

" + "smithy.api#documentation": "

When you create the dashboard, QuickSight adds the dashboard to these folders.

" } }, "LinkSharingConfiguration": { @@ -9203,7 +9215,7 @@ "ColumnGroups": { "target": "com.amazonaws.quicksight#ColumnGroupList", "traits": { - "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

" + "smithy.api#documentation": "

Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.

" } }, "FieldFolders": { @@ -9254,7 +9266,7 @@ "FolderArns": { "target": "com.amazonaws.quicksight#FolderArnList", "traits": { - "smithy.api#documentation": "

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

" + "smithy.api#documentation": "

When you create the dataset, QuickSight adds the dataset to these folders.

" } }, "PerformanceConfiguration": { @@ -9401,13 +9413,13 @@ "DataSourceParameters": { "target": "com.amazonaws.quicksight#DataSourceParameters", "traits": { - "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying source.

" + "smithy.api#documentation": "

The parameters that QuickSight uses to connect to your underlying source.

" } }, "Credentials": { "target": "com.amazonaws.quicksight#DataSourceCredentials", "traits": { - "smithy.api#documentation": "

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only\n\t\t\tcredentials based on user name and password are supported.

" + "smithy.api#documentation": "

The credentials QuickSight that uses to connect to your underlying source. Currently, only\n\t\t\tcredentials based on user name and password are supported.

" } }, "Permissions": { @@ -9419,13 +9431,13 @@ "VpcConnectionProperties": { "target": "com.amazonaws.quicksight#VpcConnectionProperties", "traits": { - "smithy.api#documentation": "

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.

" + "smithy.api#documentation": "

Use this parameter only when you want QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.

" } }, "SslProperties": { "target": "com.amazonaws.quicksight#SslProperties", "traits": { - "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

" + "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.

" } }, "Tags": { @@ -9437,7 +9449,7 @@ "FolderArns": { "target": "com.amazonaws.quicksight#FolderArnList", "traits": { - "smithy.api#documentation": "

When you create the data source, Amazon QuickSight adds the data source to these folders.

" + "smithy.api#documentation": "

When you create the data source, QuickSight adds the data source to these folders.

" } } }, @@ -9773,7 +9785,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support.

\n

The permissions resource is\n\t\t\t\t\tarn:aws:quicksight:::group/default/\n .

\n

The response is a group object.

", + "smithy.api#documentation": "

Use the CreateGroup operation to create a group in QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support.

\n

The permissions resource is\n\t\t\t\t\tarn:aws:quicksight:::group/default/\n .

\n

The response is a group object.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups", @@ -10002,7 +10014,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.

", + "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to assign an IAM policy to QuickSight users or groups.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10024,13 +10036,13 @@ "PolicyArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

The ARN for the IAM policy to apply to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" + "smithy.api#documentation": "

The ARN for the IAM policy to apply to the QuickSight users and\n\t\t\tgroups specified in this assignment.

" } }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that you want to assign the policy\n\t\t\tto.

" + "smithy.api#documentation": "

The QuickSight users, groups, or both that you want to assign the policy\n\t\t\tto.

" } }, "Namespace": { @@ -10070,13 +10082,13 @@ "PolicyArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

The ARN for the IAM policy that is applied to the Amazon QuickSight\n\t\t\tusers and groups specified in this assignment.

" + "smithy.api#documentation": "

The ARN for the IAM policy that is applied to the QuickSight\n\t\t\tusers and groups specified in this assignment.

" } }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that the IAM policy is\n\t\t\tassigned to.

" + "smithy.api#documentation": "

The QuickSight users, groups, or both that the IAM policy is\n\t\t\tassigned to.

" } }, "RequestId": { @@ -10257,7 +10269,7 @@ } ], "traits": { - "smithy.api#documentation": "

(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.

\n

A namespace allows you to isolate the Amazon QuickSight users and groups that are registered\n for that namespace. Users that access the namespace can share assets only with other\n users or groups in the same namespace. They can't see users and groups in other\n namespaces. You can create a namespace after your Amazon Web Services account is subscribed to\n Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a\n limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with\n Amazon Web ServicesSupport.

", + "smithy.api#documentation": "

(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.

\n

A namespace allows you to isolate the QuickSight users and groups that are registered\n for that namespace. Users that access the namespace can share assets only with other\n users or groups in the same namespace. They can't see users and groups in other\n namespaces. You can create a namespace after your Amazon Web Services account is subscribed to\n QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a\n limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with\n Amazon Web Services Support.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}", @@ -10271,7 +10283,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

", + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create the QuickSight namespace in.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10307,7 +10319,7 @@ "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon QuickSight namespace you created.

" + "smithy.api#documentation": "

The ARN of the QuickSight namespace you created.

" } }, "Name": { @@ -10493,7 +10505,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.

", + "smithy.api#documentation": "

Use CreateRoleMembership to add an existing QuickSight group to an existing role.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}", @@ -10601,7 +10613,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting\n\t\t\ttemplate to create additional dashboards, templates, or analyses.

\n

A template is an entity in Amazon QuickSight that encapsulates the metadata\n\t\t\trequired to create an analysis and that you can use to create s dashboard. A template adds\n\t\t\ta layer of abstraction by using placeholders to replace the dataset associated with the\n\t\t\tanalysis. You can use templates to create dashboards by replacing dataset placeholders\n\t\t\twith datasets that follow the same schema that was used to create the source analysis\n\t\t\tand template.

", + "smithy.api#documentation": "

Creates a template either from a TemplateDefinition or from an existing QuickSight analysis or template. You can use the resulting\n\t\t\ttemplate to create additional dashboards, templates, or analyses.

\n

A template is an entity in QuickSight that encapsulates the metadata\n\t\t\trequired to create an analysis and that you can use to create s dashboard. A template adds\n\t\t\ta layer of abstraction by using placeholders to replace the dataset associated with the\n\t\t\tanalysis. You can use templates to create dashboards by replacing dataset placeholders\n\t\t\twith datasets that follow the same schema that was used to create the source analysis\n\t\t\tand template.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", @@ -10671,7 +10683,7 @@ "AliasName": { "target": "com.amazonaws.quicksight#AliasName", "traits": { - "smithy.api#documentation": "

The name that you want to give to the template alias that you're creating. Don't start the\n\t\t\talias name with the $ character. Alias names that start with $\n\t\t\tare reserved by Amazon QuickSight.

", + "smithy.api#documentation": "

The name that you want to give to the template alias that you're creating. Don't start the\n\t\t\talias name with the $ character. Alias names that start with $\n\t\t\tare reserved by QuickSight.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10750,7 +10762,7 @@ "SourceEntity": { "target": "com.amazonaws.quicksight#TemplateSourceEntity", "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you create the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

\n

Either a SourceEntity or a Definition must be provided in \n\t\t\torder for the request to be valid.

" + "smithy.api#documentation": "

The entity that you are using as a source when you create the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

\n

Either a SourceEntity or a Definition must be provided in \n\t\t\torder for the request to be valid.

" } }, "Tags": { @@ -11790,6 +11802,20 @@ } } }, + "com.amazonaws.quicksight#CustomConnectionParameters": { + "type": "structure", + "members": { + "ConnectionType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The type of custom connector.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a custom connection data source.

" + } + }, "com.amazonaws.quicksight#CustomContentConfiguration": { "type": "structure", "members": { @@ -12195,7 +12221,7 @@ } }, "traits": { - "smithy.api#documentation": "

The customer managed key that is registered to your Amazon QuickSight account is unavailable.

", + "smithy.api#documentation": "

The customer managed key that is registered to your QuickSight account is unavailable.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -12506,7 +12532,19 @@ "DataQAEnabledOption": { "target": "com.amazonaws.quicksight#DataQAEnabledOption", "traits": { - "smithy.api#documentation": "

Adds Q&A capabilities to an Amazon QuickSight dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is used.

" + "smithy.api#documentation": "

Adds Q&A capabilities to an QuickSight dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is used.

" + } + }, + "ExecutiveSummaryOption": { + "target": "com.amazonaws.quicksight#ExecutiveSummaryOption", + "traits": { + "smithy.api#documentation": "

Executive summary option.

" + } + }, + "DataStoriesSharingOption": { + "target": "com.amazonaws.quicksight#DataStoriesSharingOption", + "traits": { + "smithy.api#documentation": "

Data stories sharing option.

" } } }, @@ -12858,27 +12896,27 @@ "DashboardId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

", + "smithy.api#documentation": "

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

", "smithy.api#required": {} } }, "SheetId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

", + "smithy.api#documentation": "

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the QuickSight console.

", "smithy.api#required": {} } }, "VisualId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

", + "smithy.api#documentation": "

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the QuickSight console.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A structure that contains the following elements:

\n
    \n
  • \n

    The DashboardId of the dashboard that has the visual that you want to embed.

    \n
  • \n
  • \n

    The SheetId of the sheet that has the visual that you want to embed.

    \n
  • \n
  • \n

    The VisualId of the visual that you want to embed.

    \n
  • \n
\n

The DashboardId, SheetId, and VisualId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

" + "smithy.api#documentation": "

A structure that contains the following elements:

\n
    \n
  • \n

    The DashboardId of the dashboard that has the visual that you want to embed.

    \n
  • \n
  • \n

    The SheetId of the sheet that has the visual that you want to embed.

    \n
  • \n
  • \n

    The VisualId of the visual that you want to embed.

    \n
  • \n
\n

The DashboardId, SheetId, and VisualId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

" } }, "com.amazonaws.quicksight#DashboardVisualPublishOptions": { @@ -13498,13 +13536,13 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

The generative Q&A settings of an embedded Amazon QuickSight console.

", + "smithy.api#documentation": "

The generative Q&A settings of an embedded QuickSight console.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The generative Q&A settings of an embedded Amazon QuickSight console.

" + "smithy.api#documentation": "

The generative Q&A settings of an embedded QuickSight console.

" } }, "com.amazonaws.quicksight#DataSet": { @@ -14086,13 +14124,13 @@ "VpcConnectionProperties": { "target": "com.amazonaws.quicksight#VpcConnectionProperties", "traits": { - "smithy.api#documentation": "

The VPC connection information. You need to use this parameter only when you want\n Amazon QuickSight to use a VPC connection when connecting to your underlying source.

" + "smithy.api#documentation": "

The VPC connection information. You need to use this parameter only when you want\n QuickSight to use a VPC connection when connecting to your underlying source.

" } }, "SslProperties": { "target": "com.amazonaws.quicksight#SslProperties", "traits": { - "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your\n underlying source.

" + "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when QuickSight connects to your\n underlying source.

" } }, "ErrorInfo": { @@ -14411,6 +14449,12 @@ "traits": { "smithy.api#documentation": "

The parameters for Impala.

" } + }, + "CustomConnectionParameters": { + "target": "com.amazonaws.quicksight#CustomConnectionParameters", + "traits": { + "smithy.api#documentation": "

The parameters for custom connectors.

" + } } }, "traits": { @@ -14696,6 +14740,12 @@ "traits": { "smithy.api#enumValue": "BIGQUERY" } + }, + "GOOGLESHEETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLESHEETS" + } } } }, @@ -14706,13 +14756,27 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

The data story settings of an embedded Amazon QuickSight console.

", + "smithy.api#documentation": "

The data story settings of an embedded QuickSight console.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The data story settings of an embedded Amazon QuickSight console.

" + "smithy.api#documentation": "

The data story settings of an embedded QuickSight console.

" + } + }, + "com.amazonaws.quicksight#DataStoriesSharingOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

Availability status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Executive summary option.

" } }, "com.amazonaws.quicksight#Database": { @@ -16130,6 +16194,77 @@ "smithy.api#documentation": "

The default options that correspond to the TextField filter control type.

" } }, + "com.amazonaws.quicksight#DeleteAccountCustomPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteAccountCustomPermissionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteAccountCustomPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Unapplies a custom permissions profile from an account.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/custom-permission", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteAccountCustomPermissionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account from which you want to unapply the custom permissions profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteAccountCustomPermissionResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DeleteAccountCustomization": { "type": "operation", "input": { @@ -16168,7 +16303,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified\n Amazon Web Services account and Amazon QuickSight namespace.

", + "smithy.api#documentation": "\n

This API permanently deletes all QuickSight customizations for the specified Amazon Web Services account and namespace in this Amazon Web Services Region. When you delete account customizations:

\n
    \n
  • \n

    All customizations are removed including themes, branding, and visual settings

    \n
  • \n
  • \n

    The deletion affects only the specified Amazon Web Services Region - customizations in other regions remain unchanged

    \n
  • \n
  • \n

    This action cannot be undone through the API

    \n
  • \n
  • \n

    Users will see default QuickSight styling after customizations are deleted

    \n
  • \n
\n

\n Before proceeding: Ensure you have backups of any custom themes or branding elements you may want to recreate.

\n
\n

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified\n Amazon Web Services account and QuickSight namespace.

", "smithy.api#http": { "method": "DELETE", "uri": "/accounts/{AwsAccountId}/customizations", @@ -16182,7 +16317,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in\n this Amazon Web Services Region.

", + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to delete QuickSight customizations from in\n this Amazon Web Services Region.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -16190,7 +16325,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that you're deleting the customizations from.

", + "smithy.api#documentation": "

The QuickSight namespace that you're deleting the customizations from.

", "smithy.api#httpQuery": "namespace" } } @@ -16253,7 +16388,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

", + "smithy.api#documentation": "\n

Deleting your QuickSight account subscription has permanent, irreversible consequences across all Amazon Web Services regions:

\n
    \n
  • \n

    Global deletion – Running this operation from any single region will delete your QuickSight account and all data in every Amazon Web Services region where you have QuickSight resources.

    \n
  • \n
  • \n

    Complete data loss – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions.

    \n
  • \n
  • \n

    Embedded content failure – All embedded dashboards and visuals in your applications will immediately stop working and display errors to end users.

    \n
  • \n
  • \n

    Shared resources removed – All shared dashboards, folders, and resources will become inaccessible to other users and external recipients.

    \n
  • \n
  • \n

    User access terminated – All QuickSight users in your account will lose access immediately, including authors, readers, and administrators.

    \n
  • \n
  • \n

    \n No recovery possible – Once deleted, your QuickSight account and all associated data cannot be restored.

    \n
  • \n
\n

Consider exporting critical dashboards and data before proceeding with account deletion.

\n
\n

Use the DeleteAccountSubscription operation to delete an QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

", "smithy.api#http": { "method": "DELETE", "uri": "/account/{AwsAccountId}", @@ -16328,7 +16463,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during\n which you can restore the analysis. If you don't specify a recovery window value, the\n operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to\n the response that specifies the end of the recovery window. At the end of the recovery\n window, Amazon QuickSight deletes the analysis permanently.

\n

At any time before recovery window ends, you can use the RestoreAnalysis\n API operation to remove the DeletionTime stamp and cancel the deletion of\n the analysis. The analysis remains visible in the API until it's deleted, so you can\n describe it but you can't make a template from it.

\n

An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console.\n To access it in the console, restore it. Deleting an analysis doesn't delete the\n dashboards that you publish from it.

", + "smithy.api#documentation": "

Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during\n which you can restore the analysis. If you don't specify a recovery window value, the\n operation defaults to 30 days. QuickSight attaches a DeletionTime stamp to\n the response that specifies the end of the recovery window. At the end of the recovery\n window, QuickSight deletes the analysis permanently.

\n

At any time before recovery window ends, you can use the RestoreAnalysis\n API operation to remove the DeletionTime stamp and cancel the deletion of\n the analysis. The analysis remains visible in the API until it's deleted, so you can\n describe it but you can't make a template from it.

\n

An analysis that's scheduled for deletion isn't accessible in the QuickSight console.\n To access it in the console, restore it. Deleting an analysis doesn't delete the\n dashboards that you publish from it.

", "smithy.api#http": { "method": "DELETE", "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", @@ -16358,7 +16493,7 @@ "RecoveryWindowInDays": { "target": "com.amazonaws.quicksight#RecoveryWindowInDays", "traits": { - "smithy.api#documentation": "

A value that specifies the number of days that Amazon QuickSight waits before it deletes the\n analysis. You can't use this parameter with the ForceDeleteWithoutRecovery\n option in the same API call. The default value is 30.

", + "smithy.api#documentation": "

A value that specifies the number of days that QuickSight waits before it deletes the\n analysis. You can't use this parameter with the ForceDeleteWithoutRecovery\n option in the same API call. The default value is 30.

", "smithy.api#httpQuery": "recovery-window-in-days" } }, @@ -16444,7 +16579,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Amazon QuickSight brand.

", + "smithy.api#documentation": "\n

This API permanently deletes the specified QuickSight brand. When you delete a brand:

\n
    \n
  • \n

    The brand and all its associated branding elements are permanently removed

    \n
  • \n
  • \n

    Any applications or dashboards using this brand will revert to default styling

    \n
  • \n
  • \n

    This action cannot be undone through the API

    \n
  • \n
\n

\n Before proceeding: Verify that the brand is no longer needed and consider the impact on any applications currently using this brand.

\n
\n

Deletes an QuickSight brand.

", "smithy.api#http": { "method": "DELETE", "uri": "/accounts/{AwsAccountId}/brands/{BrandId}", @@ -16535,7 +16670,7 @@ "BrandId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

", + "smithy.api#documentation": "

The ID of the QuickSight brand.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17054,7 +17189,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a linked Amazon Q Business application from an Amazon QuickSight account

", + "smithy.api#documentation": "

Deletes a linked Amazon Q Business application from an QuickSight account

", "smithy.api#http": { "method": "DELETE", "uri": "/accounts/{AwsAccountId}/default-qbusiness-application", @@ -17068,7 +17203,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon QuickSight account that you want to disconnect from a Amazon Q Business application.

", + "smithy.api#documentation": "

The ID of the QuickSight account that you want to disconnect from a Amazon Q Business application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17076,7 +17211,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that you want to delete a linked Amazon Q Business application from. If this field is left blank, the Amazon Q Business application is deleted from the default namespace. Currently, the default namespace is the only valid value for this parameter.

", + "smithy.api#documentation": "

The QuickSight namespace that you want to delete a linked Amazon Q Business application from. If this field is left blank, the Amazon Q Business application is deleted from the default namespace. Currently, the default namespace is the only valid value for this parameter.

", "smithy.api#httpQuery": "namespace" } } @@ -17628,7 +17763,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.

\n

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

", + "smithy.api#documentation": "

Deletes all access scopes and authorized targets that are associated with a service from the QuickSight IAM Identity Center application.

\n

This operation is only supported for QuickSight accounts that use IAM Identity Center.

", "smithy.api#http": { "method": "DELETE", "uri": "/accounts/{AwsAccountId}/identity-propagation-config/{Service}", @@ -17728,7 +17863,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

", + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to delete the QuickSight namespace from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -19106,6 +19241,83 @@ } } }, + "com.amazonaws.quicksight#DescribeAccountCustomPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAccountCustomPermissionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAccountCustomPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the custom permissions profile that is applied to an account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/custom-permission", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAccountCustomPermissionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account for which you want to describe the applied custom permissions profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAccountCustomPermissionResponse": { + "type": "structure", + "members": { + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#CustomPermissionsName", + "traits": { + "smithy.api#documentation": "

The name of the custom permissions profile.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DescribeAccountCustomization": { "type": "operation", "input": { @@ -19135,7 +19347,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the customizations associated with the provided Amazon Web Services account and Amazon\n Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which\n customizations to apply by running this API operation with the Resolved flag\n included.

\n

To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved.

\n
    \n
  • \n

    \n Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy.\n It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you\n subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region.\n That's where your free SPICE capacity is located. You can use Amazon QuickSight in any\n supported Amazon Web Services Region.

    \n
  • \n
  • \n

    \n Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight\n at least once, Amazon QuickSight acts as a separate instance of the same service. If\n you have a user directory, it resides in us-east-1, which is the US East (N.\n Virginia). Generally speaking, these users have access to Amazon QuickSight in any\n Amazon Web Services Region, unless they are constrained to a namespace.

    \n

    To run the command in a different Amazon Web Services Region, you change your Region settings.\n If you're using the CLI, you can use one of the following options:

    \n \n
  • \n
  • \n

    \n Namespace - A QuickSight namespace is a partition that contains\n users and assets (data sources, datasets, dashboards, and so on). To access\n assets that are in a specific namespace, users and groups must also be part of\n the same namespace. People who share a namespace are completely isolated from\n users and assets in other namespaces, even if they are in the same Amazon Web Services account\n and Amazon Web Services Region.

    \n
  • \n
  • \n

    \n Applied customizations - Within an Amazon Web Services Region, a set of\n Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace.\n Settings that you apply to a namespace override settings that you apply to an\n Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in\n other Amazon Web Services Regions, run the CreateAccountCustomization command in\n each Amazon Web Services Region where you want to apply the same customizations.

    \n
  • \n
", + "smithy.api#documentation": "

Describes the customizations associated with the provided Amazon Web Services account and Amazon\n QuickSight namespace in an Amazon Web Services Region. The QuickSight console evaluates which\n customizations to apply by running this API operation with the Resolved flag\n included.

\n

To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved.

\n
    \n
  • \n

    \n Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy.\n It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you\n subscribe to QuickSight, you choose one Amazon Web Services Region to use as your home Region.\n That's where your free SPICE capacity is located. You can use QuickSight in any\n supported Amazon Web Services Region.

    \n
  • \n
  • \n

    \n Amazon Web Services Region - In each Amazon Web Services Region where you sign in to QuickSight\n at least once, QuickSight acts as a separate instance of the same service. If\n you have a user directory, it resides in us-east-1, which is the US East (N.\n Virginia). Generally speaking, these users have access to QuickSight in any\n Amazon Web Services Region, unless they are constrained to a namespace.

    \n

    To run the command in a different Amazon Web Services Region, you change your Region settings.\n If you're using the CLI, you can use one of the following options:

    \n \n
  • \n
  • \n

    \n Namespace - A QuickSight namespace is a partition that contains\n users and assets (data sources, datasets, dashboards, and so on). To access\n assets that are in a specific namespace, users and groups must also be part of\n the same namespace. People who share a namespace are completely isolated from\n users and assets in other namespaces, even if they are in the same Amazon Web Services account\n and Amazon Web Services Region.

    \n
  • \n
  • \n

    \n Applied customizations - Within an Amazon Web Services Region, a set of\n QuickSight customizations can apply to an Amazon Web Services account or to a namespace.\n Settings that you apply to a namespace override settings that you apply to an\n Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in\n other Amazon Web Services Regions, run the CreateAccountCustomization command in\n each Amazon Web Services Region where you want to apply the same customizations.

    \n
  • \n
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/customizations", @@ -19149,7 +19361,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations\n for.

", + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to describe QuickSight customizations\n for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -19157,7 +19369,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations\n for.

", + "smithy.api#documentation": "

The QuickSight namespace that you want to describe QuickSight customizations\n for.

", "smithy.api#httpQuery": "namespace" } }, @@ -19165,7 +19377,7 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

The Resolved flag works with the other parameters to determine which view\n of Amazon QuickSight customizations is returned. You can add this flag to your command to use\n the same view that Amazon QuickSight uses to identify which customizations to apply to the\n console. Omit this flag, or set it to no-resolved, to reveal customizations\n that are configured at different levels.

", + "smithy.api#documentation": "

The Resolved flag works with the other parameters to determine which view\n of QuickSight customizations is returned. You can add this flag to your command to use\n the same view that QuickSight uses to identify which customizations to apply to the\n console. Omit this flag, or set it to no-resolved, to reveal customizations\n that are configured at different levels.

", "smithy.api#httpQuery": "resolved" } } @@ -19192,13 +19404,13 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that you're describing.

" + "smithy.api#documentation": "

The QuickSight namespace that you're describing.

" } }, "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.

" + "smithy.api#documentation": "

The QuickSight customizations that exist in the current Amazon Web Services Region.

" } }, "RequestId": { @@ -19249,7 +19461,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the settings that were used when your Amazon QuickSight subscription was first\n created in this Amazon Web Services account.

", + "smithy.api#documentation": "

Describes the settings that were used when your QuickSight subscription was first\n created in this Amazon Web Services account.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/settings", @@ -19279,7 +19491,7 @@ "AccountSettings": { "target": "com.amazonaws.quicksight#AccountSettings", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight settings for this Amazon Web Services account. This information\n includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or\n Enterprise) and the notification email for the Amazon QuickSight subscription.

\n

In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to\n as a QuickSight \"account\" even though it's technically not an account by\n itself. Instead, it's a subscription to the Amazon QuickSight service for your\n Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.

" + "smithy.api#documentation": "

The QuickSight settings for this Amazon Web Services account. This information\n includes the edition of Amazon QuickSight that you subscribed to (Standard or\n Enterprise) and the notification email for the QuickSight subscription.

\n

In the QuickSight console, the QuickSight subscription is sometimes referred to\n as a QuickSight \"account\" even though it's technically not an account by\n itself. Instead, it's a subscription to the QuickSight service for your\n Amazon Web Services account. The edition that you subscribe to applies to QuickSight in every Amazon Web Services Region where you use it.

" } }, "RequestId": { @@ -19330,7 +19542,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

", + "smithy.api#documentation": "

Use the DescribeAccountSubscription operation to receive a description of an QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

", "smithy.api#http": { "method": "GET", "uri": "/account/{AwsAccountId}", @@ -19344,7 +19556,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID associated with your Amazon QuickSight account.

", + "smithy.api#documentation": "

The Amazon Web Services account ID associated with your QuickSight account.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -19360,7 +19572,7 @@ "AccountInfo": { "target": "com.amazonaws.quicksight#AccountInfo", "traits": { - "smithy.api#documentation": "

A structure that contains the following elements:

\n
    \n
  • \n

    Your Amazon QuickSight account name.

    \n
  • \n
  • \n

    The edition of Amazon QuickSight that your account is using.

    \n
  • \n
  • \n

    The notification email address that is associated with the Amazon QuickSight\n account.\n

    \n
  • \n
  • \n

    The authentication type of the Amazon QuickSight account.

    \n
  • \n
  • \n

    The status of the Amazon QuickSight account's subscription.

    \n
  • \n
" + "smithy.api#documentation": "

A structure that contains the following elements:

\n
    \n
  • \n

    Your QuickSight account name.

    \n
  • \n
  • \n

    The edition of QuickSight that your account is using.

    \n
  • \n
  • \n

    The notification email address that is associated with the QuickSight\n account.\n

    \n
  • \n
  • \n

    The authentication type of the QuickSight account.

    \n
  • \n
  • \n

    The status of the QuickSight account's subscription.

    \n
  • \n
" } }, "Status": { @@ -20066,7 +20278,8 @@ "method": "GET", "uri": "/accounts/{AwsAccountId}/brands/{BrandId}", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.quicksight#DescribeBrandAssignment": { @@ -20103,7 +20316,8 @@ "method": "GET", "uri": "/accounts/{AwsAccountId}/brandassignments", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.quicksight#DescribeBrandAssignmentRequest": { @@ -20176,7 +20390,8 @@ "method": "GET", "uri": "/accounts/{AwsAccountId}/brands/{BrandId}/publishedversion", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.quicksight#DescribeBrandPublishedVersionRequest": { @@ -20193,7 +20408,7 @@ "BrandId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

", + "smithy.api#documentation": "

The ID of the QuickSight brand.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -20243,7 +20458,7 @@ "BrandId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

", + "smithy.api#documentation": "

The ID of the QuickSight brand.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -20551,7 +20766,7 @@ "DashboardPublishOptions": { "target": "com.amazonaws.quicksight#DashboardPublishOptions", "traits": { - "smithy.api#documentation": "

Options for publishing the dashboard:

\n
    \n
  • \n

    \n AvailabilityStatus for AdHocFilteringOption - This\n status can be either ENABLED or DISABLED. When this is\n set to DISABLED, Amazon QuickSight disables the left filter pane on the\n published dashboard, which can be used for ad hoc (one-time) filtering. This\n option is ENABLED by default.

    \n
  • \n
  • \n

    \n AvailabilityStatus for ExportToCSVOption - This\n status can be either ENABLED or DISABLED. The visual\n option to export data to .CSV format isn't enabled when this is set to\n DISABLED. This option is ENABLED by default.

    \n
  • \n
  • \n

    \n VisibilityState for SheetControlsOption - This\n visibility state can be either COLLAPSED or EXPANDED.\n This option is COLLAPSED by default.

    \n
  • \n
" + "smithy.api#documentation": "

Options for publishing the dashboard:

\n
    \n
  • \n

    \n AvailabilityStatus for AdHocFilteringOption - This\n status can be either ENABLED or DISABLED. When this is\n set to DISABLED, QuickSight disables the left filter pane on the\n published dashboard, which can be used for ad hoc (one-time) filtering. This\n option is ENABLED by default.

    \n
  • \n
  • \n

    \n AvailabilityStatus for ExportToCSVOption - This\n status can be either ENABLED or DISABLED. The visual\n option to export data to .CSV format isn't enabled when this is set to\n DISABLED. This option is ENABLED by default.

    \n
  • \n
  • \n

    \n VisibilityState for SheetControlsOption - This\n visibility state can be either COLLAPSED or EXPANDED.\n This option is COLLAPSED by default.

    \n
  • \n
  • \n

    \n AvailabilityStatus for ExecutiveSummaryOption - This status\n can be either ENABLED or DISABLED. The option to build an executive\n summary is disabled when this is set to DISABLED. This option is ENABLED\n by default.

    \n
  • \n
  • \n

    \n AvailabilityStatus for DataStoriesSharingOption - This status\n can be either ENABLED or DISABLED. The option to share a data story is\n disabled when this is set to DISABLED. This option is ENABLED\n by default.

    \n
  • \n
" } } }, @@ -21567,7 +21782,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a Amazon Q Business application that is linked to an Amazon QuickSight account.

", + "smithy.api#documentation": "

Describes a Amazon Q Business application that is linked to an QuickSight account.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/default-qbusiness-application", @@ -21581,7 +21796,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon QuickSight account that is linked to the Amazon Q Business application that you want described.

", + "smithy.api#documentation": "

The ID of the QuickSight account that is linked to the Amazon Q Business application that you want described.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -21589,7 +21804,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.

", + "smithy.api#documentation": "

The QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.

", "smithy.api#httpQuery": "namespace" } } @@ -21618,7 +21833,7 @@ "ApplicationId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Q Business application that is linked to the Amazon QuickSight account.

" + "smithy.api#documentation": "

The ID of the Amazon Q Business application that is linked to the QuickSight account.

" } } }, @@ -22513,7 +22728,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes all customer managed key registrations in a Amazon QuickSight account.

", + "smithy.api#documentation": "

Describes all customer managed key registrations in a QuickSight account.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/key-registration", @@ -22557,7 +22772,13 @@ "KeyRegistration": { "target": "com.amazonaws.quicksight#KeyRegistration", "traits": { - "smithy.api#documentation": "

A list of RegisteredCustomerManagedKey objects in a Amazon QuickSight account.

" + "smithy.api#documentation": "

A list of RegisteredCustomerManagedKey objects in a QuickSight account.

" + } + }, + "QDataKey": { + "target": "com.amazonaws.quicksight#QDataKey", + "traits": { + "smithy.api#documentation": "

A list of QDataKey objects in a QuickSight account.

" } }, "RequestId": { @@ -22621,7 +22842,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

", + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the QuickSight namespace that you want to describe.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -22777,7 +22998,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the state of a Amazon QuickSight Q Search configuration.

", + "smithy.api#documentation": "

Describes the state of a QuickSight Q Search configuration.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/quicksight-q-search-configuration", @@ -22791,7 +23012,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the Amazon QuickSight Q Search configuration that the user wants described.

", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the QuickSight Q Search configuration that the user wants described.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -22807,7 +23028,7 @@ "QSearchStatus": { "target": "com.amazonaws.quicksight#QSearchStatus", "traits": { - "smithy.api#documentation": "

The status of Amazon QuickSight Q Search configuration.

" + "smithy.api#documentation": "

The status of QuickSight Q Search configuration.

" } }, "RequestId": { @@ -24650,7 +24871,7 @@ "LabelVisibility": { "target": "com.amazonaws.quicksight#Visibility", "traits": { - "smithy.api#documentation": "

Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called 'Show total'.

" + "smithy.api#documentation": "

Determines the visibility of the label in a donut chart. In the QuickSight console, this option is called 'Show total'.

" } } }, @@ -24852,7 +25073,7 @@ } }, "traits": { - "smithy.api#documentation": "

An empty visual.

\n

Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Amazon QuickSight console is considered an EmptyVisual until a visual type is selected.

" + "smithy.api#documentation": "

An empty visual.

\n

Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the QuickSight console is considered an EmptyVisual until a visual type is selected.

" } }, "com.amazonaws.quicksight#Entity": { @@ -25045,13 +25266,27 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

The executive summary settings of an embedded Amazon QuickSight console or dashboard.

", + "smithy.api#documentation": "

The executive summary settings of an embedded QuickSight console or dashboard.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The executive summary settings of an embedded Amazon QuickSight console or dashboard.

" + "smithy.api#documentation": "

The executive summary settings of an embedded QuickSight console or dashboard.

" + } + }, + "com.amazonaws.quicksight#ExecutiveSummaryOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

Availability status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data stories sharing option.

" } }, "com.amazonaws.quicksight#ExplicitHierarchy": { @@ -25180,13 +25415,13 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A boolean that indicates whether a FailedKeyRegistrationEntry resulted from user error. If the value of this property is True, the error was caused by user error. If the value of this property is False, the error occurred on the backend. If your job continues fail and with a False\n SenderFault value, contact Amazon Web ServicesSupport.

", + "smithy.api#documentation": "

A boolean that indicates whether a FailedKeyRegistrationEntry resulted from user error. If the value of this property is True, the error was caused by user error. If the value of this property is False, the error occurred on the backend. If your job continues fail and with a False\n SenderFault value, contact Amazon Web Services Support.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

An entry that appears when a KeyRegistration update to Amazon QuickSight fails.

" + "smithy.api#documentation": "

An entry that appears when a KeyRegistration update to QuickSight fails.

" } }, "com.amazonaws.quicksight#FieldBasedTooltip": { @@ -26575,7 +26810,7 @@ } }, "traits": { - "smithy.api#documentation": "

A folder in Amazon QuickSight.

" + "smithy.api#documentation": "

A folder in QuickSight.

" } }, "com.amazonaws.quicksight#FolderArnList": { @@ -26666,7 +26901,7 @@ } }, "traits": { - "smithy.api#documentation": "

An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.

" + "smithy.api#documentation": "

An asset in a QuickSight folder, such as a dashboard, analysis, or dataset.

" } }, "com.amazonaws.quicksight#FolderMemberList": { @@ -26713,7 +26948,7 @@ } }, "traits": { - "smithy.api#documentation": "

A filter to use to search an Amazon QuickSight folder.

" + "smithy.api#documentation": "

A filter to use to search an QuickSight folder.

" } }, "com.amazonaws.quicksight#FolderSearchFilterList": { @@ -26775,7 +27010,7 @@ } }, "traits": { - "smithy.api#documentation": "

A summary of information about an existing Amazon QuickSight folder.

" + "smithy.api#documentation": "

A summary of information about an existing QuickSight folder.

" } }, "com.amazonaws.quicksight#FolderSummaryList": { @@ -27947,7 +28182,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

", + "smithy.api#documentation": "

The QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

", "smithy.api#required": {} } }, @@ -27960,7 +28195,7 @@ "AuthorizedResourceArns": { "target": "com.amazonaws.quicksight#ArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user\n is authorized to access during the lifetime of the session.

\n

If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the\n account that you want the user to be able to view.

\n

If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

\n

Currently, you can pass up to 25 theme ARNs in each API call.

", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) for the QuickSight resources that the user\n is authorized to access during the lifetime of the session.

\n

If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the\n account that you want the user to be able to view.

\n

If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

\n

Currently, you can pass up to 25 theme ARNs in each API call.

", "smithy.api#required": {} } }, @@ -27974,7 +28209,7 @@ "AllowedDomains": { "target": "com.amazonaws.quicksight#StringList", "traits": { - "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that\n is then embedded. This optional parameter overrides the static domains that are\n configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it\n allows only the domains that you include in this parameter. You can list up to three\n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" + "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that\n is then embedded. This optional parameter overrides the static domains that are\n configured in the Manage QuickSight menu in the QuickSight console. Instead, it\n allows only the domains that you include in this parameter. You can list up to three\n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" } } }, @@ -28093,14 +28328,14 @@ "ExperienceConfiguration": { "target": "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration", "traits": { - "smithy.api#documentation": "

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

", + "smithy.api#documentation": "

The experience that you want to embed. For registered users, you can embed QuickSight dashboards, QuickSight visuals, the QuickSight Q search bar, the QuickSight Generative Q&A experience, or the entire QuickSight console.

", "smithy.api#required": {} } }, "AllowedDomains": { "target": "com.amazonaws.quicksight#StringList", "traits": { - "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that \n is then embedded. This optional parameter overrides the static domains that are \n configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it \n allows only the domains that you include in this parameter. You can list up to three \n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" + "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that \n is then embedded. This optional parameter overrides the static domains that are \n configured in the Manage QuickSight menu in the QuickSight console. Instead, it \n allows only the domains that you include in this parameter. You can list up to three \n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" } } }, @@ -28114,7 +28349,7 @@ "EmbedUrl": { "target": "com.amazonaws.quicksight#EmbeddingUrl", "traits": { - "smithy.api#documentation": "

The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.

", + "smithy.api#documentation": "

The embed URL for the QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.

", "smithy.api#required": {} } }, @@ -28177,7 +28412,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user that is registered in an Amazon QuickSight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.

\n

This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon QuickSight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

", + "smithy.api#documentation": "

Generates an embed URL that you can use to embed an QuickSight experience in your website. This action can be used for any type of user that is registered in an QuickSight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.

\n

This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for QuickSight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant QuickSight resource and permissions.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/embed-url/registered-user-with-identity", @@ -28336,13 +28571,13 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

The generative BI authoring settings of an embedded Amazon QuickSight console.

", + "smithy.api#documentation": "

The generative BI authoring settings of an embedded QuickSight console.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The generative BI authoring settings of an embedded Amazon QuickSight console.

" + "smithy.api#documentation": "

The generative BI authoring settings of an embedded QuickSight console.

" } }, "com.amazonaws.quicksight#GeoSpatialColumnGroup": { @@ -29542,7 +29777,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.

\n

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL:

\n
    \n
  • \n

    They must be used together.

    \n
  • \n
  • \n

    They can be used one time only.

    \n
  • \n
  • \n

    They are valid for 5 minutes after you run this command.

    \n
  • \n
  • \n

    You are charged only when the URL is used or there is interaction with Amazon QuickSight.

    \n
  • \n
  • \n

    The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration.

    \n
  • \n
\n

For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", + "smithy.api#documentation": "

Generates a temporary session URL and authorization code(bearer token) that you can use to embed an QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.

\n

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL:

\n
    \n
  • \n

    They must be used together.

    \n
  • \n
  • \n

    They can be used one time only.

    \n
  • \n
  • \n

    They are valid for 5 minutes after you run this command.

    \n
  • \n
  • \n

    You are charged only when the URL is used or there is interaction with QuickSight.

    \n
  • \n
  • \n

    The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration.

    \n
  • \n
\n

For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url", @@ -29604,7 +29839,7 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Adds persistence of state for the user session in an embedded dashboard. Persistence\n applies to the sheet and the parameter settings. These are control settings that the\n dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is\n set to TRUE, the settings are the same when the subscriber reopens the same\n dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is\n set to FALSE, the state of the user session is not persisted. The default is\n FALSE.

", + "smithy.api#documentation": "

Adds persistence of state for the user session in an embedded dashboard. Persistence\n applies to the sheet and the parameter settings. These are control settings that the\n dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is\n set to TRUE, the settings are the same when the subscriber reopens the same\n dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is\n set to FALSE, the state of the user session is not persisted. The default is\n FALSE.

", "smithy.api#httpQuery": "state-persistence-enabled" } }, @@ -29618,14 +29853,14 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that contains the dashboard IDs in this request.\n \t If you're not using a custom namespace, set Namespace = default.

", + "smithy.api#documentation": "

The QuickSight namespace that contains the dashboard IDs in this request.\n \t If you're not using a custom namespace, set Namespace = default.

", "smithy.api#httpQuery": "namespace" } }, "AdditionalDashboardIds": { "target": "com.amazonaws.quicksight#AdditionalDashboardIdList", "traits": { - "smithy.api#documentation": "

A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set \"--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS\", the session can access all three dashboards.

", + "smithy.api#documentation": "

A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as QuickSight or IAM users. For example, if you set \"--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS\", the session can access all three dashboards.

", "smithy.api#httpQuery": "additional-dashboard-ids" } } @@ -29701,7 +29936,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a session URL and authorization code that you can use to embed the Amazon\n Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console\n need belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use \n RegisterUser\n \n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

\n ", + "smithy.api#documentation": "

Generates a session URL and authorization code that you can use to embed the Amazon\n QuickSight console in your web server code. Use GetSessionEmbedUrl where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who access an embedded QuickSight console\n need belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use \n RegisterUser\n \n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

\n ", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/session-embed-url", @@ -29715,7 +29950,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

", + "smithy.api#documentation": "

The ID for the Amazon Web Services account associated with your QuickSight subscription.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -29723,7 +29958,7 @@ "EntryPoint": { "target": "com.amazonaws.quicksight#EntryPoint", "traits": { - "smithy.api#documentation": "

The URL you use to access the embedded session. The entry point URL is constrained to\n the following paths:

\n
    \n
  • \n

    \n /start\n

    \n
  • \n
  • \n

    \n /start/analyses\n

    \n
  • \n
  • \n

    \n /start/dashboards\n

    \n
  • \n
  • \n

    \n /start/favorites\n

    \n
  • \n
  • \n

    \n /dashboards/DashboardId\n - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

    \n
  • \n
  • \n

    \n /analyses/AnalysisId\n - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

    \n
  • \n
", + "smithy.api#documentation": "

The URL you use to access the embedded session. The entry point URL is constrained to\n the following paths:

\n
    \n
  • \n

    \n /start\n

    \n
  • \n
  • \n

    \n /start/analyses\n

    \n
  • \n
  • \n

    \n /start/dashboards\n

    \n
  • \n
  • \n

    \n /start/favorites\n

    \n
  • \n
  • \n

    \n /dashboards/DashboardId\n - where DashboardId is the actual ID key from the QuickSight console URL of the dashboard

    \n
  • \n
  • \n

    \n /analyses/AnalysisId\n - where AnalysisId is the actual ID key from the QuickSight console URL of the analysis

    \n
  • \n
", "smithy.api#httpQuery": "entry-point" } }, @@ -29752,7 +29987,7 @@ "EmbedUrl": { "target": "com.amazonaws.quicksight#EmbeddingUrl", "traits": { - "smithy.api#documentation": "

A single-use URL that you can put into your server-side web page to embed your\n\t\t\tAmazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an\n\t\t\tauth_code value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.

" + "smithy.api#documentation": "

A single-use URL that you can put into your server-side web page to embed your\n\t\t\tQuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an\n\t\t\tauth_code value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.

" } }, "Status": { @@ -29983,7 +30218,7 @@ "ResizeOption": { "target": "com.amazonaws.quicksight#ResizeOption", "traits": { - "smithy.api#documentation": "

This value determines the layout behavior when the viewport is resized.

\n
    \n
  • \n

    \n FIXED: A fixed width will be used when optimizing the layout. In\n the Amazon QuickSight console, this option is called Classic.

    \n
  • \n
  • \n

    \n RESPONSIVE: The width of the canvas will be responsive and\n optimized to the view port. In the Amazon QuickSight console, this option is called Tiled.

    \n
  • \n
", + "smithy.api#documentation": "

This value determines the layout behavior when the viewport is resized.

\n
    \n
  • \n

    \n FIXED: A fixed width will be used when optimizing the layout. In\n the QuickSight console, this option is called Classic.

    \n
  • \n
  • \n

    \n RESPONSIVE: The width of the canvas will be responsive and\n optimized to the view port. In the QuickSight console, this option is called Tiled.

    \n
  • \n
", "smithy.api#required": {} } }, @@ -30303,12 +30538,24 @@ "smithy.api#documentation": "

The sort configuration of a heat map.

" } }, + "RowAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the row axis label.

" + } + }, "RowLabelOptions": { "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", "traits": { "smithy.api#documentation": "

The label options of the row that is displayed in a heat map.

" } }, + "ColumnAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the row axis label.

" + } + }, "ColumnLabelOptions": { "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", "traits": { @@ -32549,7 +32796,7 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

A value that indicates that a row in a table is uniquely identified by the columns in\n a join key. This is used by Amazon QuickSight to optimize query performance.

" + "smithy.api#documentation": "

A value that indicates that a row in a table is uniquely identified by the columns in\n a join key. This is used by QuickSight to optimize query performance.

" } } }, @@ -34264,7 +34511,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all brands in an Amazon QuickSight account.

", + "smithy.api#documentation": "

Lists all brands in an QuickSight account.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/brands", @@ -34275,7 +34522,8 @@ "outputToken": "NextToken", "items": "Brands", "pageSize": "MaxResults" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.quicksight#ListBrandsRequest": { @@ -34527,7 +34775,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

", + "smithy.api#documentation": "

Lists all the versions of the dashboards in the QuickSight subscription.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions", @@ -35792,7 +36040,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.

\n

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

", + "smithy.api#documentation": "

Lists all services and authorized targets that the QuickSight IAM Identity Center application can access.

\n

This operation is only supported for QuickSight accounts that use IAM Identity Center.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/identity-propagation-config", @@ -35837,7 +36085,7 @@ "Services": { "target": "com.amazonaws.quicksight#AuthorizedTargetsByServices", "traits": { - "smithy.api#documentation": "

A list of services and their authorized targets that the Amazon QuickSight IAM Identity Center application can access.

" + "smithy.api#documentation": "

A list of services and their authorized targets that the QuickSight IAM Identity Center application can access.

" } }, "NextToken": { @@ -36048,7 +36296,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

", + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the QuickSight namespaces that you want to list.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -37043,7 +37291,7 @@ "Type": { "target": "com.amazonaws.quicksight#ThemeType", "traits": { - "smithy.api#documentation": "

The type of themes that you want to list. Valid options include the following:

\n
    \n
  • \n

    \n ALL (default)- Display all existing themes.

    \n
  • \n
  • \n

    \n CUSTOM - Display only the themes created by people using Amazon QuickSight.

    \n
  • \n
  • \n

    \n QUICKSIGHT - Display only the starting themes defined by Amazon QuickSight.

    \n
  • \n
", + "smithy.api#documentation": "

The type of themes that you want to list. Valid options include the following:

\n
    \n
  • \n

    \n ALL (default)- Display all existing themes.

    \n
  • \n
  • \n

    \n CUSTOM - Display only the themes created by people using Amazon QuickSight.

    \n
  • \n
  • \n

    \n QUICKSIGHT - Display only the starting themes defined by QuickSight.

    \n
  • \n
", "smithy.api#httpQuery": "type" } } @@ -38773,6 +39021,12 @@ "traits": { "smithy.api#enumValue": "RELATIVE_DATE_FILTER" } + }, + "NULL_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NULL_FILTER" + } } } }, @@ -39230,6 +39484,29 @@ } } }, + "com.amazonaws.quicksight#NullFilterType": { + "type": "enum", + "members": { + "ALL_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_VALUES" + } + }, + "NON_NULLS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NON_NULLS_ONLY" + } + }, + "NULLS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NULLS_ONLY" + } + } + } + }, "com.amazonaws.quicksight#NullString": { "type": "string", "traits": { @@ -40678,7 +40955,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of Amazon QuickSight parameters and the list's override values.

" + "smithy.api#documentation": "

A list of QuickSight parameters and the list's override values.

" } }, "com.amazonaws.quicksight#Password": { @@ -42069,6 +42346,12 @@ "smithy.api#documentation": "

\n A description of the plugin field wells and their persisted properties.\n

" } }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, "VisualContentAltText": { "target": "com.amazonaws.quicksight#LongPlainText", "traits": { @@ -42077,7 +42360,7 @@ } }, "traits": { - "smithy.api#documentation": "

A flexible visualization type that allows engineers \n to create new custom charts in Amazon QuickSight.

" + "smithy.api#documentation": "

A flexible visualization type that allows engineers \n to create new custom charts in QuickSight.

" } }, "com.amazonaws.quicksight#PluginVisualAxisName": { @@ -42392,7 +42675,7 @@ } ], "traits": { - "smithy.api#documentation": "

Predicts existing visuals or generates new visuals to answer a given query.

\n

This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon QuickSight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

\n

We recommend enabling the QSearchStatus API to unlock the full potential of PredictQnA. When QSearchStatus is enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found, PredictQnA uses generative Q&A to provide an answer. To update the QSearchStatus, see UpdateQuickSightQSearchConfiguration.

", + "smithy.api#documentation": "

Predicts existing visuals or generates new visuals to answer a given query.

\n

This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for QuickSight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant QuickSight resource and permissions.

\n

We recommend enabling the QSearchStatus API to unlock the full potential of PredictQnA. When QSearchStatus is enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found, PredictQnA uses generative Q&A to provide an answer. To update the QSearchStatus, see UpdateQuickSightQSearchConfiguration.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/qa/predict", @@ -42855,6 +43138,43 @@ } } }, + "com.amazonaws.quicksight#QDataKey": { + "type": "structure", + "members": { + "QDataKeyArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that is registered to a QuickSight account for encryption and decryption use as a QDataKey.

" + } + }, + "QDataKeyType": { + "target": "com.amazonaws.quicksight#QDataKeyType", + "traits": { + "smithy.api#documentation": "

The type of QDataKey.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information about the QDataKey.

" + } + }, + "com.amazonaws.quicksight#QDataKeyType": { + "type": "enum", + "members": { + "AWS_OWNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_OWNED" + } + }, + "CMK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CMK" + } + } + } + }, "com.amazonaws.quicksight#QSearchStatus": { "type": "enum", "members": { @@ -43051,6 +43371,9 @@ { "target": "com.amazonaws.quicksight#DeleteAccountCustomization" }, + { + "target": "com.amazonaws.quicksight#DeleteAccountCustomPermission" + }, { "target": "com.amazonaws.quicksight#DeleteAccountSubscription" }, @@ -43144,6 +43467,9 @@ { "target": "com.amazonaws.quicksight#DescribeAccountCustomization" }, + { + "target": "com.amazonaws.quicksight#DescribeAccountCustomPermission" + }, { "target": "com.amazonaws.quicksight#DescribeAccountSettings" }, @@ -43465,6 +43791,9 @@ { "target": "com.amazonaws.quicksight#UpdateAccountCustomization" }, + { + "target": "com.amazonaws.quicksight#UpdateAccountCustomPermission" + }, { "target": "com.amazonaws.quicksight#UpdateAccountSettings" }, @@ -44276,17 +44605,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -44300,17 +44618,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -44324,17 +44631,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -44348,17 +44644,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -44837,13 +45122,13 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

The recent snapshots configuration for an embedded Amazon QuickSight dashboard.

", + "smithy.api#documentation": "

The recent snapshots configuration for an embedded QuickSight dashboard.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The recent snapshots configuration for an embedded Amazon QuickSight dashboard.

" + "smithy.api#documentation": "

The recent snapshots configuration for an embedded QuickSight dashboard.

" } }, "com.amazonaws.quicksight#RecoveryWindowInDays": { @@ -44861,20 +45146,20 @@ "RoleArn": { "target": "com.amazonaws.quicksight#RoleArn", "traits": { - "smithy.api#documentation": "

Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.

", + "smithy.api#documentation": "

Use the RoleArn structure to allow QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to QuickSight. The role's trust policy must allow the QuickSight service principal to assume the role.

", "smithy.api#required": {} } }, "DatabaseUser": { "target": "com.amazonaws.quicksight#DatabaseUser", "traits": { - "smithy.api#documentation": "

The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

" + "smithy.api#documentation": "

The user whose permissions and group memberships will be used by QuickSight to access the cluster. If this user already exists in your database, QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

" } }, "DatabaseGroups": { "target": "com.amazonaws.quicksight#DatabaseGroupList", "traits": { - "smithy.api#documentation": "

A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

" + "smithy.api#documentation": "

A list of groups whose permissions will be granted to QuickSight to access the cluster. These permissions are combined with the permissions granted to QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

" } }, "AutoCreateDatabaseUser": { @@ -44886,7 +45171,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see \n GetClusterCredentials\n .

" + "smithy.api#documentation": "

A structure that grants QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see \n GetClusterCredentials\n .

" } }, "com.amazonaws.quicksight#RedshiftParameters": { @@ -44921,13 +45206,13 @@ "IAMParameters": { "target": "com.amazonaws.quicksight#RedshiftIAMParameters", "traits": { - "smithy.api#documentation": "

An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.

" + "smithy.api#documentation": "

An optional parameter that uses IAM authentication to grant QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.

" } }, "IdentityCenterConfiguration": { "target": "com.amazonaws.quicksight#IdentityCenterConfiguration", "traits": { - "smithy.api#documentation": "

An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.

\n

This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.

" + "smithy.api#documentation": "

An optional parameter that configures IAM Identity Center authentication to grant QuickSight access to your cluster.

\n

This parameter can only be specified if your QuickSight account is configured with IAM Identity Center.

" } } }, @@ -45474,7 +45759,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.

", + "smithy.api#documentation": "

Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the QuickSight API, QuickSight generates a registration URL. The user accesses this registration URL to create their account. QuickSight doesn't send a registration email to users who are registered from the QuickSight API. If you want new users to receive a registration email, then add those users in the QuickSight console. For more information on registering a new user in the QuickSight console, see Inviting users to access QuickSight.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users", @@ -45488,7 +45773,7 @@ "IdentityType": { "target": "com.amazonaws.quicksight#IdentityType", "traits": { - "smithy.api#documentation": "

The identity type that your Amazon QuickSight account uses to manage the identity of users.

", + "smithy.api#documentation": "

The identity type that your QuickSight account uses to manage the identity of users.

", "smithy.api#required": {} } }, @@ -45502,7 +45787,7 @@ "UserRole": { "target": "com.amazonaws.quicksight#UserRole", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight role for the user. The user role can be one of the\n\t\t\tfollowing:

\n
    \n
  • \n

    \n READER: A user who has read-only access to dashboards.

    \n
  • \n
  • \n

    \n AUTHOR: A user who can create data sources, datasets, analyses, and\n\t\t\t\t\tdashboards.

    \n
  • \n
  • \n

    \n ADMIN: A user who is an author, who can also manage Amazon QuickSight\n\t\t\t\t\tsettings.

    \n
  • \n
  • \n

    \n READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    \n
  • \n
  • \n

    \n AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    \n
  • \n
  • \n

    \n ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

    \n
  • \n
  • \n

    \n RESTRICTED_READER: This role isn't currently available for\n\t\t\t\t\tuse.

    \n
  • \n
  • \n

    \n RESTRICTED_AUTHOR: This role isn't currently available for\n\t\t\t\t\tuse.

    \n
  • \n
", + "smithy.api#documentation": "

The Amazon QuickSight role for the user. The user role can be one of the\n\t\t\tfollowing:

\n
    \n
  • \n

    \n READER: A user who has read-only access to dashboards.

    \n
  • \n
  • \n

    \n AUTHOR: A user who can create data sources, datasets, analyses, and\n\t\t\t\t\tdashboards.

    \n
  • \n
  • \n

    \n ADMIN: A user who is an author, who can also manage Amazon QuickSight\n\t\t\t\t\tsettings.

    \n
  • \n
  • \n

    \n READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    \n
  • \n
  • \n

    \n AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    \n
  • \n
  • \n

    \n ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

    \n
  • \n
  • \n

    \n RESTRICTED_READER: This role isn't currently available for\n\t\t\t\t\tuse.

    \n
  • \n
  • \n

    \n RESTRICTED_AUTHOR: This role isn't currently available for\n\t\t\t\t\tuse.

    \n
  • \n
", "smithy.api#required": {} } }, @@ -45543,7 +45828,7 @@ "CustomPermissionsName": { "target": "com.amazonaws.quicksight#RoleName", "traits": { - "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n
    \n
  • \n

    Create and update data sources

    \n
  • \n
  • \n

    Create and update datasets

    \n
  • \n
  • \n

    Create and update email reports

    \n
  • \n
  • \n

    Subscribe to email reports

    \n
  • \n
\n

To add custom permissions to an existing user, use \n UpdateUser\n instead.

\n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader, admin pro, author pro, reader pro).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" + "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n
    \n
  • \n

    Create and update data sources

    \n
  • \n
  • \n

    Create and update datasets

    \n
  • \n
  • \n

    Create and update email reports

    \n
  • \n
  • \n

    Subscribe to email reports

    \n
  • \n
\n

To add custom permissions to an existing user, use \n UpdateUser\n instead.

\n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a QuickSight user.

\n

QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning QuickSight users to one of the\n default security cohorts in QuickSight (admin, author, reader, admin pro, author pro, reader pro).

\n

This feature is available only to QuickSight Enterprise edition subscriptions.

" } }, "ExternalLoginFederationProviderType": { @@ -45555,7 +45840,7 @@ "CustomFederationProviderUrl": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate\n into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should\n only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

" + "smithy.api#documentation": "

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate\n into QuickSight with an associated Identity and Access Management(IAM) role. This parameter should\n only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

" } }, "ExternalLoginId": { @@ -45615,7 +45900,7 @@ "KeyArn": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

" + "smithy.api#documentation": "

The ARN of the KMS key that is registered to a QuickSight account for encryption and decryption use.

" } }, "DefaultKey": { @@ -45627,7 +45912,7 @@ } }, "traits": { - "smithy.api#documentation": "

A customer managed key structure that contains the information listed below:

\n
    \n
  • \n

    \n KeyArn - The ARN of a KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

    \n
  • \n
  • \n

    \n DefaultKey - Indicates whether the current key is set as the default key for encryption and decryption use.

    \n
  • \n
" + "smithy.api#documentation": "

A customer managed key structure that contains the information listed below:

\n
    \n
  • \n

    \n KeyArn - The ARN of a KMS key that is registered to a QuickSight account for encryption and decryption use.

    \n
  • \n
  • \n

    \n DefaultKey - Indicates whether the current key is set as the default key for encryption and decryption use.

    \n
  • \n
" } }, "com.amazonaws.quicksight#RegisteredUserConsoleFeatureConfigurations": { @@ -45636,7 +45921,7 @@ "StatePersistence": { "target": "com.amazonaws.quicksight#StatePersistenceConfigurations", "traits": { - "smithy.api#documentation": "

The state persistence configurations of an embedded Amazon QuickSight console.

" + "smithy.api#documentation": "

The state persistence configurations of an embedded QuickSight console.

" } }, "SharedView": { @@ -45648,30 +45933,30 @@ "AmazonQInQuickSight": { "target": "com.amazonaws.quicksight#AmazonQInQuickSightConsoleConfigurations", "traits": { - "smithy.api#documentation": "

The Amazon Q configurations of an embedded Amazon QuickSight console.

" + "smithy.api#documentation": "

The Amazon Q configurations of an embedded QuickSight console.

" } }, "Schedules": { "target": "com.amazonaws.quicksight#SchedulesConfigurations", "traits": { - "smithy.api#documentation": "

The schedules configuration for an embedded Amazon QuickSight dashboard.

" + "smithy.api#documentation": "

The schedules configuration for an embedded QuickSight dashboard.

" } }, "RecentSnapshots": { "target": "com.amazonaws.quicksight#RecentSnapshotsConfigurations", "traits": { - "smithy.api#documentation": "

The recent snapshots configuration for an embedded Amazon QuickSight dashboard.

" + "smithy.api#documentation": "

The recent snapshots configuration for an embedded QuickSight dashboard.

" } }, "ThresholdAlerts": { "target": "com.amazonaws.quicksight#ThresholdAlertsConfigurations", "traits": { - "smithy.api#documentation": "

The threshold alerts configuration for an embedded Amazon QuickSight dashboard.

" + "smithy.api#documentation": "

The threshold alerts configuration for an embedded QuickSight dashboard.

" } } }, "traits": { - "smithy.api#documentation": "

The feature configurations of an embedded Amazon QuickSight console.

" + "smithy.api#documentation": "

The feature configurations of an embedded QuickSight console.

" } }, "com.amazonaws.quicksight#RegisteredUserDashboardEmbeddingConfiguration": { @@ -45680,14 +45965,14 @@ "InitialDashboardId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

\n

If the user does not have permission to view this dashboard, they see a permissions error message.

", + "smithy.api#documentation": "

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders this dashboard if the user has permissions to view it.

\n

If the user does not have permission to view this dashboard, they see a permissions error message.

", "smithy.api#required": {} } }, "FeatureConfigurations": { "target": "com.amazonaws.quicksight#RegisteredUserDashboardFeatureConfigurations", "traits": { - "smithy.api#documentation": "

The feature configurations of an embbedded Amazon QuickSight dashboard.

" + "smithy.api#documentation": "

The feature configurations of an embbedded QuickSight dashboard.

" } } }, @@ -45713,31 +45998,31 @@ "Bookmarks": { "target": "com.amazonaws.quicksight#BookmarksConfigurations", "traits": { - "smithy.api#documentation": "

The bookmarks configuration for an embedded dashboard in Amazon QuickSight.

" + "smithy.api#documentation": "

The bookmarks configuration for an embedded dashboard in QuickSight.

" } }, "AmazonQInQuickSight": { "target": "com.amazonaws.quicksight#AmazonQInQuickSightDashboardConfigurations", "traits": { - "smithy.api#documentation": "

The Amazon Q configurations of an embedded Amazon QuickSight dashboard.

" + "smithy.api#documentation": "

The Amazon Q configurations of an embedded QuickSight dashboard.

" } }, "Schedules": { "target": "com.amazonaws.quicksight#SchedulesConfigurations", "traits": { - "smithy.api#documentation": "

The schedules configuration for an embedded Amazon QuickSight dashboard.

" + "smithy.api#documentation": "

The schedules configuration for an embedded QuickSight dashboard.

" } }, "RecentSnapshots": { "target": "com.amazonaws.quicksight#RecentSnapshotsConfigurations", "traits": { - "smithy.api#documentation": "

The recent snapshots configuration for an Amazon QuickSight embedded dashboard

" + "smithy.api#documentation": "

The recent snapshots configuration for an QuickSight embedded dashboard

" } }, "ThresholdAlerts": { "target": "com.amazonaws.quicksight#ThresholdAlertsConfigurations", "traits": { - "smithy.api#documentation": "

The threshold alerts configuration for an Amazon QuickSight embedded dashboard.

" + "smithy.api#documentation": "

The threshold alerts configuration for an QuickSight embedded dashboard.

" } } }, @@ -45751,7 +46036,7 @@ "InitialDashboardVisualId": { "target": "com.amazonaws.quicksight#DashboardVisualId", "traits": { - "smithy.api#documentation": "

The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

\n

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", + "smithy.api#documentation": "

The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders this visual.

\n

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", "smithy.api#required": {} } } @@ -45772,30 +46057,30 @@ "QuickSightConsole": { "target": "com.amazonaws.quicksight#RegisteredUserQuickSightConsoleEmbeddingConfiguration", "traits": { - "smithy.api#documentation": "

The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User\n Guide.

\n

Use \n GenerateEmbedUrlForRegisteredUser\n \n where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console\n needs to belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use the \n RegisterUser\n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

\n \n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

" + "smithy.api#documentation": "

The configuration details for providing each QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the QuickSight Console in the Amazon QuickSight User\n Guide.

\n

Use \n GenerateEmbedUrlForRegisteredUser\n \n where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who accesses an embedded QuickSight console\n needs to belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use the \n RegisterUser\n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

\n \n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

" } }, "QSearchBar": { "target": "com.amazonaws.quicksight#RegisteredUserQSearchBarEmbeddingConfiguration", "traits": { - "smithy.api#documentation": "

The configuration details for embedding the Q search bar.

\n

For more information about embedding the Q search bar, see Embedding Overview in\n the Amazon QuickSight User Guide.

" + "smithy.api#documentation": "

The configuration details for embedding the Q search bar.

\n

For more information about embedding the Q search bar, see Embedding Overview in\n the QuickSight User Guide.

" } }, "DashboardVisual": { "target": "com.amazonaws.quicksight#RegisteredUserDashboardVisualEmbeddingConfiguration", "traits": { - "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight visuals.

" + "smithy.api#documentation": "

The type of embedding experience. In this case, QuickSight visuals.

" } }, "GenerativeQnA": { "target": "com.amazonaws.quicksight#RegisteredUserGenerativeQnAEmbeddingConfiguration", "traits": { - "smithy.api#documentation": "

The configuration details for embedding the Generative Q&A experience.

\n

For more information about embedding the Generative Q&A experience, see Embedding Overview in\n the Amazon QuickSight User Guide.

" + "smithy.api#documentation": "

The configuration details for embedding the Generative Q&A experience.

\n

For more information about embedding the Generative Q&A experience, see Embedding Overview in\n the QuickSight User Guide.

" } } }, "traits": { - "smithy.api#documentation": "

The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.

\n \n

Exactly one of the experience configurations is required. You can choose\n Dashboard or QuickSightConsole. You cannot choose more\n than one experience configuration.

\n
" + "smithy.api#documentation": "

The type of experience you want to embed. For registered users, you can embed QuickSight dashboards or the QuickSight console.

\n \n

Exactly one of the experience configurations is required. You can choose\n Dashboard or QuickSightConsole. You cannot choose more\n than one experience configuration.

\n
" } }, "com.amazonaws.quicksight#RegisteredUserGenerativeQnAEmbeddingConfiguration": { @@ -45804,7 +46089,7 @@ "InitialTopicId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience.\n You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening\n a topic. The ID is in the URL for the topic that you open.

\n

If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.

" + "smithy.api#documentation": "

The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience.\n You can find a topic ID by navigating to the Topics pane in the QuickSight application and opening\n a topic. The ID is in the URL for the topic that you open.

\n

If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.

" } } }, @@ -45818,7 +46103,7 @@ "InitialTopicId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers\n are allowed to select other topics from the list of available topics.

\n

If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.

" + "smithy.api#documentation": "

The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers\n are allowed to select other topics from the list of available topics.

\n

If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.

" } } }, @@ -45832,18 +46117,18 @@ "InitialPath": { "target": "com.amazonaws.quicksight#EntryPath", "traits": { - "smithy.api#documentation": "

The initial URL path for the Amazon QuickSight console. InitialPath is required.

\n

The entry point URL is constrained to the following paths:

\n
    \n
  • \n

    \n /start\n

    \n
  • \n
  • \n

    \n /start/analyses\n

    \n
  • \n
  • \n

    \n /start/dashboards\n

    \n
  • \n
  • \n

    \n /start/favorites\n

    \n
  • \n
  • \n

    \n /dashboards/DashboardId. DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard.

    \n
  • \n
  • \n

    \n /analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.

    \n
  • \n
" + "smithy.api#documentation": "

The initial URL path for the QuickSight console. InitialPath is required.

\n

The entry point URL is constrained to the following paths:

\n
    \n
  • \n

    \n /start\n

    \n
  • \n
  • \n

    \n /start/analyses\n

    \n
  • \n
  • \n

    \n /start/dashboards\n

    \n
  • \n
  • \n

    \n /start/favorites\n

    \n
  • \n
  • \n

    \n /dashboards/DashboardId. DashboardId is the actual ID key from the QuickSight console URL of the dashboard.

    \n
  • \n
  • \n

    \n /analyses/AnalysisId. AnalysisId is the actual ID key from the QuickSight console URL of the analysis.

    \n
  • \n
" } }, "FeatureConfigurations": { "target": "com.amazonaws.quicksight#RegisteredUserConsoleFeatureConfigurations", "traits": { - "smithy.api#documentation": "

The embedding configuration of an embedded Amazon QuickSight console.

" + "smithy.api#documentation": "

The embedding configuration of an embedded QuickSight console.

" } } }, "traits": { - "smithy.api#documentation": "

Information about the Amazon QuickSight console that you want to embed.

" + "smithy.api#documentation": "

Information about the QuickSight console that you want to embed.

" } }, "com.amazonaws.quicksight#RelationalTable": { @@ -46855,7 +47140,7 @@ } }, "traits": { - "smithy.api#documentation": "

An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.

" + "smithy.api#documentation": "

An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default QuickSight bucket.

" } }, "com.amazonaws.quicksight#S3Key": { @@ -46873,7 +47158,7 @@ "ManifestFileLocation": { "target": "com.amazonaws.quicksight#ManifestFileLocation", "traits": { - "smithy.api#documentation": "

Location of the Amazon S3 manifest file. This is NULL if the manifest file was\n uploaded into Amazon QuickSight.

", + "smithy.api#documentation": "

Location of the Amazon S3 manifest file. This is NULL if the manifest file was\n uploaded into QuickSight.

", "smithy.api#required": {} } }, @@ -47344,13 +47629,13 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

The schedules configuration for an embedded Amazon QuickSight dashboard.

", + "smithy.api#documentation": "

The schedules configuration for an embedded QuickSight dashboard.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The schedules configuration for an embedded Amazon QuickSight dashboard.

" + "smithy.api#documentation": "

The schedules configuration for an embedded QuickSight dashboard.

" } }, "com.amazonaws.quicksight#ScrollBarOptions": { @@ -47974,7 +48259,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

", + "smithy.api#documentation": "

Use the SearchGroups operation to search groups in a specified QuickSight namespace using the supplied filters.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups-search", @@ -48096,7 +48381,7 @@ } ], "traits": { - "smithy.api#documentation": "

Searches for any Q topic that exists in an Amazon QuickSight account.

", + "smithy.api#documentation": "

Searches for any Q topic that exists in an QuickSight account.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/search/topics", @@ -48862,7 +49147,7 @@ "Name": { "target": "com.amazonaws.quicksight#SheetName", "traits": { - "smithy.api#documentation": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" + "smithy.api#documentation": "

The name of a sheet. This name is displayed on the sheet's tab in the QuickSight\n console.

" } }, "Images": { @@ -49062,7 +49347,7 @@ "Name": { "target": "com.amazonaws.quicksight#SheetName", "traits": { - "smithy.api#documentation": "

The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" + "smithy.api#documentation": "

The name of the sheet. This name is displayed on the sheet's tab in the QuickSight\n console.

" } }, "ParameterControls": { @@ -49570,25 +49855,25 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean that is TRUE if the Amazon QuickSight uses IAM as an\n authentication method.

" + "smithy.api#documentation": "

A Boolean that is TRUE if the QuickSight uses IAM as an\n authentication method.

" } }, "userLoginName": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The user login name for your Amazon QuickSight account.

" + "smithy.api#documentation": "

The user login name for your QuickSight account.

" } }, "accountName": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The name of your Amazon QuickSight account.

" + "smithy.api#documentation": "

The name of your QuickSight account.

" } }, "directoryType": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The type of Active Directory that is being used to authenticate the Amazon QuickSight\n account. Valid values are SIMPLE_AD, AD_CONNECTOR, and\n MICROSOFT_AD.

" + "smithy.api#documentation": "

The type of Active Directory that is being used to authenticate the QuickSight\n account. Valid values are SIMPLE_AD, AD_CONNECTOR, and\n MICROSOFT_AD.

" } } }, @@ -49923,7 +50208,7 @@ "RowLevelPermissionTags": { "target": "com.amazonaws.quicksight#SessionTagList", "traits": { - "smithy.api#documentation": "

The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration API call.

\n

These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

" + "smithy.api#documentation": "

The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration API call.

\n

These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in QuickSight, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

" } } }, @@ -50400,7 +50685,7 @@ "OAuthParameters": { "target": "com.amazonaws.quicksight#OAuthParameters", "traits": { - "smithy.api#documentation": "

An object that contains information needed to create a data source connection between an Amazon QuickSight account and Snowflake.

" + "smithy.api#documentation": "

An object that contains information needed to create a data source connection between an QuickSight account and Snowflake.

" } } }, @@ -50582,7 +50867,7 @@ } }, "traits": { - "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your\n underlying data source.

" + "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when QuickSight connects to your\n underlying data source.

" } }, "com.amazonaws.quicksight#StarburstParameters": { @@ -50630,7 +50915,7 @@ "OAuthParameters": { "target": "com.amazonaws.quicksight#OAuthParameters", "traits": { - "smithy.api#documentation": "

An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.

" + "smithy.api#documentation": "

An object that contains information needed to create a data source connection between an QuickSight account and Starburst.

" } } }, @@ -50687,7 +50972,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an Asset Bundle export job.

\n

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.

\n

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

", + "smithy.api#documentation": "

Starts an Asset Bundle export job.

\n

An Asset Bundle export job exports specified QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each QuickSight account can run up to 5 export jobs concurrently.

\n

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/asset-bundle-export-jobs/export", @@ -50844,7 +51129,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an Asset Bundle import job.

\n

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.

\n

The API caller must have the necessary \"create\", \"describe\", and \"update\" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.

", + "smithy.api#documentation": "

Starts an Asset Bundle import job.

\n

An Asset Bundle import job imports specified QuickSight assets into an QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your QuickSight account. Each QuickSight account can run up to 5 import jobs concurrently.

\n

The API caller must have the necessary \"create\", \"describe\", and \"update\" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs/import", @@ -50886,7 +51171,7 @@ "FailureAction": { "target": "com.amazonaws.quicksight#AssetBundleImportFailureAction", "traits": { - "smithy.api#documentation": "

The failure action for the import job.

\n

If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

\n

If you choose DO_NOTHING, failed import jobs will not attempt to roll back\n any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.

" + "smithy.api#documentation": "

The failure action for the import job.

\n

If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

\n

If you choose DO_NOTHING, failed import jobs will not attempt to roll back\n any asset changes caused by the failed job, possibly keeping the QuickSight account in an inconsistent state.

" } }, "OverridePermissions": { @@ -50984,7 +51269,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.

\n
    \n
  • \n

    1 Paginated PDF

    \n
  • \n
  • \n

    1 Excel workbook that includes up to 5 table or pivot table visuals

    \n
  • \n
  • \n

    5 CSVs from table or pivot table visuals

    \n
  • \n
\n

The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred.

\n

\n StartDashboardSnapshotJob API throttling\n

\n

Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.

\n

\n Common throttling scenarios\n

\n

The following list provides information about the most commin throttling scenarios that can occur.

\n
    \n
  • \n

    \n A large number of SnapshotExport API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job.

    \n
  • \n
  • \n

    \n A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a ThrottlingException is returned.

    \n
  • \n
\n

If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.

\n

\n Best practices to handle throttling\n

\n

If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.

\n

The time that it takes to process a job can be impacted by the following factors:

\n
    \n
  • \n

    The dataset type (Direct Query or SPICE).

    \n
  • \n
  • \n

    The size of the dataset.

    \n
  • \n
  • \n

    The complexity of the calculated fields that are used in the dashboard.

    \n
  • \n
  • \n

    The number of visuals that are on a sheet.

    \n
  • \n
  • \n

    The types of visuals that are on the sheet.

    \n
  • \n
  • \n

    The number of formats and snapshots that are requested in the job configuration.

    \n
  • \n
  • \n

    The size of the generated snapshots.

    \n
  • \n
", + "smithy.api#documentation": "

Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.

\n
    \n
  • \n

    1 Paginated PDF

    \n
  • \n
  • \n

    1 Excel workbook that includes up to 5 table or pivot table visuals

    \n
  • \n
  • \n

    5 CSVs from table or pivot table visuals

    \n
  • \n
\n

The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred.

\n

\n StartDashboardSnapshotJob API throttling\n

\n

QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, QuickSight throttles the API calls to maintin an optimal experience and reliability for all QuickSight users.

\n

\n Common throttling scenarios\n

\n

The following list provides information about the most commin throttling scenarios that can occur.

\n
    \n
  • \n

    \n A large number of SnapshotExport API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job.

    \n
  • \n
  • \n

    \n A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the QuickSight API in one second, a ThrottlingException is returned.

    \n
  • \n
\n

If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.

\n

\n Best practices to handle throttling\n

\n

If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.

\n

The time that it takes to process a job can be impacted by the following factors:

\n
    \n
  • \n

    The dataset type (Direct Query or SPICE).

    \n
  • \n
  • \n

    The size of the dataset.

    \n
  • \n
  • \n

    The complexity of the calculated fields that are used in the dashboard.

    \n
  • \n
  • \n

    The number of visuals that are on a sheet.

    \n
  • \n
  • \n

    The types of visuals that are on the sheet.

    \n
  • \n
  • \n

    The number of formats and snapshots that are requested in the job configuration.

    \n
  • \n
  • \n

    The size of the generated snapshots.

    \n
  • \n
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs", @@ -51021,7 +51306,7 @@ "UserConfiguration": { "target": "com.amazonaws.quicksight#SnapshotUserConfiguration", "traits": { - "smithy.api#documentation": "

\n A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.

", + "smithy.api#documentation": "

\n A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered QuickSight.

", "smithy.api#required": {} } }, @@ -51103,7 +51388,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.

\n

Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code.

\n

For more information, see Scheduling and sending Amazon QuickSight reports by email and Configuring email report settings for a Amazon QuickSight dashboard in the Amazon QuickSight User Guide.

", + "smithy.api#documentation": "

Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.

\n

Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code.

\n

For more information, see Scheduling and sending QuickSight reports by email and Configuring email report settings for a QuickSight dashboard in the Amazon QuickSight User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/schedules/{ScheduleId}", @@ -51133,7 +51418,7 @@ "ScheduleId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the Amazon QuickSight console in the Schedules pane of the dashboard that the schedule is configured for.

", + "smithy.api#documentation": "

The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the QuickSight console in the Schedules pane of the dashboard that the schedule is configured for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -51172,7 +51457,7 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.

", + "smithy.api#documentation": "

Determines if a QuickSight dashboard's state persistence settings are turned on or off.

", "smithy.api#required": {} } } @@ -51670,7 +51955,7 @@ } }, "traits": { - "smithy.api#documentation": "

A success entry that occurs when a KeyRegistration job is successfully applied to the Amazon QuickSight account.

" + "smithy.api#documentation": "

A success entry that occurs when a KeyRegistration job is successfully applied to the QuickSight account.

" } }, "com.amazonaws.quicksight#Suffix": { @@ -52667,7 +52952,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.

\n

Tags can help you organize and categorize your resources. You can also use them to\n\t\t\tscope user permissions, by granting a user permission to access or change only resources\n\t\t\twith certain tag values. You can use the TagResource operation with a\n\t\t\tresource that already has tags. If you specify a new tag key for the resource, this tag\n\t\t\tis appended to the list of tags associated with the resource. If you specify a tag key\n\t\t\tthat is already associated with the resource, the new tag value that you specify\n\t\t\treplaces the previous value for that tag.

\n

You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, template, topic, and user.

\n

Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for\n\t\t\tthe following:

\n
    \n
  • \n

    Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.

    \n
  • \n
  • \n

    Amazon QuickSight doesn't currently support the tag editor for Resource Groups.

    \n
  • \n
", + "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified QuickSight resource.

\n

Tags can help you organize and categorize your resources. You can also use them to\n\t\t\tscope user permissions, by granting a user permission to access or change only resources\n\t\t\twith certain tag values. You can use the TagResource operation with a\n\t\t\tresource that already has tags. If you specify a new tag key for the resource, this tag\n\t\t\tis appended to the list of tags associated with the resource. If you specify a tag key\n\t\t\tthat is already associated with the resource, the new tag value that you specify\n\t\t\treplaces the previous value for that tag.

\n

You can associate as many as 50 tags with a resource. QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, template, topic, and user.

\n

Tagging for QuickSight works in a similar way to tagging for other Amazon Web Services services, except for\n\t\t\tthe following:

\n
    \n
  • \n

    Tags are used to track costs for users in QuickSight. You can't tag other resources that QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.

    \n
  • \n
  • \n

    QuickSight doesn't currently support the tag editor for Resource Groups.

    \n
  • \n
", "smithy.api#http": { "method": "POST", "uri": "/resources/{ResourceArn}/tags", @@ -52793,7 +53078,7 @@ } }, "traits": { - "smithy.api#documentation": "

A template object. A template is an entity in Amazon QuickSight that\n encapsulates the metadata required to create an analysis and that you can use to create\n a dashboard. A template adds a layer of abstraction by using placeholders to replace the\n dataset associated with an analysis. You can use templates to create dashboards by\n replacing dataset placeholders with datasets that follow the same schema that was used\n to create the source analysis and template.

\n

You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to\n create a template or a dashboard from an existing template.

" + "smithy.api#documentation": "

A template object. A template is an entity in QuickSight that\n encapsulates the metadata required to create an analysis and that you can use to create\n a dashboard. A template adds a layer of abstraction by using placeholders to replace the\n dataset associated with an analysis. You can use templates to create dashboards by\n replacing dataset placeholders with datasets that follow the same schema that was used\n to create the source analysis and template.

\n

You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to\n create a template or a dashboard from an existing template.

" } }, "com.amazonaws.quicksight#TemplateAlias": { @@ -53657,7 +53942,7 @@ "BaseThemeId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All\n themes initially inherit from a default Amazon QuickSight theme.

" + "smithy.api#documentation": "

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All\n themes initially inherit from a default QuickSight theme.

" } }, "CreatedTime": { @@ -53772,13 +54057,13 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

The threshold alerts configuration for an embedded Amazon QuickSight dashboard.

", + "smithy.api#documentation": "

The threshold alerts configuration for an embedded QuickSight dashboard.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The threshold alerts configuration for an embedded Amazon QuickSight dashboard.

" + "smithy.api#documentation": "

The threshold alerts configuration for an embedded QuickSight dashboard.

" } }, "com.amazonaws.quicksight#ThrottlingException": { @@ -54926,6 +55211,12 @@ "traits": { "smithy.api#documentation": "

The relative date filter.

" } + }, + "NullFilter": { + "target": "com.amazonaws.quicksight#TopicNullFilter", + "traits": { + "smithy.api#documentation": "

The null filter.

" + } } }, "traits": { @@ -55550,6 +55841,30 @@ "smithy.api#documentation": "

A structure that represents a named entity.

" } }, + "com.amazonaws.quicksight#TopicNullFilter": { + "type": "structure", + "members": { + "NullFilterType": { + "target": "com.amazonaws.quicksight#NullFilterType", + "traits": { + "smithy.api#documentation": "

The type of the null filter. Valid values for this type are NULLS_ONLY, NON_NULLS_ONLY, and ALL_VALUES.

" + } + }, + "Constant": { + "target": "com.amazonaws.quicksight#TopicSingularFilterConstant" + }, + "Inverse": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates if the filter is inverse.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The structure that represents a null filter.

" + } + }, "com.amazonaws.quicksight#TopicNumericEqualityFilter": { "type": "structure", "members": { @@ -57028,7 +57343,7 @@ } }, "traits": { - "smithy.api#documentation": "

This error indicates that you are calling an embedding operation in Amazon QuickSight\n\t\t\twithout the required pricing plan on your Amazon Web Services account. Before you can use embedding \n\t\t\tfor anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You \n\t\t can do this on the Manage Amazon QuickSight page.

\n

After capacity pricing is added, you can use the \n \n GetDashboardEmbedUrl\n API operation with the \n --identity-type ANONYMOUS option.

", + "smithy.api#documentation": "

This error indicates that you are calling an embedding operation in Amazon QuickSight\n\t\t\twithout the required pricing plan on your Amazon Web Services account. Before you can use embedding \n\t\t\tfor anonymous users, a QuickSight administrator needs to add capacity pricing to QuickSight. You \n\t\t can do this on the Manage QuickSight page.

\n

After capacity pricing is added, you can use the \n \n GetDashboardEmbedUrl\n API operation with the \n --identity-type ANONYMOUS option.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -57047,7 +57362,7 @@ } }, "traits": { - "smithy.api#documentation": "

This error indicates that you are calling an operation on an Amazon QuickSight\n\t\t\tsubscription where the edition doesn't include support for that operation. Amazon\n\t\t\tAmazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and\n\t\t\tcapability is available in every edition.

", + "smithy.api#documentation": "

This error indicates that you are calling an operation on an Amazon QuickSight\n\t\t\tsubscription where the edition doesn't include support for that operation. Amazon\n\t\t\tQuickSight currently has Standard Edition and Enterprise Edition. Not every operation and\n\t\t\tcapability is available in every edition.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -57154,6 +57469,84 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#UpdateAccountCustomPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateAccountCustomPermissionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateAccountCustomPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Applies a custom permissions profile to an account.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/custom-permission", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateAccountCustomPermissionRequest": { + "type": "structure", + "members": { + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#CustomPermissionsName", + "traits": { + "smithy.api#documentation": "

The name of the custom permissions profile that you want to apply to an account.

", + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account for which you want to apply a custom permissions profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateAccountCustomPermissionResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#UpdateAccountCustomization": { "type": "operation", "input": { @@ -57186,7 +57579,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.

\n

You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a\n Amazon QuickSight namespace instead. Customizations that apply to a namespace override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.

", + "smithy.api#documentation": "

Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.

\n

You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a\n QuickSight namespace instead. Customizations that apply to a namespace override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.

", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/customizations", @@ -57200,7 +57593,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations\n for.

", + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to update QuickSight customizations\n for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -57208,14 +57601,14 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The namespace that you want to update Amazon QuickSight customizations for.

", + "smithy.api#documentation": "

The namespace that you want to update QuickSight customizations for.

", "smithy.api#httpQuery": "namespace" } }, "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

", + "smithy.api#documentation": "

The QuickSight customizations you're updating in the current Amazon Web Services Region.

", "smithy.api#required": {} } } @@ -57236,7 +57629,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations\n for.

" + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to update QuickSight customizations\n for.

" } }, "Namespace": { @@ -57248,7 +57641,7 @@ "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

" + "smithy.api#documentation": "

The QuickSight customizations you're updating in the current Amazon Web Services Region.

" } }, "RequestId": { @@ -57313,7 +57706,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to\n list.

", + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the QuickSight settings that you want to\n list.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -57321,21 +57714,21 @@ "DefaultNamespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The default namespace for this Amazon Web Services account. Currently, the default is\n default. IAM users that\n register for the first time with Amazon QuickSight provide an email address that becomes\n associated with the default namespace.\n

", + "smithy.api#documentation": "

The default namespace for this Amazon Web Services account. Currently, the default is\n default. IAM users that\n register for the first time with QuickSight provide an email address that becomes\n associated with the default namespace.\n

", "smithy.api#required": {} } }, "NotificationEmail": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The email address that you want Amazon QuickSight to send notifications to regarding your\n Amazon Web Services account or Amazon QuickSight subscription.

" + "smithy.api#documentation": "

The email address that you want QuickSight to send notifications to regarding your\n Amazon Web Services account or QuickSight subscription.

" } }, "TerminationProtectionEnabled": { "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

" + "smithy.api#documentation": "

A boolean value that determines whether or not an QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

" } } }, @@ -57543,7 +57936,7 @@ "Name": { "target": "com.amazonaws.quicksight#AnalysisName", "traits": { - "smithy.api#documentation": "

A descriptive name for the analysis that you're updating. This name displays for the\n analysis in the Amazon QuickSight console.

", + "smithy.api#documentation": "

A descriptive name for the analysis that you're updating. This name displays for the\n analysis in the QuickSight console.

", "smithy.api#required": {} } }, @@ -57562,7 +57955,7 @@ "ThemeArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're\n creating. To see the theme in the Amazon QuickSight console, make sure that you have access to\n it.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're\n creating. To see the theme in the QuickSight console, make sure that you have access to\n it.

" } }, "Definition": { @@ -57654,7 +58047,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an Amazon QuickSight application with a token exchange grant. This operation only supports Amazon QuickSight applications that are registered with IAM Identity Center.

", + "smithy.api#documentation": "

Updates an QuickSight application with a token exchange grant. This operation only supports QuickSight applications that are registered with IAM Identity Center.

", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/application-with-token-exchange-grant", @@ -57676,7 +58069,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The namespace of the Amazon QuickSight application.

", + "smithy.api#documentation": "

The namespace of the QuickSight application.

", "smithy.api#httpQuery": "namespace", "smithy.api#required": {} } @@ -57879,7 +58272,7 @@ "BrandId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

", + "smithy.api#documentation": "

The ID of the QuickSight brand.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -57930,7 +58323,7 @@ "BrandId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon QuickSight brand.

", + "smithy.api#documentation": "

The ID of the QuickSight brand.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -58343,7 +58736,7 @@ "LinkSharingConfiguration": { "target": "com.amazonaws.quicksight#LinkSharingConfiguration", "traits": { - "smithy.api#documentation": "

Updates the permissions of a shared link to an Amazon QuickSight dashboard.

" + "smithy.api#documentation": "

Updates the permissions of a shared link to an QuickSight dashboard.

" } } }, @@ -58483,7 +58876,7 @@ "SourceEntity": { "target": "com.amazonaws.quicksight#DashboardSourceEntity", "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you update the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a SourceTemplate\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the \n CreateTemplate\n API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate ARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

" + "smithy.api#documentation": "

The entity that you are using as a source when you update the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a SourceTemplate\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the \n CreateTemplate\n API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate ARN can contain any Amazon Web Services account and any\n QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

" } }, "Parameters": { @@ -58501,7 +58894,7 @@ "DashboardPublishOptions": { "target": "com.amazonaws.quicksight#DashboardPublishOptions", "traits": { - "smithy.api#documentation": "

Options for publishing the dashboard when you create it:

\n
    \n
  • \n

    \n AvailabilityStatus for AdHocFilteringOption - This\n status can be either ENABLED or DISABLED. When this is\n set to DISABLED, Amazon QuickSight disables the left filter pane on the\n published dashboard, which can be used for ad hoc (one-time) filtering. This\n option is ENABLED by default.

    \n
  • \n
  • \n

    \n AvailabilityStatus for ExportToCSVOption - This\n status can be either ENABLED or DISABLED. The visual\n option to export data to .CSV format isn't enabled when this is set to\n DISABLED. This option is ENABLED by default.

    \n
  • \n
  • \n

    \n VisibilityState for SheetControlsOption - This\n visibility state can be either COLLAPSED or EXPANDED.\n This option is COLLAPSED by default.

    \n
  • \n
" + "smithy.api#documentation": "

Options for publishing the dashboard when you create it:

\n
    \n
  • \n

    \n AvailabilityStatus for AdHocFilteringOption - This\n status can be either ENABLED or DISABLED. When this is\n set to DISABLED, QuickSight disables the left filter pane on the\n published dashboard, which can be used for ad hoc (one-time) filtering. This\n option is ENABLED by default.

    \n
  • \n
  • \n

    \n AvailabilityStatus for ExportToCSVOption - This\n status can be either ENABLED or DISABLED. The visual\n option to export data to .CSV format isn't enabled when this is set to\n DISABLED. This option is ENABLED by default.

    \n
  • \n
  • \n

    \n VisibilityState for SheetControlsOption - This\n visibility state can be either COLLAPSED or EXPANDED.\n This option is COLLAPSED by default.

    \n
  • \n
  • \n

    \n AvailabilityStatus for ExecutiveSummaryOption - This status\n can be either ENABLED or DISABLED. The option to build an executive\n summary is disabled when this is set to DISABLED. This option is ENABLED\n by default.

    \n
  • \n
  • \n

    \n AvailabilityStatus for DataStoriesSharingOption - This status\n can be either ENABLED or DISABLED. The option to share a data story is\n disabled when this is set to DISABLED. This option is ENABLED\n by default.

    \n
  • \n
" } }, "ThemeArn": { @@ -58859,7 +59252,7 @@ "ColumnGroups": { "target": "com.amazonaws.quicksight#ColumnGroupList", "traits": { - "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

" + "smithy.api#documentation": "

Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.

" } }, "FieldFolders": { @@ -59128,25 +59521,25 @@ "DataSourceParameters": { "target": "com.amazonaws.quicksight#DataSourceParameters", "traits": { - "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying source.

" + "smithy.api#documentation": "

The parameters that QuickSight uses to connect to your underlying source.

" } }, "Credentials": { "target": "com.amazonaws.quicksight#DataSourceCredentials", "traits": { - "smithy.api#documentation": "

The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently,\n\t\t\tonly credentials based on user name and password are supported.

" + "smithy.api#documentation": "

The credentials that QuickSight that uses to connect to your underlying source. Currently,\n\t\t\tonly credentials based on user name and password are supported.

" } }, "VpcConnectionProperties": { "target": "com.amazonaws.quicksight#VpcConnectionProperties", "traits": { - "smithy.api#documentation": "

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.

" + "smithy.api#documentation": "

Use this parameter only when you want QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.

" } }, "SslProperties": { "target": "com.amazonaws.quicksight#SslProperties", "traits": { - "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying\n\t\t\tsource.

" + "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying\n\t\t\tsource.

" } } }, @@ -59223,7 +59616,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a Amazon Q Business application that is linked to a Amazon QuickSight account.

", + "smithy.api#documentation": "

Updates a Amazon Q Business application that is linked to a QuickSight account.

", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/default-qbusiness-application", @@ -59237,7 +59630,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon QuickSight account that is connected to the Amazon Q Business application that you want to update.

", + "smithy.api#documentation": "

The ID of the QuickSight account that is connected to the Amazon Q Business application that you want to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -59245,7 +59638,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.

", + "smithy.api#documentation": "

The QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.

", "smithy.api#httpQuery": "namespace" } }, @@ -59688,13 +60081,13 @@ "PolicyArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

The ARN for the IAM policy to apply to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" + "smithy.api#documentation": "

The ARN for the IAM policy to apply to the QuickSight users and\n\t\t\tgroups specified in this assignment.

" } }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that you want to assign the policy\n\t\t\tto.

" + "smithy.api#documentation": "

The QuickSight users, groups, or both that you want to assign the policy\n\t\t\tto.

" } } }, @@ -59720,13 +60113,13 @@ "PolicyArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

The ARN for the IAM policy applied to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" + "smithy.api#documentation": "

The ARN for the IAM policy applied to the QuickSight users and\n\t\t\tgroups specified in this assignment.

" } }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that the IAM policy is\n\t\t\tassigned to.

" + "smithy.api#documentation": "

The QuickSight users, groups, or both that the IAM policy is\n\t\t\tassigned to.

" } }, "AssignmentStatus": { @@ -59780,7 +60173,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.

\n

This operation is only supported for Amazon QuickSight accounts using IAM Identity Center

", + "smithy.api#documentation": "

Adds or updates services and authorized targets to configure what the QuickSight IAM Identity Center application can access.

\n

This operation is only supported for QuickSight accounts using IAM Identity Center

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/identity-propagation-config/{Service}", @@ -59968,7 +60361,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a customer managed key in a Amazon QuickSight account.

", + "smithy.api#documentation": "

Updates a customer managed key in a QuickSight account.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/key-registration", @@ -59990,7 +60383,7 @@ "KeyRegistration": { "target": "com.amazonaws.quicksight#KeyRegistration", "traits": { - "smithy.api#documentation": "

A list of RegisteredCustomerManagedKey objects to be updated to the Amazon QuickSight account.

", + "smithy.api#documentation": "

A list of RegisteredCustomerManagedKey objects to be updated to the QuickSight account.

", "smithy.api#required": {} } } @@ -60066,7 +60459,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use the UpdatePublicSharingSettings operation to turn on or turn off the\n public sharing settings of an Amazon QuickSight dashboard.

\n

To use this operation, turn on session capacity pricing for your Amazon QuickSight\n account.

\n

Before you can turn on public sharing on your account, make sure to give public sharing\n permissions to an administrative user in the Identity and Access Management (IAM)\n console. For more information on using IAM with Amazon QuickSight, see\n Using Amazon QuickSight with IAM in the Amazon QuickSight\n User Guide.

", + "smithy.api#documentation": "\n

This API controls public sharing settings for your entire QuickSight account, affecting data security and access. When you enable public sharing:

\n
    \n
  • \n

    Dashboards can be shared publicly

    \n
  • \n
  • \n

    This setting affects your entire Amazon Web Services account and all QuickSight users

    \n
  • \n
\n

\n Before proceeding: Ensure you understand the security implications and have proper IAM permissions configured.

\n
\n

Use the UpdatePublicSharingSettings operation to turn on or turn off the\n public sharing settings of an QuickSight dashboard.

\n

To use this operation, turn on session capacity pricing for your QuickSight\n account.

\n

Before you can turn on public sharing on your account, make sure to give public sharing\n permissions to an administrative user in the Identity and Access Management (IAM)\n console. For more information on using IAM with QuickSight, see\n Using QuickSight with IAM in the QuickSight\n User Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/public-sharing-settings", @@ -60080,7 +60473,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

", + "smithy.api#documentation": "

The Amazon Web Services account ID associated with your QuickSight subscription.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -60089,7 +60482,7 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

" + "smithy.api#documentation": "

A Boolean value that indicates whether public sharing is turned on for an QuickSight account.

" } } }, @@ -60173,7 +60566,7 @@ "PersonalizationMode": { "target": "com.amazonaws.quicksight#PersonalizationMode", "traits": { - "smithy.api#documentation": "

An option to allow Amazon QuickSight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.

", + "smithy.api#documentation": "

An option to allow QuickSight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.

", "smithy.api#required": {} } } @@ -60239,7 +60632,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the state of a Amazon QuickSight Q Search configuration.

", + "smithy.api#documentation": "

Updates the state of a QuickSight Q Search configuration.

", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/quicksight-q-search-configuration", @@ -60253,7 +60646,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the Amazon QuickSight Q Search configuration that you want to update.

", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the QuickSight Q Search configuration that you want to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -60261,7 +60654,7 @@ "QSearchStatus": { "target": "com.amazonaws.quicksight#QSearchStatus", "traits": { - "smithy.api#documentation": "

The status of the Amazon QuickSight Q Search configuration that the user wants to update.

", + "smithy.api#documentation": "

The status of the QuickSight Q Search configuration that the user wants to update.

", "smithy.api#required": {} } } @@ -60276,7 +60669,7 @@ "QSearchStatus": { "target": "com.amazonaws.quicksight#QSearchStatus", "traits": { - "smithy.api#documentation": "

The status of the Amazon QuickSight Q Search configuration.

" + "smithy.api#documentation": "

The status of the QuickSight Q Search configuration.

" } }, "RequestId": { @@ -60541,7 +60934,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the SPICE capacity configuration for a Amazon QuickSight account.

", + "smithy.api#documentation": "

Updates the SPICE capacity configuration for a QuickSight account.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/spice-capacity-configuration", @@ -60876,7 +61269,7 @@ "SourceEntity": { "target": "com.amazonaws.quicksight#TemplateSourceEntity", "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you update the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.

\n

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

" + "smithy.api#documentation": "

The entity that you are using as a source when you update the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any QuickSight-supported Amazon Web Services Region;.

\n

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

" } }, "VersionDescription": { @@ -61248,7 +61641,7 @@ "BaseThemeId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.\n\t\tAll themes initially inherit from a default Amazon QuickSight theme.

", + "smithy.api#documentation": "

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.\n\t\tAll themes initially inherit from a default QuickSight theme.

", "smithy.api#required": {} } }, @@ -61857,14 +62250,14 @@ "Role": { "target": "com.amazonaws.quicksight#UserRole", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight role of the user. The role can be one of the\n\t\t\tfollowing default security cohorts:

\n
    \n
  • \n

    \n READER: A user who has read-only access to dashboards.

    \n
  • \n
  • \n

    \n AUTHOR: A user who can create data sources, datasets, analyses, and\n\t\t\t\t\tdashboards.

    \n
  • \n
  • \n

    \n ADMIN: A user who is an author, who can also manage Amazon QuickSight\n\t\t\t\t\tsettings.

    \n
  • \n
  • \n

    \n READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    \n
  • \n
  • \n

    \n AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    \n
  • \n
  • \n

    \n ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

    \n
  • \n
\n

The name of the Amazon QuickSight role is invisible to the user except for the console\n\t screens dealing with permissions.

", + "smithy.api#documentation": "

The Amazon QuickSight role of the user. The role can be one of the\n\t\t\tfollowing default security cohorts:

\n
    \n
  • \n

    \n READER: A user who has read-only access to dashboards.

    \n
  • \n
  • \n

    \n AUTHOR: A user who can create data sources, datasets, analyses, and\n\t\t\t\t\tdashboards.

    \n
  • \n
  • \n

    \n ADMIN: A user who is an author, who can also manage Amazon QuickSight\n\t\t\t\t\tsettings.

    \n
  • \n
  • \n

    \n READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    \n
  • \n
  • \n

    \n AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    \n
  • \n
  • \n

    \n ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

    \n
  • \n
\n

The name of the QuickSight role is invisible to the user except for the console\n\t screens dealing with permissions.

", "smithy.api#required": {} } }, "CustomPermissionsName": { "target": "com.amazonaws.quicksight#RoleName", "traits": { - "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n
    \n
  • \n

    Create and update data sources

    \n
  • \n
  • \n

    Create and update datasets

    \n
  • \n
  • \n

    Create and update email reports

    \n
  • \n
  • \n

    Subscribe to email reports

    \n
  • \n
\n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" + "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n
    \n
  • \n

    Create and update data sources

    \n
  • \n
  • \n

    Create and update datasets

    \n
  • \n
  • \n

    Create and update email reports

    \n
  • \n
  • \n

    Subscribe to email reports

    \n
  • \n
\n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a QuickSight user.

\n

QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning QuickSight users to one of the\n default security cohorts in QuickSight (admin, author, reader).

\n

This feature is available only to QuickSight Enterprise edition subscriptions.

" } }, "UnapplyCustomPermissions": { @@ -61877,13 +62270,13 @@ "ExternalLoginFederationProviderType": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

\n
    \n
  • \n

    \n COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the \"CustomFederationProviderUrl\" parameter which is only needed when the external provider is custom.

    \n
  • \n
  • \n

    \n CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

    \n
  • \n
  • \n

    \n NONE: This clears all the previously saved external login information for a user. Use the\n \n DescribeUser\n \n API operation to check the external login information.

    \n
  • \n
" + "smithy.api#documentation": "

The type of supported external login provider that provides identity to let a user federate into QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

\n
    \n
  • \n

    \n COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the \"CustomFederationProviderUrl\" parameter which is only needed when the external provider is custom.

    \n
  • \n
  • \n

    \n CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

    \n
  • \n
  • \n

    \n NONE: This clears all the previously saved external login information for a user. Use the\n \n DescribeUser\n \n API operation to check the external login information.

    \n
  • \n
" } }, "CustomFederationProviderUrl": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate\n into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should\n only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

" + "smithy.api#documentation": "

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate\n into QuickSight with an associated Identity and Access Management(IAM) role. This parameter should\n only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

" } }, "ExternalLoginId": { @@ -62123,7 +62516,7 @@ "UserName": { "target": "com.amazonaws.quicksight#UserName", "traits": { - "smithy.api#documentation": "

The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is\n N/A when the value for IdentityType is IAM\n and the corresponding IAM user is deleted.

" + "smithy.api#documentation": "

The user's user name. This value is required if you are registering a user that will be managed in QuickSight. In the output, the value for UserName is\n N/A when the value for IdentityType is IAM\n and the corresponding IAM user is deleted.

" } }, "Email": { @@ -62135,7 +62528,7 @@ "Role": { "target": "com.amazonaws.quicksight#UserRole", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight role for the user. The user role can be one of the\n following:.

\n
    \n
  • \n

    \n READER: A user who has read-only access to dashboards.

    \n
  • \n
  • \n

    \n AUTHOR: A user who can create data sources, datasets, analyses,\n and dashboards.

    \n
  • \n
  • \n

    \n ADMIN: A user who is an author, who can also manage Amazon\n Amazon QuickSight settings.

    \n
  • \n
  • \n

    \n READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    \n
  • \n
  • \n

    \n AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    \n
  • \n
  • \n

    \n ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

    \n
  • \n
  • \n

    \n RESTRICTED_READER: This role isn't currently available for\n use.

    \n
  • \n
  • \n

    \n RESTRICTED_AUTHOR: This role isn't currently available for\n use.

    \n
  • \n
" + "smithy.api#documentation": "

The Amazon QuickSight role for the user. The user role can be one of the\n following:.

\n
    \n
  • \n

    \n READER: A user who has read-only access to dashboards.

    \n
  • \n
  • \n

    \n AUTHOR: A user who can create data sources, datasets, analyses,\n and dashboards.

    \n
  • \n
  • \n

    \n ADMIN: A user who is an author, who can also manage Amazon\n QuickSight settings.

    \n
  • \n
  • \n

    \n READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    \n
  • \n
  • \n

    \n AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    \n
  • \n
  • \n

    \n ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

    \n
  • \n
  • \n

    \n RESTRICTED_READER: This role isn't currently available for\n use.

    \n
  • \n
  • \n

    \n RESTRICTED_AUTHOR: This role isn't currently available for\n use.

    \n
  • \n
" } }, "IdentityType": { diff --git a/codegen/sdk/aws-models/ram.json b/codegen/sdk/aws-models/ram.json index ccaa398d88a..253f1a64fed 100644 --- a/codegen/sdk/aws-models/ram.json +++ b/codegen/sdk/aws-models/ram.json @@ -1114,17 +1114,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1138,17 +1127,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1162,17 +1140,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1186,17 +1153,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/rbin.json b/codegen/sdk/aws-models/rbin.json index f89e8d45c46..bb282035e30 100644 --- a/codegen/sdk/aws-models/rbin.json +++ b/codegen/sdk/aws-models/rbin.json @@ -810,17 +810,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -834,17 +823,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -858,17 +836,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -882,17 +849,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/rds-data.json b/codegen/sdk/aws-models/rds-data.json index ce1fb8dfa19..aa174724c69 100644 --- a/codegen/sdk/aws-models/rds-data.json +++ b/codegen/sdk/aws-models/rds-data.json @@ -1636,17 +1636,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1660,17 +1649,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1684,17 +1662,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1708,17 +1675,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/rds.json b/codegen/sdk/aws-models/rds.json index f407a7920fb..c62804774d9 100644 --- a/codegen/sdk/aws-models/rds.json +++ b/codegen/sdk/aws-models/rds.json @@ -399,12 +399,18 @@ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, + { + "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" + }, { "target": "com.amazonaws.rds#DBProxyNotFoundFault" }, { "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" }, + { + "target": "com.amazonaws.rds#DBShardGroupNotFoundFault" + }, { "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" }, @@ -414,6 +420,15 @@ { "target": "com.amazonaws.rds#IntegrationNotFoundFault" }, + { + "target": "com.amazonaws.rds#InvalidDBClusterEndpointStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, { "target": "com.amazonaws.rds#TenantDatabaseNotFoundFault" } @@ -1860,17 +1875,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1884,17 +1888,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1908,17 +1901,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1932,17 +1914,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -2159,6 +2130,15 @@ } } }, + "com.amazonaws.rds#AuthUserName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, "com.amazonaws.rds#AuthorizationAlreadyExistsFault": { "type": "structure", "members": { @@ -2582,7 +2562,7 @@ "min": 1, "max": 60 }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + "smithy.api#pattern": "^[a-zA-Z](?:-?[a-zA-Z0-9]+)*$" } }, "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault": { @@ -2936,7 +2916,7 @@ } }, "MasterUserPassword": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

The master credentials for the DB cluster.

" } @@ -2959,6 +2939,12 @@ "smithy.api#documentation": "

The number of days for which automatic DB snapshots are retained.

" } }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type for the DB cluster.

" + } + }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { @@ -2977,12 +2963,6 @@ "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The storage type for the DB cluster.

" - } - }, "CertificateDetails": { "target": "com.amazonaws.rds#CertificateDetails" } @@ -3005,6 +2985,12 @@ "traits": { "smithy.api#enumValue": "limitless" } + }, + "SCALEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scaleout" + } } } }, @@ -3275,7 +3261,7 @@ "target": "com.amazonaws.rds#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

\n

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
  • \n
  • \n

    If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.

    \n
  • \n
  • \n

    If the source snapshot is in a different Amazon Web Services Region than the copy,\n specify a valid DB cluster snapshot ARN. For more information, go to\n \n Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

    \n
  • \n
\n

Example: my-cluster-snapshot1\n

", + "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid source snapshot in the \"available\" state.

    \n
  • \n
  • \n

    If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.

    \n
  • \n
  • \n

    If the source snapshot is in a different Amazon Web Services Region than the copy,\n specify a valid DB cluster snapshot ARN. You can also specify an ARN of a snapshot that is in a different account and a different Amazon Web Services Region.\n For more information, go to\n \n Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

    \n
  • \n
\n

Example: my-cluster-snapshot1\n

", "smithy.api#required": {} } }, @@ -3294,7 +3280,7 @@ } }, "PreSignedUrl": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region\n to another, the URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains\n the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when\n copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify\n PreSignedUrl when copying an encrypted DB cluster snapshot in the same\n Amazon Web Services Region.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n
    \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key\n to use to encrypt the copy of the DB cluster snapshot in the destination\n Amazon Web Services Region. This is the same identifier for both the\n CopyDBClusterSnapshot operation that is called in the\n destination Amazon Web Services Region, and the operation contained in the presigned\n URL.

    \n
  • \n
  • \n

    \n DestinationRegion - The name of the Amazon Web Services Region \n that the DB cluster snapshot is to be created in.

    \n
  • \n
  • \n

    \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    \n
  • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n
" } @@ -3492,7 +3478,7 @@ "target": "com.amazonaws.rds#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The identifier for the source DB snapshot.

\n

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.

\n

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

\n

If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

\n

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
  • \n
\n

Example: rds:mydb-2012-04-02-00-01\n

\n

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n

", + "smithy.api#documentation": "

The identifier for the source DB snapshot.

\n

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.

\n

If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

\n

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. You can also specify an ARN of a snapshot that is in a different account and a different Amazon Web Services Region. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid source snapshot in the \"available\" state.

    \n
  • \n
\n

Example: rds:mydb-2012-04-02-00-01\n

\n

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n

", "smithy.api#required": {} } }, @@ -3520,7 +3506,7 @@ } }, "PreSignedUrl": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, \n the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API \n operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

You must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n
    \n
  • \n

    \n DestinationRegion - The Amazon Web Services Region that the encrypted DB\n snapshot is copied to. This Amazon Web Services Region is the same one where the\n CopyDBSnapshot operation is called that contains this presigned\n URL.

    \n

    For example, if you copy an encrypted DB snapshot from the us-west-2\n Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the\n CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and\n provide a presigned URL that contains a call to the CopyDBSnapshot\n operation in the us-west-2 Amazon Web Services Region. For this example, the\n DestinationRegion in the presigned URL must be set to the\n us-east-1 Amazon Web Services Region.

    \n
  • \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the\n same identifier for both the CopyDBSnapshot operation that is\n called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.

    \n
  • \n
  • \n

    \n SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. \n For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like\n the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

    \n
  • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n
" } @@ -3537,6 +3523,12 @@ "smithy.api#documentation": "

The external custom Availability Zone (CAZ) identifier for the target CAZ.

\n

Example: rds-caz-aiqhTgQv.

" } }, + "SnapshotTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Configures the location where RDS will store copied snapshots.

\n

Valid Values:

\n
    \n
  • \n

    \n local (Dedicated Local Zone)

    \n
  • \n
  • \n

    \n outposts (Amazon Web Services Outposts)

    \n
  • \n
  • \n

    \n region (Amazon Web Services Region)

    \n
  • \n
" + } + }, "CopyOptionGroup": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { @@ -3548,12 +3540,6 @@ "traits": { "smithy.api#documentation": "

Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.

" } - }, - "SnapshotTarget": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Configures the location where RDS will store copied snapshots.

\n

Valid Values:

\n
    \n
  • \n

    \n local (Dedicated Local Zone)

    \n
  • \n
  • \n

    \n outposts (Amazon Web Services Outposts)

    \n
  • \n
  • \n

    \n region (Amazon Web Services Region)

    \n
  • \n
" - } } }, "traits": { @@ -3705,6 +3691,9 @@ }, { "target": "com.amazonaws.rds#SourceDatabaseNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" } ], "traits": { @@ -3821,12 +3810,18 @@ { "target": "com.amazonaws.rds#CustomDBEngineVersionAlreadyExistsFault" }, + { + "target": "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault" + }, { "target": "com.amazonaws.rds#CustomDBEngineVersionQuotaExceededFault" }, { "target": "com.amazonaws.rds#Ec2ImagePropertiesNotSupportedFault" }, + { + "target": "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault" + }, { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" } @@ -3895,6 +3890,18 @@ "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for \n RDS Custom, but optional for Amazon RDS.

\n

If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. \n No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, \n follow the instructions in \n Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service\n Developer Guide.

\n

You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

" } }, + "SourceCustomDbEngineVersionIdentifier": { + "target": "com.amazonaws.rds#String255", + "traits": { + "smithy.api#documentation": "

The ARN of a CEV to use as a source for creating a new CEV. You can specify a different\n Amazon Machine Imagine (AMI) by using either Source or\n UseAwsProvidedLatestImage. You can't specify a different JSON manifest\n when you specify SourceCustomDbEngineVersionIdentifier.

" + } + }, + "UseAwsProvidedLatestImage": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for\n the CEV. If you specify UseAwsProvidedLatestImage, you can't also specify\n ImageId.

" + } + }, "Description": { "target": "com.amazonaws.rds#Description", "traits": { @@ -3909,18 +3916,6 @@ }, "Tags": { "target": "com.amazonaws.rds#TagList" - }, - "SourceCustomDbEngineVersionIdentifier": { - "target": "com.amazonaws.rds#String255", - "traits": { - "smithy.api#documentation": "

The ARN of a CEV to use as a source for creating a new CEV. You can specify a different\n Amazon Machine Imagine (AMI) by using either Source or\n UseAwsProvidedLatestImage. You can't specify a different JSON manifest\n when you specify SourceCustomDbEngineVersionIdentifier.

" - } - }, - "UseAwsProvidedLatestImage": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for\n the CEV. If you specify UseAwsProvidedLatestImage, you can't also specify\n ImageId.

" - } } }, "traits": { @@ -3993,11 +3988,17 @@ { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, { "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" } ], "traits": { @@ -4239,7 +4240,7 @@ "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "

A list of Availability Zones (AZs) where you specifically want to create DB instances in the DB cluster.

\n

For information on AZs, see \n Availability Zones\n in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Constraints:

\n
    \n
  • \n

    Can't specify more than three AZs.

    \n
  • \n
" + "smithy.api#documentation": "

A list of Availability Zones (AZs) where you specifically want to create DB instances in the DB cluster.

\n

For the first three DB instances that you create, RDS distributes each DB instance to\n a different AZ that you specify. For additional DB instances that you create, RDS\n randomly distributes them to the AZs that you specified. For example, if you create a DB\n cluster with one writer instance and three reader instances, RDS might distribute the\n writer instance to AZ 1, the first reader instance to AZ 2, the second reader instance\n to AZ 3, and the third reader instance to either AZ 1, AZ 2, or AZ 3.

\n

For more information, see Availability Zones and High availability for Aurora DB instances in the Amazon Aurora\n User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Constraints:

\n
    \n
  • \n

    Can't specify more than three AZs.

    \n
  • \n
" } }, "BackupRetentionPeriod": { @@ -4313,7 +4314,7 @@ } }, "MasterUserPassword": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

The password for the master database user.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must contain from 8 to 41 characters.

    \n
  • \n
  • \n

    Can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n
  • \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
  • \n
" } @@ -4361,7 +4362,7 @@ } }, "PreSignedUrl": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another,\n an URL that contains a Signature Version 4 signed request for the\n CreateDBCluster operation to be called in the source Amazon Web Services Region where\n the DB cluster is replicated from. Specify PreSignedUrl only when you are\n performing cross-Region replication from an encrypted DB cluster.

\n

The presigned URL must be a valid request for the CreateDBCluster API\n operation that can run in the source Amazon Web Services Region that contains the encrypted DB\n cluster to copy.

\n

The presigned URL request must contain the following parameter values:

\n
    \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should\n refer to the same KMS key for both the CreateDBCluster operation\n that is called in the destination Amazon Web Services Region, and the operation contained in\n the presigned URL.

    \n
  • \n
  • \n

    \n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.

    \n
  • \n
  • \n

    \n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

    \n
  • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n
\n

Valid for Cluster Type: Aurora DB clusters only

" } @@ -4402,6 +4403,42 @@ "smithy.api#documentation": "

Reserved for future use.

" } }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

This setting is required to create a Multi-AZ DB cluster.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type to associate with the DB cluster.

\n

For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values:

\n
    \n
  • \n

    Aurora DB clusters - aurora | aurora-iopt1\n

    \n
  • \n
  • \n

    Multi-AZ DB clusters - io1 | io2 | gp3\n

    \n
  • \n
\n

Default:

\n
    \n
  • \n

    Aurora DB clusters - aurora\n

    \n
  • \n
  • \n

    Multi-AZ DB clusters - io1\n

    \n
  • \n
\n \n

When you create an Aurora DB cluster with the storage type set to aurora-iopt1, the storage type is returned\n in the response. The storage type isn't returned when you set it to aurora.

\n
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS\n User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Constraints:

\n
    \n
  • \n

    Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

    \n
  • \n
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), \n its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, \n the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
  • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
  • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
  • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
  • \n
" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" + } + }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { @@ -4409,7 +4446,7 @@ } }, "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#GlobalClusterIdentifier", "traits": { "smithy.api#documentation": "

The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.

\n

Valid for Cluster Type: Aurora DB clusters only

" } @@ -4444,41 +4481,14 @@ "smithy.api#documentation": "

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster\n (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by a global cluster API operation, but it does nothing until then.

\n

Valid for Cluster Type: Aurora DB clusters only

" } }, - "DBClusterInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

This setting is required to create a Multi-AZ DB cluster.

" - } - }, - "StorageType": { + "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The storage type to associate with the DB cluster.

\n

For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values:

\n
    \n
  • \n

    Aurora DB clusters - aurora | aurora-iopt1\n

    \n
  • \n
  • \n

    Multi-AZ DB clusters - io1 | io2 | gp3\n

    \n
  • \n
\n

Default:

\n
    \n
  • \n

    Aurora DB clusters - aurora\n

    \n
  • \n
  • \n

    Multi-AZ DB clusters - io1\n

    \n
  • \n
\n \n

When you create an Aurora DB cluster with the storage type set to aurora-iopt1, the storage type is returned\n in the response. The storage type isn't returned when you set it to aurora.

\n
" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS\n User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Constraints:

\n
    \n
  • \n

    Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

    \n
  • \n
" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), \n its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, \n the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
  • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
  • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
  • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
  • \n
" + "smithy.api#documentation": "

The network type of the DB cluster.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: IPV4 | DUAL\n

" } }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" - } + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", @@ -4522,15 +4532,6 @@ "smithy.api#documentation": "

Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

\n

Valid for: Aurora DB clusters only

\n \n

This setting is no longer used. Instead use the ClusterScalabilityType setting.

\n
" } }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: IPV4 | DUAL\n

" - } - }, "ClusterScalabilityType": { "target": "com.amazonaws.rds#ClusterScalabilityType", "traits": { @@ -4549,18 +4550,18 @@ "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
  • \n
" } }, - "MasterUserSecretKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, "EnableLocalWriteForwarding": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\n default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" } }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, "CACertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { @@ -4572,6 +4573,12 @@ "traits": { "smithy.api#documentation": "

The life cycle type for this DB cluster.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n creating the DB cluster will fail if the DB major version is past its end of standard support date.

\n
\n

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" } + }, + "MasterUserAuthenticationType": { + "target": "com.amazonaws.rds#MasterUserAuthenticationType", + "traits": { + "smithy.api#documentation": "

Specifies the authentication type for the master user. With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB cluster.

\n

You can specify one of the following values:

\n
    \n
  • \n

    \n password - Use standard database authentication with a password.

    \n
  • \n
  • \n

    \n iam-db-auth - Use IAM database authentication for the master user.

    \n
  • \n
\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines.

" + } } }, "traits": { @@ -5017,7 +5024,7 @@ } }, "MasterUserPassword": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

The password for the master user.

\n

This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB\n cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
  • \n
  • \n

    Can include any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't include the \"&\" (ampersand) or the \"'\" (single quotes) character.

    \n
  • \n
\n

Length Constraints:

\n
    \n
  • \n

    RDS for Db2 - Must contain from 8 to 255 characters.

    \n
  • \n
  • \n

    RDS for MariaDB - Must contain from 8 to 41 characters.

    \n
  • \n
  • \n

    RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

    \n
  • \n
  • \n

    RDS for MySQL - Must contain from 8 to 41 characters.

    \n
  • \n
  • \n

    RDS for Oracle - Must contain from 8 to 30 characters.

    \n
  • \n
  • \n

    RDS for PostgreSQL - Must contain from 8 to 128 characters.

    \n
  • \n
" } @@ -5097,7 +5104,7 @@ "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The license model information for this DB instance.

\n \n

License models for RDS for Db2 require additional configuration. The Bring Your\n Own License (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through\n Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more\n information, see Amazon RDS for Db2 licensing\n options in the Amazon RDS User Guide.

\n

The default for RDS for Db2 is bring-your-own-license.

\n
\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    RDS for Db2 - bring-your-own-license | marketplace-license\n

    \n
  • \n
  • \n

    RDS for MariaDB - general-public-license\n

    \n
  • \n
  • \n

    RDS for Microsoft SQL Server - license-included\n

    \n
  • \n
  • \n

    RDS for MySQL - general-public-license\n

    \n
  • \n
  • \n

    RDS for Oracle - bring-your-own-license | license-included\n

    \n
  • \n
  • \n

    RDS for PostgreSQL - postgresql-license\n

    \n
  • \n
" + "smithy.api#documentation": "

The license model information for this DB instance.

\n \n

License models for RDS for Db2 require additional configuration. The bring your\n own license (BYOL) model requires a custom parameter group and an Amazon Web Services License\n Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model\n requires an Amazon Web Services Marketplace subscription. For more information, see Amazon\n RDS for Db2 licensing options in the Amazon RDS User\n Guide.

\n

The default for RDS for Db2 is bring-your-own-license.

\n
\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    RDS for Db2 - bring-your-own-license | marketplace-license\n

    \n
  • \n
  • \n

    RDS for MariaDB - general-public-license\n

    \n
  • \n
  • \n

    RDS for Microsoft SQL Server - license-included\n

    \n
  • \n
  • \n

    RDS for MySQL - general-public-license\n

    \n
  • \n
  • \n

    RDS for Oracle - bring-your-own-license | license-included\n

    \n
  • \n
  • \n

    RDS for PostgreSQL - postgresql-license\n

    \n
  • \n
" } }, "Iops": { @@ -5106,6 +5113,12 @@ "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 \n of the storage amount for the DB instance.

    \n
  • \n
  • \n

    For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.

    \n
  • \n
" } }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput value, in mebibyte per second (MiBps), for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" + } + }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { @@ -5155,7 +5168,7 @@ } }, "TdeCredentialPassword": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom DB instances.

" } @@ -5298,10 +5311,10 @@ "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, - "CustomIamInstanceProfile": { + "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance.

\n

This setting is required for RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
  • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
  • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
  • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" } }, "BackupTarget": { @@ -5310,16 +5323,22 @@ "smithy.api#documentation": "

The location for storing automated backups and manual snapshots.

\n

Valid Values:

\n
    \n
  • \n

    \n local (Dedicated Local Zone)

    \n
  • \n
  • \n

    \n outposts (Amazon Web Services Outposts)

    \n
  • \n
  • \n

    \n region (Amazon Web Services Region)

    \n
  • \n
\n

Default: region\n

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" } }, - "NetworkType": { + "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance.

\n

This setting is required for RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
  • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
  • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
  • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

" } }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", + "DBSystemId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The storage throughput value, in mebibyte per second (MiBps), for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" + "smithy.api#documentation": "

The Oracle system identifier (SID), which is the name of the Oracle database instance that \n manages your database files. In this context, the term \"Oracle database instance\" refers exclusively \n to the system global area (SGA) and Oracle background processes. If you don't specify a SID, \n the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The CA certificate identifier to use for the DB instance's server certificate.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" } }, "ManageMasterUserPassword": { @@ -5334,16 +5353,10 @@ "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" } }, - "CACertificateIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The CA certificate identifier to use for the DB instance's server certificate.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" - } - }, - "DBSystemId": { - "target": "com.amazonaws.rds#String", + "MultiTenant": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

The Oracle system identifier (SID), which is the name of the Oracle database instance that \n manages your database files. In this context, the term \"Oracle database instance\" refers exclusively \n to the system global area (SGA) and Oracle background processes. If you don't specify a SID, \n the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.

" + "smithy.api#documentation": "

Specifies whether to use the multi-tenant configuration or the single-tenant\n configuration (default). This parameter only applies to RDS for Oracle container\n database (CDB) engines.

\n

Note the following restrictions:

\n
    \n
  • \n

    The DB engine that you specify in the request must support the multi-tenant\n configuration. If you attempt to enable the multi-tenant configuration on a DB\n engine that doesn't support it, the request fails.

    \n
  • \n
  • \n

    If you specify the multi-tenant configuration when you create your DB instance,\n you can't later modify this DB instance to use the single-tenant configuration.

    \n
  • \n
" } }, "DedicatedLogVolume": { @@ -5352,17 +5365,17 @@ "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" } }, - "MultiTenant": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to use the multi-tenant configuration or the single-tenant\n configuration (default). This parameter only applies to RDS for Oracle container\n database (CDB) engines.

\n

Note the following restrictions:

\n
    \n
  • \n

    The DB engine that you specify in the request must support the multi-tenant\n configuration. If you attempt to enable the multi-tenant configuration on a DB\n engine that doesn't support it, the request fails.

    \n
  • \n
  • \n

    If you specify the multi-tenant configuration when you create your DB instance,\n you can't later modify this DB instance to use the single-tenant configuration.

    \n
  • \n
" - } - }, "EngineLifecycleSupport": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

The life cycle type for this DB instance.

\n \n

By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. \n At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, \n creating the DB instance will fail if the DB major version is past its end of standard support date.

\n
\n

This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.

\n

You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, \n you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.

\n

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled\n

\n

Default: open-source-rds-extended-support\n

" } + }, + "MasterUserAuthenticationType": { + "target": "com.amazonaws.rds#MasterUserAuthenticationType", + "traits": { + "smithy.api#documentation": "

Specifies the authentication type for the master user. With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB instance.

\n

You can specify one of the following values:

\n
    \n
  • \n

    \n password - Use standard database authentication with a password.

    \n
  • \n
  • \n

    \n iam-db-auth - Use IAM database authentication for the master user.

    \n
  • \n
\n

This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines.

" + } } }, "traits": { @@ -5453,7 +5466,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica\n in the Amazon RDS User Guide.

\n

Amazon RDS for Db2 supports this operation for standby replicas. To create a standby\n replica for a DB instance running Db2, you must set ReplicaMode to\n mounted.

\n

Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance\n operation.

\n

RDS creates read replicas with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.

\n \n

Your source DB instance or cluster must have backup retention enabled.

\n
", + "smithy.api#documentation": "

Creates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica\n for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica\n in the Amazon RDS User Guide.

\n

Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance\n operation.

\n

RDS creates read replicas with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.

\n \n

Your source DB instance or cluster must have backup retention enabled.

\n
", "smithy.api#examples": [ { "title": "To create a DB instance read replica", @@ -5528,6 +5541,12 @@ "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.

" } }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the read replica.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora DB instances.

" + } + }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { @@ -5537,7 +5556,7 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this read replica DB\n instance.

\n

For the Db2 DB engine, if your source DB instance uses the Bring Your Own License\n model, then a custom parameter group must be associated with the replica. For a same\n Amazon Web Services Region replica, if you don't specify a custom parameter group, Amazon RDS\n associates the custom parameter group associated with the source DB instance. For a\n cross-Region replica, you must specify a custom parameter group. This custom parameter\n group must include your IBM Site ID and IBM Customer ID. For more information, see\n IBM IDs\n for Bring Your Own License for Db2.

\n

For Single-AZ or Multi-AZ DB instance read replica instances, if you don't specify a\n value for DBParameterGroupName, then Amazon RDS uses the\n DBParameterGroup of the source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.

\n

For Multi-AZ DB cluster same Region read replica instances, if you don't specify a\n value for DBParameterGroupName, then Amazon RDS uses the default\n DBParameterGroup.

\n

Specifying a parameter group for this operation is only supported for MySQL DB\n instances for cross-Region read replicas, for Multi-AZ DB cluster read replica\n instances, for Db2 DB instances, and for Oracle DB instances. It isn't supported for\n MySQL DB instances for same Region read replicas or for RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
  • \n
  • \n

    First character must be a letter.

    \n
  • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
  • \n
" + "smithy.api#documentation": "

The name of the DB parameter group to associate with this read replica DB\n instance.

\n

For the Db2 DB engine, if your source DB instance uses the bring your own license\n (BYOL) model, then a custom parameter group must be associated with the replica. For a\n same Amazon Web Services Region replica, if you don't specify a custom parameter group, Amazon RDS\n associates the custom parameter group associated with the source DB instance. For a\n cross-Region replica, you must specify a custom parameter group. This custom parameter\n group must include your IBM Site ID and IBM Customer ID. For more information, see\n IBM IDs\n for bring your own license (BYOL) for Db2.

\n

For Single-AZ or Multi-AZ DB instance read replica instances, if you don't specify a\n value for DBParameterGroupName, then Amazon RDS uses the\n DBParameterGroup of the source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.

\n

For Multi-AZ DB cluster same Region read replica instances, if you don't specify a\n value for DBParameterGroupName, then Amazon RDS uses the default\n DBParameterGroup.

\n

Specifying a parameter group for this operation is only supported for MySQL DB\n instances for cross-Region read replicas, for Multi-AZ DB cluster read replica\n instances, for Db2 DB instances, and for Oracle DB instances. It isn't supported for\n MySQL DB instances for same Region read replicas or for RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
  • \n
  • \n

    First character must be a letter.

    \n
  • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
  • \n
" } }, "PubliclyAccessible": { @@ -5592,7 +5611,7 @@ } }, "PreSignedUrl": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

\n

This setting applies only when replicating from a source DB\n instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.

\n

You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:

\n
    \n
  • \n

    \n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica operation is called that contains\n this presigned URL.

    \n

    For example, if you create an encrypted DB instance in the us-west-1\n Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you\n call the CreateDBInstanceReadReplica operation in the us-east-1\n Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica operation in the us-west-2\n Amazon Web Services Region. For this example, the DestinationRegion in the\n presigned URL must be set to the us-east-1 Amazon Web Services Region.

    \n
  • \n
  • \n

    \n KmsKeyId - The KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica operation that\n is called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.

    \n
  • \n
  • \n

    \n SourceDBInstanceIdentifier - The DB instance identifier for the\n encrypted DB instance to be replicated. This identifier must be in the Amazon\n Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are\n creating an encrypted read replica from a DB instance in the us-west-2\n Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

    \n
  • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n
\n

This setting doesn't apply to RDS Custom DB instances.

" } @@ -5690,19 +5709,13 @@ "ReplicaMode": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { - "smithy.api#documentation": "

The open mode of the replica database.

\n \n

This parameter is only supported for Db2 DB instances and Oracle DB\n instances.

\n
\n
\n
Db2
\n
\n

Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2\n Standard Edition (SE). The main use case for standby replicas is\n cross-Region disaster recovery. Because it doesn't accept user\n connections, a standby replica can't serve a read-only workload.

\n

You can create a combination of standby and read-only DB replicas for the\n same primary DB instance. For more information, see Working with read\n replicas for Amazon RDS for Db2 in the Amazon RDS User\n Guide.

\n

To create standby DB replicas for RDS for Db2, set this parameter to\n mounted.

\n
\n
Oracle
\n
\n

Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.

\n

You can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with read replicas for Amazon RDS for Oracle \n in the Amazon RDS User Guide.

\n

For RDS Custom, you must specify this parameter and set it to\n mounted. The value won't be set by default. After replica\n creation, you can manage the open mode manually.

\n
\n
" - } - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

The open mode of the replica database.

\n

This parameter is only supported for Db2 DB instances and Oracle DB\n instances.

\n
\n
Db2
\n
\n

Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2\n Standard Edition (SE). The main use case for standby replicas is\n cross-Region disaster recovery. Because it doesn't accept user\n connections, a standby replica can't serve a read-only workload.

\n

You can create a combination of standby and read-only DB replicas for the\n same primary DB instance. For more information, see Working with replicas for Amazon RDS for Db2 in the Amazon RDS User\n Guide.

\n

To create standby DB replicas for RDS for Db2, set this parameter to\n mounted.

\n
\n
Oracle
\n
\n

Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.

\n

You can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with read replicas for Amazon RDS for Oracle \n in the Amazon RDS User Guide.

\n

For RDS Custom, you must specify this parameter and set it to\n mounted. The value won't be set by default. After replica\n creation, you can manage the open mode manually.

\n
\n
" } }, - "CustomIamInstanceProfile": { - "target": "com.amazonaws.rds#String", + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
  • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
  • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
  • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom DB instances.

" + "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts read replica.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the read replica from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, "NetworkType": { @@ -5711,22 +5724,22 @@ "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
  • \n
  • \n

    \n DUAL\n

    \n
  • \n
\n

The network type is determined by the DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } }, - "StorageThroughput": { + "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the read replica.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora DB instances.

" + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" } }, - "EnableCustomerOwnedIp": { - "target": "com.amazonaws.rds#BooleanOptional", + "BackupTarget": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts read replica.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the read replica from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + "smithy.api#documentation": "

The location where RDS stores automated backups and manual snapshots.

\n

Valid Values:

\n
    \n
  • \n

    \n local for Dedicated Local Zones

    \n
  • \n
  • \n

    \n region for Amazon Web Services Region

    \n
  • \n
" } }, - "BackupTarget": { + "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The location where RDS stores automated backups and manual snapshots.

\n

Valid Values:

\n
    \n
  • \n

    \n local for Dedicated Local Zones

    \n
  • \n
  • \n

    \n region for Amazon Web Services Region

    \n
  • \n
" + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
  • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
  • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
  • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom DB instances.

" } }, "AllocatedStorage": { @@ -5968,6 +5981,12 @@ }, "Tags": { "target": "com.amazonaws.rds#TagList" + }, + "EndpointNetworkType": { + "target": "com.amazonaws.rds#EndpointNetworkType", + "traits": { + "smithy.api#documentation": "

The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4 - The proxy endpoint supports IPv4 only.

    \n
  • \n
  • \n

    \n IPV6 - The proxy endpoint supports IPv6 only.

    \n
  • \n
  • \n

    \n DUAL - The proxy endpoint supports both IPv4 and IPv6.

    \n
  • \n
\n

Default: IPV4\n

\n

Constraints:

\n
    \n
  • \n

    If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.

    \n
  • \n
  • \n

    If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.

    \n
  • \n
" + } } }, "traits": { @@ -5992,7 +6011,7 @@ "type": "structure", "members": { "DBProxyName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

", @@ -6007,16 +6026,20 @@ "smithy.api#required": {} } }, + "DefaultAuthScheme": { + "target": "com.amazonaws.rds#DefaultAuthScheme", + "traits": { + "smithy.api#documentation": "

The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. \n Valid values are NONE and IAM_AUTH. \n When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database. \n If you don't specify DefaultAuthScheme or specify this parameter \n as NONE, you must specify the Auth option.

" + } + }, "Auth": { "target": "com.amazonaws.rds#UserAuthConfigList", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The authorization mechanism that the proxy uses.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The authorization mechanism that the proxy uses.

" } }, "RoleArn": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#Arn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

", @@ -6052,7 +6075,7 @@ "DebugLogging": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" + "smithy.api#documentation": "

Specifies whether the proxy logs detailed connection and query information. \n When you enable DebugLogging, the proxy captures connection details \n and connection pool behavior from your queries. Debug logging increases CloudWatch costs \n and can impact proxy performance. Enable this option only when you need \n to troubleshoot connection or performance issues.

" } }, "Tags": { @@ -6060,6 +6083,18 @@ "traits": { "smithy.api#documentation": "

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

" } + }, + "EndpointNetworkType": { + "target": "com.amazonaws.rds#EndpointNetworkType", + "traits": { + "smithy.api#documentation": "

The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4 - The proxy endpoint supports IPv4 only.

    \n
  • \n
  • \n

    \n IPV6 - The proxy endpoint supports IPv6 only.

    \n
  • \n
  • \n

    \n DUAL - The proxy endpoint supports both IPv4 and IPv6.

    \n
  • \n
\n

Default: IPV4\n

\n

Constraints:

\n
    \n
  • \n

    If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.

    \n
  • \n
  • \n

    If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.

    \n
  • \n
" + } + }, + "TargetConnectionNetworkType": { + "target": "com.amazonaws.rds#TargetConnectionNetworkType", + "traits": { + "smithy.api#documentation": "

The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4 - The proxy connects to the database using IPv4 only.

    \n
  • \n
  • \n

    \n IPV6 - The proxy connects to the database using IPv6 only.

    \n
  • \n
\n

Default: IPV4\n

\n

Constraints:

\n
    \n
  • \n

    If you specify IPV6, the database must support dual-stack mode. RDS doesn't support IPv6-only databases.

    \n
  • \n
  • \n

    All targets registered with the proxy must be compatible with the specified network type.

    \n
  • \n
" + } } }, "traits": { @@ -6623,6 +6658,12 @@ }, { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBShardGroupStateFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" } ], "traits": { @@ -6656,9 +6697,11 @@ "type": "structure", "members": { "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#GlobalClusterIdentifier", "traits": { - "smithy.api#documentation": "

The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.

" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} } }, "SourceDBClusterIdentifier": { @@ -7241,12 +7284,6 @@ "smithy.api#documentation": "

The current state of this DB cluster.

" } }, - "AutomaticRestartTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time when a stopped DB cluster is restarted automatically.

" - } - }, "PercentProgress": { "target": "com.amazonaws.rds#String", "traits": { @@ -7445,6 +7482,12 @@ "smithy.api#documentation": "

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) \n when the cluster is paused.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" } }, + "PendingModifiedValues": { + "target": "com.amazonaws.rds#ClusterPendingModifiedValues", + "traits": { + "smithy.api#documentation": "

Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

" + } + }, "EngineMode": { "target": "com.amazonaws.rds#String", "traits": { @@ -7460,6 +7503,48 @@ "smithy.api#documentation": "

Reserved for future use.

" } }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the compute and memory capacity class of the DB instance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type associated with the DB cluster.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "IOOptimizedNextAllowedModificationTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

\n

This setting is only for Aurora DB clusters.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), \n its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, \n the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBCluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

\n

This setting is for Aurora DB clusters and Multi-AZ DB clusters.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" + } + }, "DeletionProtection": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { @@ -7535,40 +7620,25 @@ "smithy.api#documentation": "

Indicates whether write forwarding is enabled for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.

" } }, - "PendingModifiedValues": { - "target": "com.amazonaws.rds#ClusterPendingModifiedValues", - "traits": { - "smithy.api#documentation": "

Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

" - } - }, - "DBClusterInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity class of the DB instance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "StorageType": { + "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The storage type associated with the DB cluster.

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

This setting is only for Aurora DB clusters.

\n

Valid Values: IPV4 | DUAL\n

" } }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", + "AutomaticRestartTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

The time when a stopped DB cluster is restarted automatically.

" } }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), \n its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, \n the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBCluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo" }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", + "ServerlessV2PlatformVersion": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

\n

This setting is for Aurora DB clusters and Multi-AZ DB clusters.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" + "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.

" } }, "MonitoringInterval": { @@ -7607,21 +7677,6 @@ "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
  • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
  • \n
  • \n

    \n 731\n

    \n
  • \n
\n

Default: 7 days

" } }, - "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": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

This setting is only for Aurora DB clusters.

\n

Valid Values: IPV4 | DUAL\n

" - } - }, "DBSystemId": { "target": "com.amazonaws.rds#String", "traits": { @@ -7634,12 +7689,6 @@ "smithy.api#documentation": "

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

" } }, - "IOOptimizedNextAllowedModificationTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

\n

This setting is only for Aurora DB clusters.

" - } - }, "LocalWriteForwardingStatus": { "target": "com.amazonaws.rds#LocalWriteForwardingStatus", "traits": { @@ -7658,12 +7707,6 @@ "smithy.api#documentation": "

The details for Aurora Limitless Database.

" } }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, "ClusterScalabilityType": { "target": "com.amazonaws.rds#ClusterScalabilityType", "traits": { @@ -7839,17 +7882,17 @@ "smithy.api#documentation": "

The IOPS (I/O operations per second) value for the automated backup.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, - "AwsBackupRecoveryPointArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" - } - }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { "smithy.api#documentation": "

The storage throughput for the automated backup. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } + }, + "AwsBackupRecoveryPointArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" + } } }, "traits": { @@ -8668,16 +8711,16 @@ "TagList": { "target": "com.amazonaws.rds#TagList" }, - "DBSystemId": { + "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Reserved for future use.

" + "smithy.api#documentation": "

The storage type associated with the DB cluster snapshot.

\n

This setting is only for Aurora DB clusters.

" } }, - "StorageType": { - "target": "com.amazonaws.rds#String", + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The storage type associated with the DB cluster snapshot.

\n

This setting is only for Aurora DB clusters.

" + "smithy.api#documentation": "

The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "DbClusterResourceId": { @@ -8686,10 +8729,10 @@ "smithy.api#documentation": "

The resource ID of the DB cluster that this DB cluster snapshot was created from.

" } }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", + "DBSystemId": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

Reserved for future use.

" } } }, @@ -8860,12 +8903,36 @@ "smithy.api#documentation": "

The name of the database engine.

" } }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The major engine version of the CEV.

" + } + }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

The version number of the database engine.

" } }, + "DatabaseInstallationFilesS3BucketName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains your database installation files.

" + } + }, + "DatabaseInstallationFilesS3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 directory that contains the database installation files. \n If not specified, then no prefix is assumed.

" + } + }, + "CustomDBEngineVersionManifest": { + "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", + "traits": { + "smithy.api#documentation": "

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). \n RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, \n and UNIX/Linux user and group using the installation parameters. For more information, \n see JSON fields in the CEV manifest in the Amazon RDS User Guide.\n

" + } + }, "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { @@ -8878,6 +8945,12 @@ "smithy.api#documentation": "

The description of the database engine.

" } }, + "DBEngineVersionArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN of the custom engine version.

" + } + }, "DBEngineVersionDescription": { "target": "com.amazonaws.rds#String", "traits": { @@ -8902,6 +8975,18 @@ "smithy.api#documentation": "

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

" } }, + "KMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for \n RDS Custom, but optional for Amazon RDS.

" + } + }, + "CreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The creation time of the DB engine version.

" + } + }, "SupportedCharacterSets": { "target": "com.amazonaws.rds#SupportedCharacterSetsList", "traits": { @@ -8951,63 +9036,27 @@ } }, "SupportedFeatureNames": { - "target": "com.amazonaws.rds#FeatureNameList", - "traits": { - "smithy.api#documentation": "

A list of features supported by the DB engine.

\n

The supported features vary by DB engine and DB engine version.

\n

To determine the supported features for a specific DB engine and DB engine version using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine --engine-version \n

\n

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --engine-version 13.3\n

\n

The supported features are listed under SupportedFeatureNames in the output.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the DB engine version, either available or deprecated.

" - } - }, - "SupportsParallelQuery": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether you can use Aurora parallel query with a specific DB engine version.

" - } - }, - "SupportsGlobalDatabases": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether you can use Aurora global databases with a specific DB engine version.

" - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The major engine version of the CEV.

" - } - }, - "DatabaseInstallationFilesS3BucketName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains your database installation files.

" - } - }, - "DatabaseInstallationFilesS3Prefix": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#FeatureNameList", "traits": { - "smithy.api#documentation": "

The Amazon S3 directory that contains the database installation files. \n If not specified, then no prefix is assumed.

" + "smithy.api#documentation": "

A list of features supported by the DB engine.

\n

The supported features vary by DB engine and DB engine version.

\n

To determine the supported features for a specific DB engine and DB engine version using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine --engine-version \n

\n

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --engine-version 13.3\n

\n

The supported features are listed under SupportedFeatureNames in the output.

" } }, - "DBEngineVersionArn": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ARN of the custom engine version.

" + "smithy.api#documentation": "

The status of the DB engine version, either available or deprecated.

" } }, - "KMSKeyId": { - "target": "com.amazonaws.rds#String", + "SupportsParallelQuery": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for \n RDS Custom, but optional for Amazon RDS.

" + "smithy.api#documentation": "

Indicates whether you can use Aurora parallel query with a specific DB engine version.

" } }, - "CreateTime": { - "target": "com.amazonaws.rds#TStamp", + "SupportsGlobalDatabases": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

The creation time of the DB engine version.

" + "smithy.api#documentation": "

Indicates whether you can use Aurora global databases with a specific DB engine version.

" } }, "TagList": { @@ -9019,12 +9068,6 @@ "smithy.api#documentation": "

Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

" } }, - "CustomDBEngineVersionManifest": { - "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", - "traits": { - "smithy.api#documentation": "

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). \n RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, \n and UNIX/Linux user and group using the installation parameters. For more information, \n see JSON fields in the CEV manifest in the Amazon RDS User Guide.\n

" - } - }, "SupportsLimitlessDatabase": { "target": "com.amazonaws.rds#Boolean", "traits": { @@ -9123,12 +9166,6 @@ "smithy.api#documentation": "

The current state of this database.

\n

For information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n

" } }, - "AutomaticRestartTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time when a stopped DB instance is restarted automatically.

" - } - }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { @@ -9258,7 +9295,7 @@ "ReplicaMode": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { - "smithy.api#documentation": "

The open mode of a Db2 or an Oracle read replica. The default is\n open-read-only. For more information, see Working with read replicas for\n Amazon RDS for Db2 and Working with read replicas\n for Amazon RDS for Oracle in the Amazon RDS User Guide.

\n \n

This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom\n for Oracle.

\n
" + "smithy.api#documentation": "

The open mode of a Db2 or an Oracle read replica. The default is\n open-read-only. For more information, see Working with replicas for\n Amazon RDS for Db2 and Working with read\n replicas for Amazon RDS for Oracle in the Amazon RDS User\n Guide.

\n \n

This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom\n for Oracle.

\n
" } }, "LicenseModel": { @@ -9273,6 +9310,12 @@ "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value for the DB instance.

" } }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput for the DB instance.

\n

This setting applies only to the gp3 storage type.

" + } + }, "OptionGroupMemberships": { "target": "com.amazonaws.rds#OptionGroupMembershipList", "traits": { @@ -9474,10 +9517,16 @@ "TagList": { "target": "com.amazonaws.rds#TagList" }, - "DBInstanceAutomatedBackupsReplications": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", + "AutomationMode": { + "target": "com.amazonaws.rds#AutomationMode", "traits": { - "smithy.api#documentation": "

The list of replicated automated backups associated with the DB instance.

" + "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n --resume-full-automation-mode-minutes.

" + } + }, + "ResumeFullAutomationModeTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" } }, "CustomerOwnedIpEnabled": { @@ -9486,10 +9535,10 @@ "smithy.api#documentation": "

Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, - "AwsBackupRecoveryPointArn": { + "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" } }, "ActivityStreamStatus": { @@ -9522,34 +9571,34 @@ "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" } }, - "AutomationMode": { - "target": "com.amazonaws.rds#AutomationMode", + "AwsBackupRecoveryPointArn": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n --resume-full-automation-mode-minutes.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" } }, - "ResumeFullAutomationModeTime": { - "target": "com.amazonaws.rds#TStamp", + "DBInstanceAutomatedBackupsReplications": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", "traits": { - "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" + "smithy.api#documentation": "

The list of replicated automated backups associated with the DB instance.

" } }, - "CustomIamInstanceProfile": { + "BackupTarget": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
  • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
  • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
  • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

The location where automated backups and manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

" } }, - "BackupTarget": { - "target": "com.amazonaws.rds#String", + "AutomaticRestartTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

The location where automated backups and manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

" + "smithy.api#documentation": "

The time when a stopped DB instance is restarted automatically.

" } }, - "NetworkType": { + "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
  • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
  • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
  • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

" } }, "ActivityStreamPolicyStatus": { @@ -9558,10 +9607,10 @@ "smithy.api#documentation": "

The status of the policy state of the activity stream.

" } }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", + "CertificateDetails": { + "target": "com.amazonaws.rds#CertificateDetails", "traits": { - "smithy.api#documentation": "

The storage throughput for the DB instance.

\n

This setting applies only to the gp3 storage type.

" + "smithy.api#documentation": "

The details of the DB instance's server certificate.

" } }, "DBSystemId": { @@ -9576,12 +9625,6 @@ "smithy.api#documentation": "

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

" } }, - "CertificateDetails": { - "target": "com.amazonaws.rds#CertificateDetails", - "traits": { - "smithy.api#documentation": "

The details of the DB instance's server certificate.

" - } - }, "ReadReplicaSourceDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { @@ -9594,6 +9637,12 @@ "smithy.api#documentation": "

The progress of the storage optimization operation as a percentage.

" } }, + "MultiTenant": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the\n single-tenant configuration (FALSE).

" + } + }, "DedicatedLogVolume": { "target": "com.amazonaws.rds#Boolean", "traits": { @@ -9606,12 +9655,6 @@ "smithy.api#documentation": "

Indicates whether an upgrade is recommended for the storage file system configuration\n on the DB instance. To migrate to the preferred configuration, you can either create a\n blue/green deployment, or create a read replica from the DB instance. For more\n information, see Upgrading the storage file system for a DB instance.

" } }, - "MultiTenant": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the\n single-tenant configuration (FALSE).

" - } - }, "EngineLifecycleSupport": { "target": "com.amazonaws.rds#String", "traits": { @@ -9739,6 +9782,12 @@ "smithy.api#documentation": "

The IOPS (I/O operations per second) value for the automated backup.

" } }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput for the automated backup.

" + } + }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { @@ -9805,10 +9854,10 @@ "smithy.api#documentation": "

The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

" } }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", + "MultiTenant": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

The storage throughput for the automated backup.

" + "smithy.api#documentation": "

Specifies whether the automatic backup is for a DB instance in the multi-tenant\n configuration (TRUE) or the single-tenant configuration (FALSE).

" } }, "AwsBackupRecoveryPointArn": { @@ -9822,12 +9871,6 @@ "traits": { "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" } - }, - "MultiTenant": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the automatic backup is for a DB instance in the multi-tenant\n configuration (TRUE) or the single-tenant configuration (FALSE).

" - } } }, "traits": { @@ -9978,11 +10021,11 @@ "traits": { "aws.protocols#awsQueryError": { "code": "DBInstanceNotReady", - "httpResponseCode": 503 + "httpResponseCode": 400 }, "smithy.api#documentation": "

An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused.

", - "smithy.api#error": "server", - "smithy.api#httpError": 503 + "smithy.api#error": "client", + "smithy.api#httpError": 400 } }, "com.amazonaws.rds#DBInstanceRole": { @@ -10385,6 +10428,12 @@ "smithy.api#documentation": "

The EC2 subnet IDs for the proxy.

" } }, + "DefaultAuthScheme": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. \n Valid values are NONE and IAM_AUTH. \n When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database. \n

" + } + }, "Auth": { "target": "com.amazonaws.rds#UserAuthConfigInfoList", "traits": { @@ -10418,7 +10467,7 @@ "DebugLogging": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" + "smithy.api#documentation": "

Specifies whether the proxy logs detailed connection and query information. \n When you enable DebugLogging, the proxy captures connection details \n and connection pool behavior from your queries. Debug logging increases CloudWatch costs \n and can impact proxy performance. Enable this option only when you need \n to troubleshoot connection or performance issues.

" } }, "CreatedDate": { @@ -10432,6 +10481,18 @@ "traits": { "smithy.api#documentation": "

The date and time when the proxy was last updated.

" } + }, + "EndpointNetworkType": { + "target": "com.amazonaws.rds#EndpointNetworkType", + "traits": { + "smithy.api#documentation": "

The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4 - The proxy endpoint supports IPv4 only.

    \n
  • \n
  • \n

    \n IPV6 - The proxy endpoint supports IPv6 only.

    \n
  • \n
  • \n

    \n DUAL - The proxy endpoint supports both IPv4 and IPv6.

    \n
  • \n
" + } + }, + "TargetConnectionNetworkType": { + "target": "com.amazonaws.rds#TargetConnectionNetworkType", + "traits": { + "smithy.api#documentation": "

The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4 - The proxy connects to the database using IPv4 only.

    \n
  • \n
  • \n

    \n IPV6 - The proxy connects to the database using IPv6 only.

    \n
  • \n
" + } } }, "traits": { @@ -10523,6 +10584,12 @@ "traits": { "smithy.api#documentation": "

Indicates whether this endpoint is the default endpoint for the associated DB proxy.\n Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\n DB proxy can be either read/write or read-only.

" } + }, + "EndpointNetworkType": { + "target": "com.amazonaws.rds#EndpointNetworkType", + "traits": { + "smithy.api#documentation": "

The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4 - The proxy endpoint supports IPv4 only.

    \n
  • \n
  • \n

    \n IPV6 - The proxy endpoint supports IPv6 only.

    \n
  • \n
  • \n

    \n DUAL - The proxy endpoint supports both IPv4 and IPv6.

    \n
  • \n
" + } } }, "traits": { @@ -10559,7 +10626,7 @@ "min": 1, "max": 63 }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + "smithy.api#pattern": "^[a-zA-Z](?:-?[a-zA-Z0-9]+)*$" } }, "com.amazonaws.rds#DBProxyEndpointNotFoundFault": { @@ -10667,7 +10734,7 @@ "min": 1, "max": 63 }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + "smithy.api#pattern": "^[a-zA-Z](?:-?[a-zA-Z0-9]+)*$" } }, "com.amazonaws.rds#DBProxyNotFoundFault": { @@ -10892,6 +10959,16 @@ "smithy.api#documentation": "

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group\n is associated with exactly one RDS DB instance or Aurora DB cluster.

\n

This data type is used as a response element in the DescribeDBProxyTargetGroups action.

" } }, + "com.amazonaws.rds#DBProxyTargetGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z](?:-?[a-zA-Z0-9]+)*$" + } + }, "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault": { "type": "structure", "members": { @@ -11372,7 +11449,7 @@ "min": 1, "max": 63 }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + "smithy.api#pattern": "^[a-zA-Z](?:-?[a-zA-Z0-9]+)*$" } }, "com.amazonaws.rds#DBShardGroupNotFoundFault": { @@ -11494,6 +11571,12 @@ "smithy.api#documentation": "

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

" } }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput for the DB snapshot.

" + } + }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { @@ -11575,6 +11658,12 @@ "TagList": { "target": "com.amazonaws.rds#TagList" }, + "SnapshotTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

" + } + }, "OriginalSnapshotCreateTime": { "target": "com.amazonaws.rds#TStamp", "traits": { @@ -11587,22 +11676,16 @@ "smithy.api#documentation": "

The timestamp of the most recent transaction applied to the database that you're backing up. \n Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. \n In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

\n

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime \n with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than \n SnapshotDatabaseTime, then the replica lag is two hours.

" } }, - "SnapshotTarget": { + "DBSystemId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput for the DB snapshot.

" + "smithy.api#documentation": "

The Oracle system identifier (SID), which is the name of the Oracle database instance that \n manages your database files. The Oracle SID is also the name of your CDB.

" } }, - "DBSystemId": { - "target": "com.amazonaws.rds#String", + "MultiTenant": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

The Oracle system identifier (SID), which is the name of the Oracle database instance that \n manages your database files. The Oracle SID is also the name of your CDB.

" + "smithy.api#documentation": "

Indicates whether the snapshot is of a DB instance using the multi-tenant\n configuration (TRUE) or the single-tenant configuration (FALSE).

" } }, "DedicatedLogVolume": { @@ -11611,12 +11694,6 @@ "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" } }, - "MultiTenant": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether the snapshot is of a DB instance using the multi-tenant\n configuration (TRUE) or the single-tenant configuration (FALSE).

" - } - }, "SnapshotAvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { @@ -12106,6 +12183,23 @@ } } }, + "com.amazonaws.rds#DefaultAuthScheme": { + "type": "enum", + "members": { + "IAM_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_AUTH" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, "com.amazonaws.rds#DeleteBlueGreenDeployment": { "type": "operation", "input": { @@ -12227,6 +12321,12 @@ { "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, { "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" } @@ -12572,6 +12672,9 @@ { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, { "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" } @@ -12849,7 +12952,7 @@ "type": "structure", "members": { "DBProxyName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the DB proxy to delete.

", @@ -13216,7 +13319,7 @@ "type": "structure", "members": { "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#GlobalClusterIdentifier", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The cluster identifier of the global database cluster being deleted.

", @@ -13355,6 +13458,9 @@ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, + { + "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" + }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, @@ -13443,7 +13549,7 @@ "type": "structure", "members": { "DBProxyName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

", @@ -13451,7 +13557,7 @@ } }, "TargetGroupName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyTargetGroupName", "traits": { "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup.

" } @@ -15741,7 +15847,7 @@ "type": "structure", "members": { "DBProxyName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyName", "traits": { "smithy.api#documentation": "

The name of the DB proxy. If you omit this parameter,\n the output includes information about all DB proxies owned by\n your Amazon Web Services account ID.

" } @@ -15906,7 +16012,7 @@ "type": "structure", "members": { "DBProxyName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The identifier of the DBProxy associated with the target group.

", @@ -15914,7 +16020,7 @@ } }, "TargetGroupName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyTargetGroupName", "traits": { "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup to describe.

" } @@ -15998,7 +16104,7 @@ "type": "structure", "members": { "DBProxyName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The identifier of the DBProxyTarget to describe.

", @@ -16006,7 +16112,7 @@ } }, "TargetGroupName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyTargetGroupName", "traits": { "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup to describe.

" } @@ -17372,7 +17478,7 @@ "type": "structure", "members": { "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#GlobalClusterIdentifier", "traits": { "smithy.api#documentation": "

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DBClusterIdentifier.

    \n
  • \n
" } @@ -18786,7 +18892,7 @@ "type": "structure", "members": { "LogFileData": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

Entries from the specified log file.

" } @@ -18994,6 +19100,29 @@ "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon RDS DB instance.\n This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n CreateDBInstance\n

    \n
  • \n
  • \n

    \n DescribeDBInstances\n

    \n
  • \n
  • \n

    \n DeleteDBInstance\n

    \n
  • \n
\n

For the data structure that represents Amazon Aurora DB cluster endpoints,\n see DBClusterEndpoint.

" } }, + "com.amazonaws.rds#EndpointNetworkType": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4" + } + }, + "IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV6" + } + }, + "DUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUAL" + } + } + } + }, "com.amazonaws.rds#Engine": { "type": "string", "traits": { @@ -19737,7 +19866,7 @@ "type": "structure", "members": { "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#GlobalClusterIdentifier", "traits": { "smithy.api#documentation": "

Contains a user-supplied global database cluster identifier. This identifier is the unique key that\n identifies a global database cluster.

" } @@ -19745,7 +19874,7 @@ "GlobalClusterResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in\n Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

" + "smithy.api#documentation": "

The Amazon Web Services partition-unique, immutable identifier for the global database cluster. This identifier is found in\n Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

" } }, "GlobalClusterArn": { @@ -20201,28 +20330,28 @@ "Tags": { "target": "com.amazonaws.rds#TagList" }, - "CreateTime": { - "target": "com.amazonaws.rds#TStamp", + "DataFilter": { + "target": "com.amazonaws.rds#DataFilter", "traits": { - "smithy.api#documentation": "

The time when the integration was created, in Universal Coordinated Time\n (UTC).

" + "smithy.api#documentation": "

Data filters for the integration. These filters determine which tables\n from the source database are sent to the target Amazon Redshift data warehouse. \n

" } }, - "Errors": { - "target": "com.amazonaws.rds#IntegrationErrorList", + "Description": { + "target": "com.amazonaws.rds#IntegrationDescription", "traits": { - "smithy.api#documentation": "

Any errors associated with the integration.

" + "smithy.api#documentation": "

A description of the integration.

" } }, - "DataFilter": { - "target": "com.amazonaws.rds#DataFilter", + "CreateTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

Data filters for the integration. These filters determine which tables\n from the source database are sent to the target Amazon Redshift data warehouse. \n

" + "smithy.api#documentation": "

The time when the integration was created, in Universal Coordinated Time\n (UTC).

" } }, - "Description": { - "target": "com.amazonaws.rds#IntegrationDescription", + "Errors": { + "target": "com.amazonaws.rds#IntegrationErrorList", "traits": { - "smithy.api#documentation": "

A description of the integration.

" + "smithy.api#documentation": "

Any errors associated with the integration.

" } } }, @@ -20341,7 +20470,7 @@ "min": 1, "max": 63 }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + "smithy.api#pattern": "^[a-zA-Z](?:-?[a-zA-Z0-9]+)*$" } }, "com.amazonaws.rds#IntegrationNotFoundFault": { @@ -21090,12 +21219,18 @@ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, + { + "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" + }, { "target": "com.amazonaws.rds#DBProxyNotFoundFault" }, { "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" }, + { + "target": "com.amazonaws.rds#DBShardGroupNotFoundFault" + }, { "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" }, @@ -21222,6 +21357,23 @@ } } }, + "com.amazonaws.rds#MasterUserAuthenticationType": { + "type": "enum", + "members": { + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "password" + } + }, + "IAM_DB_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "iam-db-auth" + } + } + } + }, "com.amazonaws.rds#MasterUserSecret": { "type": "structure", "members": { @@ -21688,6 +21840,9 @@ { "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, { "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, @@ -21706,12 +21861,21 @@ { "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + }, { "target": "com.amazonaws.rds#InvalidSubnet" }, { "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, @@ -21720,6 +21884,9 @@ }, { "target": "com.amazonaws.rds#StorageTypeNotAvailableFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" } ], "traits": { @@ -21935,7 +22102,7 @@ } }, "MasterUserPassword": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

The new password for the master database user.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must contain from 8 to 41 characters.

    \n
  • \n
  • \n

    Can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n
  • \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
  • \n
" } @@ -22066,6 +22233,15 @@ "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters.

\n

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

" } }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: IPV4 | DUAL\n

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { @@ -22081,7 +22257,7 @@ "DatabaseInsightsMode": { "target": "com.amazonaws.rds#DatabaseInsightsMode", "traits": { - "smithy.api#documentation": "

Specifies the mode of Database Insights to enable for the DB cluster.

\n

If you change the value from standard to advanced, you must set the \n PerformanceInsightsEnabled parameter to true and the \n PerformanceInsightsRetentionPeriod parameter to 465.

\n

If you change the value from advanced to standard, you must \n set the PerformanceInsightsEnabled parameter to false.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies the mode of Database Insights to enable for the DB cluster.

\n

If you change the value from standard to advanced, you must set the \n PerformanceInsightsEnabled parameter to true and the \n PerformanceInsightsRetentionPeriod parameter to 465.

\n

If you change the value from advanced to standard, you can set the PerformanceInsightsEnabled parameter to true to collect detailed database counter and per-query metrics.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } }, "EnablePerformanceInsights": { @@ -22102,15 +22278,6 @@ "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
  • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
  • \n
  • \n

    \n 731\n

    \n
  • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

" } }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: IPV4 | DUAL\n

" - } - }, "ManageMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { @@ -22123,6 +22290,12 @@ "smithy.api#documentation": "

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    You must apply the change immediately when rotating the master user password.

    \n
  • \n
" } }, + "EnableLocalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\n default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" + } + }, "MasterUserSecretKmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { @@ -22141,12 +22314,6 @@ "smithy.api#documentation": "

Specifies whether engine mode changes from serverless to provisioned \n are allowed.

\n

Valid for Cluster Type: Aurora Serverless v1 DB clusters only

\n

Constraints:

\n
    \n
  • \n

    You must allow engine mode changes when specifying a different value for the EngineMode parameter\n from the DB cluster's current engine mode.

    \n
  • \n
" } }, - "EnableLocalWriteForwarding": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\n default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" - } - }, "AwsBackupRecoveryPointArn": { "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", "traits": { @@ -22164,6 +22331,12 @@ "traits": { "smithy.api#documentation": "

The CA certificate identifier to use for the DB cluster's server certificate.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters

" } + }, + "MasterUserAuthenticationType": { + "target": "com.amazonaws.rds#MasterUserAuthenticationType", + "traits": { + "smithy.api#documentation": "

Specifies the authentication type for the master user. With IAM master user authentication, you can change the master DB user to use IAM database authentication.

\n

You can specify one of the following values:

\n
    \n
  • \n

    \n password - Use standard database authentication with a password.

    \n
  • \n
  • \n

    \n iam-db-auth - Use IAM database authentication for the master user.

    \n
  • \n
\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines.

" + } } }, "traits": { @@ -22518,7 +22691,7 @@ } }, "MasterUserPassword": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

The new password for the master user.

\n

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n \n

Amazon RDS API operations never return the password, \n so this operation provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

\n
\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora

    \n

    The password for the master user is managed by the DB cluster. For more\n information, see ModifyDBCluster.

    \n
  • \n
  • \n

    RDS Custom

    \n
  • \n
  • \n

    RDS for Oracle CDBs in the multi-tenant configuration

    \n

    Specify the master password in ModifyTenantDatabase\n instead.

    \n
  • \n
\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
  • \n
  • \n

    Can include any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't include the \"&\" (ampersand) or the \"'\" (single quotes) character.

    \n
  • \n
\n

Length Constraints:

\n
    \n
  • \n

    RDS for Db2 - Must contain from 8 to 255 characters.

    \n
  • \n
  • \n

    RDS for MariaDB - Must contain from 8 to 41 characters.

    \n
  • \n
  • \n

    RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

    \n
  • \n
  • \n

    RDS for MySQL - Must contain from 8 to 41 characters.

    \n
  • \n
  • \n

    RDS for Oracle - Must contain from 8 to 30 characters.

    \n
  • \n
  • \n

    RDS for PostgreSQL - Must contain from 8 to 128 characters.

    \n
  • \n
" } @@ -22583,6 +22756,12 @@ "smithy.api#documentation": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

\n

Changing this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.

\n

If you choose to migrate your DB instance from using standard storage to Provisioned\n IOPS (io1), or from Provisioned IOPS to standard storage, the process can take time. The\n duration of the migration depends on several factors such as database load, storage\n size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any),\n and the number of prior scale storage operations. Typical migration times are under 24\n hours, but the process can take up to several days in some cases. During the migration,\n the DB instance is available for use, but might experience performance degradation.\n While the migration takes place, nightly backups for the instance are suspended. No\n other Amazon RDS operations can take place for the instance, including modifying the\n instance, rebooting the instance, deleting the instance, creating a read replica for the\n instance, and creating a DB snapshot of the instance.

\n

\n

Constraints:

\n
    \n
  • \n

    For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

    \n
  • \n
  • \n

    When you increase the Provisioned IOPS, you must also specify the\n AllocatedStorage parameter. You can use the current value for\n AllocatedStorage.

    \n
  • \n
\n

Default: Uses existing setting

" } }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" + } + }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { @@ -22608,7 +22787,7 @@ } }, "TdeCredentialPassword": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom DB instances.

" } @@ -22649,6 +22828,12 @@ "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
  • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" } }, + "DisableDomain": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to remove the DB instance from the Active Directory domain.

" + } + }, "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { @@ -22685,12 +22870,6 @@ "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, - "DisableDomain": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to remove the DB instance from the Active Directory domain.

" - } - }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { @@ -22766,19 +22945,7 @@ "ReplicaMode": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { - "smithy.api#documentation": "

The open mode of a replica database.

\n \n

This parameter is only supported for Db2 DB instances and Oracle DB\n instances.

\n
\n
\n
Db2
\n
\n

Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2\n Standard Edition (SE). The main use case for standby replicas is\n cross-Region disaster recovery. Because it doesn't accept user\n connections, a standby replica can't serve a read-only workload.

\n

You can create a combination of standby and read-only DB replicas for the\n same primary DB instance. For more information, see Working with read\n replicas for Amazon RDS for Db2 in the Amazon RDS User\n Guide.

\n

To create standby DB replicas for RDS for Db2, set this parameter to\n mounted.

\n
\n
Oracle
\n
\n

Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.

\n

You can create a combination of mounted and read-only DB replicas for the\n same primary DB instance. For more information, see Working with\n read replicas for Amazon RDS for Oracle in the Amazon\n RDS User Guide.

\n

For RDS Custom, you must specify this parameter and set it to\n mounted. The value won't be set by default. After replica\n creation, you can manage the open mode manually.

\n
\n
" - } - }, - "EnableCustomerOwnedIp": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" - } - }, - "AwsBackupRecoveryPointArn": { - "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

\n

This setting doesn't apply to RDS Custom DB instances.

" + "smithy.api#documentation": "

The open mode of a replica database.

\n

This parameter is only supported for Db2 DB instances and Oracle DB\n instances.

\n
\n
Db2
\n
\n

Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2\n Standard Edition (SE). The main use case for standby replicas is\n cross-Region disaster recovery. Because it doesn't accept user\n connections, a standby replica can't serve a read-only workload.

\n

You can create a combination of standby and read-only DB replicas for the\n same primary DB instance. For more information, see Working with\n replicas for Amazon RDS for Db2 in the Amazon RDS User\n Guide.

\n

To create standby DB replicas for RDS for Db2, set this parameter to\n mounted.

\n
\n
Oracle
\n
\n

Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.

\n

You can create a combination of mounted and read-only DB replicas for the\n same primary DB instance. For more information, see Working with\n read replicas for Amazon RDS for Oracle in the Amazon\n RDS User Guide.

\n

For RDS Custom, you must specify this parameter and set it to\n mounted. The value won't be set by default. After replica\n creation, you can manage the open mode manually.

\n
\n
" } }, "AutomationMode": { @@ -22790,7 +22957,13 @@ "ResumeFullAutomationModeMinutes": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes \n full automation.

\n

Default: 60\n

\n

Constraints:

\n
    \n
  • \n

    Must be at least 60.

    \n
  • \n
  • \n

    Must be no more than 1,440.

    \n
  • \n
" + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom\n resumes full automation.

\n

Default: 60\n

\n

Constraints:

\n
    \n
  • \n

    Must be at least 60.

    \n
  • \n
  • \n

    Must be no more than 1,440.

    \n
  • \n
" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, "NetworkType": { @@ -22799,10 +22972,10 @@ "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" } }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", + "AwsBackupRecoveryPointArn": { + "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", "traits": { - "smithy.api#documentation": "

The storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "ManageMasterUserPassword": { @@ -22823,10 +22996,10 @@ "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if both of the following conditions are met:

\n
    \n
  • \n

    The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.

    \n

    If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, \n you can't change the KMS key used to encrypt the secret.

    \n
  • \n
  • \n

    You are turning on ManageMasterUserPassword to manage the master user password \n in Amazon Web Services Secrets Manager.

    \n

    If you are turning on ManageMasterUserPassword and don't specify \n MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

    \n
  • \n
\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" } }, - "Engine": { - "target": "com.amazonaws.rds#String", + "MultiTenant": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB\n to an Oracle Database 21c CDB.

\n

Note the following requirements:

\n
    \n
  • \n

    Make sure that you specify oracle-ee-cdb or oracle-se2-cdb.

    \n
  • \n
  • \n

    Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.

    \n
  • \n
\n

Note the following limitations:

\n
    \n
  • \n

    You can't convert a CDB to a non-CDB.

    \n
  • \n
  • \n

    You can't convert a replica database.

    \n
  • \n
  • \n

    You can't convert a non-CDB to a CDB and upgrade the engine version in the\n same command.

    \n
  • \n
  • \n

    You can't convert the existing custom parameter or option group when it has\n options or parameters that are permanent or persistent. In this situation, the\n DB instance reverts to the default option and parameter group. To avoid\n reverting to the default, specify a new parameter group with\n --db-parameter-group-name and a new option group with\n --option-group-name.

    \n
  • \n
" + "smithy.api#documentation": "

Specifies whether the to convert your DB instance from the single-tenant configuration\n to the multi-tenant configuration. This parameter is supported only for RDS for Oracle\n CDB instances.

\n

During the conversion, RDS creates an initial tenant database and associates the DB\n name, master user name, character set, and national character set metadata with this\n database. The tags associated with the instance also propagate to the initial tenant\n database. You can add more tenant databases to your DB instance by using the\n CreateTenantDatabase operation.

\n \n

The conversion to the multi-tenant configuration is permanent and irreversible, so\n you can't later convert back to the single-tenant configuration. When you specify\n this parameter, you must also specify ApplyImmediately.

\n
" } }, "DedicatedLogVolume": { @@ -22835,10 +23008,16 @@ "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" } }, - "MultiTenant": { - "target": "com.amazonaws.rds#BooleanOptional", + "Engine": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies whether the to convert your DB instance from the single-tenant configuration\n to the multi-tenant configuration. This parameter is supported only for RDS for Oracle\n CDB instances.

\n

During the conversion, RDS creates an initial tenant database and associates the DB\n name, master user name, character set, and national character set metadata with this\n database. The tags associated with the instance also propagate to the initial tenant\n database. You can add more tenant databases to your DB instance by using the\n CreateTenantDatabase operation.

\n \n

The conversion to the multi-tenant configuration is permanent and irreversible, so\n you can't later convert back to the single-tenant configuration. When you specify\n this parameter, you must also specify ApplyImmediately.

\n
" + "smithy.api#documentation": "

The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB\n to an Oracle Database 21c CDB.

\n

Note the following requirements:

\n
    \n
  • \n

    Make sure that you specify oracle-ee-cdb or oracle-se2-cdb.

    \n
  • \n
  • \n

    Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.

    \n
  • \n
\n

Note the following limitations:

\n
    \n
  • \n

    You can't convert a CDB to a non-CDB.

    \n
  • \n
  • \n

    You can't convert a replica database.

    \n
  • \n
  • \n

    You can't convert a non-CDB to a CDB and upgrade the engine version in the\n same command.

    \n
  • \n
  • \n

    You can't convert the existing custom parameter or option group when it has\n options or parameters that are permanent or persistent. In this situation, the\n DB instance reverts to the default option and parameter group. To avoid\n reverting to the default, specify a new parameter group with\n --db-parameter-group-name and a new option group with\n --option-group-name.

    \n
  • \n
" + } + }, + "MasterUserAuthenticationType": { + "target": "com.amazonaws.rds#MasterUserAuthenticationType", + "traits": { + "smithy.api#documentation": "

Specifies the authentication type for the master user. With IAM master user authentication, you can change the master DB user to use IAM database authentication.

\n

You can specify one of the following values:

\n
    \n
  • \n

    \n password - Use standard database authentication with a password.

    \n
  • \n
  • \n

    \n iam-db-auth - Use IAM database authentication for the master user.

    \n
  • \n
\n

This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines.

" } } }, @@ -23017,7 +23196,7 @@ "type": "structure", "members": { "DBProxyName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The identifier for the DBProxy to modify.

", @@ -23025,11 +23204,17 @@ } }, "NewDBProxyName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyName", "traits": { "smithy.api#documentation": "

The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

" } }, + "DefaultAuthScheme": { + "target": "com.amazonaws.rds#DefaultAuthScheme", + "traits": { + "smithy.api#documentation": "

The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. \n Valid values are NONE and IAM_AUTH. \n When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database.

" + } + }, "Auth": { "target": "com.amazonaws.rds#UserAuthConfigList", "traits": { @@ -23051,11 +23236,11 @@ "DebugLogging": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" + "smithy.api#documentation": "

Specifies whether the proxy logs detailed connection and query information. \n When you enable DebugLogging, the proxy captures connection details \n and connection pool behavior from your queries. Debug logging increases CloudWatch costs \n and can impact proxy performance. Enable this option only when you need \n to troubleshoot connection or performance issues.

" } }, "RoleArn": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

" } @@ -23112,7 +23297,7 @@ "type": "structure", "members": { "TargetGroupName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyTargetGroupName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the target group to modify.

", @@ -23120,7 +23305,7 @@ } }, "DBProxyName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the proxy.

", @@ -23272,10 +23457,16 @@ "errors": [ { "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" } ], "traits": { - "smithy.api#documentation": "

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n

\n

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation\n doesn't apply to RDS Custom or RDS for Db2.

", + "smithy.api#documentation": "

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n

\n

Amazon RDS supports upgrading DB snapshots for MariaDB, MySQL, PostgreSQL, and Oracle. This operation\n doesn't apply to RDS Custom or RDS for Db2.

", "smithy.api#examples": [ { "title": "To modify a DB snapshot", @@ -23451,7 +23642,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The engine version to upgrade the DB snapshot to.

\n

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

\n

\n MySQL\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading a MySQL DB snapshot engine version in the Amazon RDS User Guide.\n

\n

\n Oracle\n

\n
    \n
  • \n

    \n 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB\n snapshots)

    \n
  • \n
  • \n

    \n 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB\n snapshots)

    \n
  • \n
  • \n

    \n 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

    \n
  • \n
  • \n

    \n 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

    \n
  • \n
  • \n

    \n 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

    \n
  • \n
\n

\n PostgreSQL\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading a PostgreSQL DB snapshot engine version in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The engine version to upgrade the DB snapshot to.

\n

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

\n

\n MariaDB\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading a MariaDB DB snapshot engine version in the Amazon RDS User Guide.\n

\n

\n MySQL\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading a MySQL DB snapshot engine version in the Amazon RDS User Guide.\n

\n

\n Oracle\n

\n
    \n
  • \n

    \n 21.0.0.0.ru-2025-04.rur-2025-04.r1 (supported for 21.0.0.0.ru-2022-01.rur-2022-01.r1, 21.0.0.0.ru-2022-04.rur-2022-04.r1, 21.0.0.0.ru-2022-07.rur-2022-07.r1, 21.0.0.0.ru-2022-10.rur-2022-10.r1, 21.0.0.0.ru-2023-01.rur-2023-01.r1 and 21.0.0.0.ru-2023-01.rur-2023-01.r2 DB snapshots)

    \n
  • \n
  • \n

    \n 19.0.0.0.ru-2025-04.rur-2025-04.r1 (supported for 19.0.0.0.ru-2019-07.rur-2019-07.r1, 19.0.0.0.ru-2019-10.rur-2019-10.r1 and 0.0.0.ru-2020-01.rur-2020-01.r1 DB snapshots)

    \n
  • \n
  • \n

    \n 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB\n snapshots)

    \n
  • \n
  • \n

    \n 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB\n snapshots)

    \n
  • \n
  • \n

    \n 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

    \n
  • \n
  • \n

    \n 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

    \n
  • \n
  • \n

    \n 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

    \n
  • \n
\n

\n PostgreSQL\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading a PostgreSQL DB snapshot engine version in the Amazon RDS User Guide.\n

" } }, "OptionGroupName": { @@ -23494,6 +23685,9 @@ { "target": "com.amazonaws.rds#DBSubnetQuotaExceededFault" }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" + }, { "target": "com.amazonaws.rds#InvalidSubnet" }, @@ -23768,13 +23962,15 @@ "type": "structure", "members": { "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#GlobalClusterIdentifier", "traits": { - "smithy.api#documentation": "

The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing global database cluster.

    \n
  • \n
" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing global database cluster.

    \n
  • \n
", + "smithy.api#required": {} } }, "NewGlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#GlobalClusterIdentifier", "traits": { "smithy.api#documentation": "

The new cluster identifier for the global database cluster.\n This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
  • \n
  • \n

    The first character must be a letter.

    \n
  • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
  • \n
\n

Example: my-cluster2\n

" } @@ -24619,7 +24815,7 @@ } }, "Value": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#PotentiallySensitiveOptionSettingValue", "traits": { "smithy.api#documentation": "

The current value of the option setting.

" } @@ -24811,6 +25007,12 @@ "smithy.api#documentation": "

Indicates whether a DB instance supports provisioned IOPS.

" } }, + "SupportsStorageThroughput": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a DB instance supports storage throughput.

" + } + }, "SupportsEnhancedMonitoring": { "target": "com.amazonaws.rds#Boolean", "traits": { @@ -24865,6 +25067,30 @@ "smithy.api#documentation": "

Maximum provisioned IOPS per GiB for a DB instance.

" } }, + "MinStorageThroughputPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Minimum storage throughput for a DB instance.

" + } + }, + "MaxStorageThroughputPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Maximum storage throughput for a DB instance.

" + } + }, + "MinStorageThroughputPerIops": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

" + } + }, + "MaxStorageThroughputPerIops": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

" + } + }, "AvailableProcessorFeatures": { "target": "com.amazonaws.rds#AvailableProcessorFeatureList", "traits": { @@ -24907,52 +25133,28 @@ "smithy.api#documentation": "

Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

" } }, - "SupportsClusters": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether DB instances can be configured as a Multi-AZ DB cluster.

\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

" - } - }, "SupportedNetworkTypes": { "target": "com.amazonaws.rds#StringList", "traits": { "smithy.api#documentation": "

The network types supported by the DB instance (IPV4 or DUAL).

\n

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } }, - "SupportsStorageThroughput": { + "SupportsClusters": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether a DB instance supports storage throughput.

" - } - }, - "MinStorageThroughputPerDbInstance": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Minimum storage throughput for a DB instance.

" - } - }, - "MaxStorageThroughputPerDbInstance": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Maximum storage throughput for a DB instance.

" - } - }, - "MinStorageThroughputPerIops": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

" + "smithy.api#documentation": "

Indicates whether DB instances can be configured as a Multi-AZ DB cluster.

\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

" } }, - "MaxStorageThroughputPerIops": { - "target": "com.amazonaws.rds#DoubleOptional", + "SupportsDedicatedLogVolume": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

" + "smithy.api#documentation": "

Indicates whether a DB instance supports using a dedicated log volume (DLV).

" } }, - "SupportsDedicatedLogVolume": { + "SupportsHttpEndpoint": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether a DB instance supports using a dedicated log volume (DLV).

" + "smithy.api#documentation": "

Indicates whether a DB instance supports HTTP endpoints.

" } } }, @@ -25014,7 +25216,7 @@ } }, "ParameterValue": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#PotentiallySensitiveParameterValue", "traits": { "smithy.api#documentation": "

The value of the parameter.

" } @@ -25206,7 +25408,7 @@ } }, "MasterUserPassword": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

The master credentials for the DB instance.

" } @@ -25247,6 +25449,12 @@ "smithy.api#documentation": "

The Provisioned IOPS value for the DB instance.

" } }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput of the DB instance.

" + } + }, "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { @@ -25280,12 +25488,6 @@ "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class\n of the DB instance.

" } }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" - } - }, "AutomationMode": { "target": "com.amazonaws.rds#AutomationMode", "traits": { @@ -25298,16 +25500,16 @@ "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" } }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", + "MultiTenant": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

The storage throughput of the DB instance.

" + "smithy.api#documentation": "

Indicates whether the DB instance will change to the multi-tenant configuration (TRUE)\n or the single-tenant configuration (FALSE).

" } }, - "Engine": { - "target": "com.amazonaws.rds#String", + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

The database engine of the DB instance.

" + "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" } }, "DedicatedLogVolume": { @@ -25316,10 +25518,10 @@ "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.>

" } }, - "MultiTenant": { - "target": "com.amazonaws.rds#BooleanOptional", + "Engine": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Indicates whether the DB instance will change to the multi-tenant configuration (TRUE)\n or the single-tenant configuration (FALSE).

" + "smithy.api#documentation": "

The database engine of the DB instance.

" } } }, @@ -25422,6 +25624,15 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.rds#PotentiallySensitiveOptionSettingValue": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.rds#PotentiallySensitiveParameterValue": { + "type": "string" + }, "com.amazonaws.rds#ProcessorFeature": { "type": "structure", "members": { @@ -25851,6 +26062,9 @@ }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" } ], "traits": { @@ -26162,7 +26376,7 @@ "type": "structure", "members": { "DBProxyName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

", @@ -26170,7 +26384,7 @@ } }, "TargetGroupName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBProxyTargetGroupName", "traits": { "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup.

" } @@ -26221,6 +26435,9 @@ { "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, { "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" } @@ -26270,15 +26487,19 @@ "type": "structure", "members": { "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#GlobalClusterIdentifier", "traits": { - "smithy.api#documentation": "

The cluster identifier to detach from the Aurora global database cluster.

" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The cluster identifier to detach from the Aurora global database cluster.

", + "smithy.api#required": {} } }, "DbClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

", + "smithy.api#required": {} } } }, @@ -26518,12 +26739,18 @@ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, + { + "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" + }, { "target": "com.amazonaws.rds#DBProxyNotFoundFault" }, { "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" }, + { + "target": "com.amazonaws.rds#DBShardGroupNotFoundFault" + }, { "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" }, @@ -26533,6 +26760,15 @@ { "target": "com.amazonaws.rds#IntegrationNotFoundFault" }, + { + "target": "com.amazonaws.rds#InvalidDBClusterEndpointStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, { "target": "com.amazonaws.rds#TenantDatabaseNotFoundFault" } @@ -27105,6 +27341,9 @@ { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, { "target": "com.amazonaws.rds#StorageQuotaExceededFault" }, @@ -27260,7 +27499,7 @@ } }, "MasterUserPassword": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints:

\n
    \n
  • \n

    Must contain from 8 to 41 characters.

    \n
  • \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
  • \n
" } @@ -27378,8 +27617,11 @@ "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

" } }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

Valid Values: aurora, aurora-iopt1\n

\n

Default: aurora\n

\n

Valid for: Aurora DB clusters only

" + } }, "NetworkType": { "target": "com.amazonaws.rds#String", @@ -27387,6 +27629,9 @@ "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
  • \n
  • \n

    \n DUAL\n

    \n
  • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" } }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, "ManageMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { @@ -27399,12 +27644,6 @@ "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" } }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

Valid Values: aurora, aurora-iopt1\n

\n

Default: aurora\n

\n

Valid for: Aurora DB clusters only

" - } - }, "EngineLifecycleSupport": { "target": "com.amazonaws.rds#String", "traits": { @@ -27490,11 +27729,17 @@ { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, { "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" } ], "traits": { @@ -27725,15 +27970,15 @@ "smithy.api#documentation": "

Specifies whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
  • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
  • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
  • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
  • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" - }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
  • \n
  • \n

    \n DUAL\n

    \n
  • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" } }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, "RdsCustomClusterConfiguration": { "target": "com.amazonaws.rds#RdsCustomClusterConfiguration", "traits": { @@ -27856,11 +28101,17 @@ { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, { "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" } ], "traits": { @@ -28042,18 +28293,6 @@ "smithy.api#documentation": "

The name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" } }, - "ScalingConfiguration": { - "target": "com.amazonaws.rds#ScalingConfiguration", - "traits": { - "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" - } - }, - "EngineMode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine mode of the new cluster. Specify provisioned or serverless,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone\n that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or\n an encrypted provisioned cluster. To create a full copy that is an Aurora Serverless v1 cluster, specify \n the engine mode serverless.

\n

Valid for: Aurora DB clusters only

" - } - }, "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { @@ -28078,9 +28317,6 @@ "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Multi-AZ DB clusters only

" } }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" - }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { @@ -28093,6 +28329,21 @@ "smithy.api#documentation": "

The resource ID of the source DB cluster from which to restore.

" } }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine mode of the new cluster. Specify provisioned or serverless,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone\n that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or\n an encrypted provisioned cluster. To create a full copy that is an Aurora Serverless v1 cluster, specify \n the engine mode serverless.

\n

Valid for: Aurora DB clusters only

" + } + }, "RdsCustomClusterConfiguration": { "target": "com.amazonaws.rds#RdsCustomClusterConfiguration", "traits": { @@ -28331,7 +28582,7 @@ "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

License model information for the restored DB instance.

\n \n

License models for RDS for Db2 require additional configuration. The Bring Your\n Own License (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through\n Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more\n information, see Amazon RDS for Db2 licensing\n options in the Amazon RDS User Guide.

\n
\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    RDS for Db2 - bring-your-own-license | marketplace-license\n

    \n
  • \n
  • \n

    RDS for MariaDB - general-public-license\n

    \n
  • \n
  • \n

    RDS for Microsoft SQL Server - license-included\n

    \n
  • \n
  • \n

    RDS for MySQL - general-public-license\n

    \n
  • \n
  • \n

    RDS for Oracle - bring-your-own-license | license-included\n

    \n
  • \n
  • \n

    RDS for PostgreSQL - postgresql-license\n

    \n
  • \n
\n

Default: Same as the source.

" + "smithy.api#documentation": "

License model information for the restored DB instance.

\n \n

License models for RDS for Db2 require additional configuration. The bring your\n own license (BYOL) model requires a custom parameter group and an Amazon Web Services License\n Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model\n requires an Amazon Web Services Marketplace subscription. For more information, see Amazon\n RDS for Db2 licensing options in the Amazon RDS User\n Guide.

\n
\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    RDS for Db2 - bring-your-own-license | marketplace-license\n

    \n
  • \n
  • \n

    RDS for MariaDB - general-public-license\n

    \n
  • \n
  • \n

    RDS for Microsoft SQL Server - license-included\n

    \n
  • \n
  • \n

    RDS for MySQL - general-public-license\n

    \n
  • \n
  • \n

    RDS for Oracle - bring-your-own-license | license-included\n

    \n
  • \n
  • \n

    RDS for PostgreSQL - postgresql-license\n

    \n
  • \n
\n

Default: Same as the source.

" } }, "DBName": { @@ -28352,6 +28603,12 @@ "smithy.api#documentation": "

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. \n If this parameter isn't specified, the IOPS value is taken from the backup. \n If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. \n The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

\n

The provisioned IOPS value must follow the requirements for your database engine.\n For more information, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.\n

\n

Constraints: Must be an integer greater than 1000.

" } }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { @@ -28374,7 +28631,7 @@ } }, "TdeCredentialPassword": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" } @@ -28469,10 +28726,10 @@ "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, - "CustomIamInstanceProfile": { + "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
  • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
  • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
  • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
  • \n
  • \n

    \n DUAL\n

    \n
  • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } }, "BackupTarget": { @@ -28481,16 +28738,16 @@ "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are local (Dedicated Local Zone), outposts (Amazon Web Services Outposts), and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" } }, - "NetworkType": { + "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
  • \n
  • \n

    \n DUAL\n

    \n
  • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
  • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
  • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
  • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" } }, - "StorageThroughput": { + "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in\n CreateDBInstance.

\n

This setting isn't valid for RDS for SQL Server.

\n \n

Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also\n allocate additional storage for future growth.

\n
" } }, "DBClusterSnapshotIdentifier": { @@ -28499,12 +28756,6 @@ "smithy.api#documentation": "

The identifier for the Multi-AZ DB cluster snapshot to restore from.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Multi-AZ DB cluster snapshot.

    \n
  • \n
  • \n

    Can't be specified when DBSnapshotIdentifier is specified.

    \n
  • \n
  • \n

    Must be specified when DBSnapshotIdentifier isn't specified.

    \n
  • \n
  • \n

    If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier\n must be the ARN of the shared snapshot.

    \n
  • \n
  • \n

    Can't be the identifier of an Aurora DB cluster snapshot.

    \n
  • \n
" } }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in\n CreateDBInstance.

\n

This setting isn't valid for RDS for SQL Server.

\n \n

Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also\n allocate additional storage for future growth.

\n
" - } - }, "DedicatedLogVolume": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { @@ -28620,7 +28871,7 @@ } ], "traits": { - "smithy.api#documentation": "

Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide.\n

\n

This operation doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Restoring a backup into an Amazon RDS for MySQL DB instance \n in the Amazon RDS User Guide.\n

\n

This operation doesn't apply to RDS Custom.

" } }, "com.amazonaws.rds#RestoreDBInstanceFromS3Message": { @@ -28669,7 +28920,7 @@ } }, "MasterUserPassword": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

The password for the master user.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
  • \n
  • \n

    Can include any printable ASCII character except \"/\", \"\"\", or \"@\". For RDS for Oracle, can't include the \"&\" (ampersand) or the \"'\" (single quotes) character.

    \n
  • \n
\n

Length Constraints:

\n
    \n
  • \n

    RDS for Db2 - Must contain from 8 to 128 characters.

    \n
  • \n
  • \n

    RDS for MariaDB - Must contain from 8 to 41 characters.

    \n
  • \n
  • \n

    RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

    \n
  • \n
  • \n

    RDS for MySQL - Must contain from 8 to 41 characters.

    \n
  • \n
  • \n

    RDS for Oracle - Must contain from 8 to 30 characters.

    \n
  • \n
  • \n

    RDS for PostgreSQL - Must contain from 8 to 128 characters.

    \n
  • \n
" } @@ -28758,6 +29009,12 @@ "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) \n to allocate initially for the DB instance.\n For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.\n

" } }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { @@ -28916,12 +29173,6 @@ "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
  • \n
  • \n

    \n DUAL\n

    \n
  • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" - } - }, "ManageMasterUserPassword": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { @@ -29221,7 +29472,7 @@ "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The license model information for the restored DB instance.

\n \n

License models for RDS for Db2 require additional configuration. The Bring Your\n Own License (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through\n Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more\n information, see Amazon RDS for Db2 licensing\n options in the Amazon RDS User Guide.

\n
\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    RDS for Db2 - bring-your-own-license | marketplace-license\n

    \n
  • \n
  • \n

    RDS for MariaDB - general-public-license\n

    \n
  • \n
  • \n

    RDS for Microsoft SQL Server - license-included\n

    \n
  • \n
  • \n

    RDS for MySQL - general-public-license\n

    \n
  • \n
  • \n

    RDS for Oracle - bring-your-own-license | license-included\n

    \n
  • \n
  • \n

    RDS for PostgreSQL - postgresql-license\n

    \n
  • \n
\n

Default: Same as the source.

" + "smithy.api#documentation": "

The license model information for the restored DB instance.

\n \n

License models for RDS for Db2 require additional configuration. The bring your\n own license (BYOL) model requires a custom parameter group and an Amazon Web Services License\n Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model\n requires an Amazon Web Services Marketplace subscription. For more information, see Amazon\n RDS for Db2 licensing options in the Amazon RDS User\n Guide.

\n
\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    RDS for Db2 - bring-your-own-license | marketplace-license\n

    \n
  • \n
  • \n

    RDS for MariaDB - general-public-license\n

    \n
  • \n
  • \n

    RDS for Microsoft SQL Server - license-included\n

    \n
  • \n
  • \n

    RDS for MySQL - general-public-license\n

    \n
  • \n
  • \n

    RDS for Oracle - bring-your-own-license | license-included\n

    \n
  • \n
  • \n

    RDS for PostgreSQL - postgresql-license\n

    \n
  • \n
\n

Default: Same as the source.

" } }, "DBName": { @@ -29242,6 +29493,12 @@ "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.

\n

This setting doesn't apply to SQL Server.

\n

Constraints:

\n
    \n
  • \n

    Must be an integer greater than 1000.

    \n
  • \n
" } }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { @@ -29270,7 +29527,7 @@ } }, "TdeCredentialPassword": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" } @@ -29365,40 +29622,34 @@ "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, - "SourceDBInstanceAutomatedBackupsArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" - } - }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, - "CustomIamInstanceProfile": { + "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
  • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
  • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
  • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
  • \n
  • \n

    \n DUAL\n

    \n
  • \n
" } }, - "BackupTarget": { + "SourceDBInstanceAutomatedBackupsArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The location for storing automated backups and manual snapshots for the restored DB instance.

\n

Valid Values:

\n
    \n
  • \n

    \n local (Dedicated Local Zone)

    \n
  • \n
  • \n

    \n outposts (Amazon Web Services Outposts)

    \n
  • \n
  • \n

    \n region (Amazon Web Services Region)

    \n
  • \n
\n

Default: region\n

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" } }, - "NetworkType": { + "BackupTarget": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

\n

Valid Values:

\n
    \n
  • \n

    \n IPV4\n

    \n
  • \n
  • \n

    \n DUAL\n

    \n
  • \n
" + "smithy.api#documentation": "

The location for storing automated backups and manual snapshots for the restored DB instance.

\n

Valid Values:

\n
    \n
  • \n

    \n local (Dedicated Local Zone)

    \n
  • \n
  • \n

    \n outposts (Amazon Web Services Outposts)

    \n
  • \n
  • \n

    \n region (Amazon Web Services Region)

    \n
  • \n
\n

Default: region\n

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" } }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
  • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
  • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
  • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" } }, "AllocatedStorage": { @@ -30015,6 +30266,18 @@ "traits": { "smithy.api#enumValue": "blue-green-deployment" } + }, + "db_shard_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-shard-group" + } + }, + "zero_etl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zero-etl" + } } } }, @@ -30140,17 +30403,17 @@ "smithy.api#documentation": "

The mode of the database activity stream.

" } }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether or not the database activity stream will start as soon as possible, \n regardless of the maintenance window for the database.

" - } - }, "EngineNativeAuditFieldsIncluded": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether or not the database activity stream will start as soon as possible, \n regardless of the maintenance window for the database.

" + } } }, "traits": { @@ -30177,6 +30440,9 @@ }, { "target": "com.amazonaws.rds#InvalidDBShardGroupStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" } ], "traits": { @@ -30308,6 +30574,9 @@ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceAutomatedBackupStateFault" + }, { "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, @@ -30379,7 +30648,7 @@ } }, "PreSignedUrl": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#SensitiveString", "traits": { "smithy.api#documentation": "

In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request \n for the StartDBInstanceAutomatedBackupsReplication operation to call \n in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API operation that can run in \n the Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n
" } @@ -31378,6 +31647,23 @@ "smithy.api#output": {} } }, + "com.amazonaws.rds#TargetConnectionNetworkType": { + "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.rds#TargetDBClusterParameterGroupName": { "type": "string", "traits": { @@ -31482,6 +31768,12 @@ "traits": { "smithy.api#enumValue": "INVALID_REPLICATION_STATE" } + }, + "PROMOTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROMOTED" + } } } }, @@ -31534,6 +31826,12 @@ "traits": { "smithy.api#enumValue": "UNAVAILABLE" } + }, + "unused": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNUSED" + } } } }, @@ -31864,13 +32162,13 @@ "type": "structure", "members": { "Description": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#Description", "traits": { "smithy.api#documentation": "

A user-specified description about the authentication used by a proxy to log in as a specific database user.

" } }, "UserName": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#AuthUserName", "traits": { "smithy.api#documentation": "

The name of the database user to which the proxy connects.

" } @@ -31882,7 +32180,7 @@ } }, "SecretArn": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

" } @@ -31958,6 +32256,12 @@ "type": "list", "member": { "target": "com.amazonaws.rds#UserAuthConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } } }, "com.amazonaws.rds#ValidDBInstanceModificationsMessage": { @@ -32013,12 +32317,6 @@ "smithy.api#documentation": "

The valid range of Provisioned IOPS to gibibytes of storage multiplier.\n For example, 3-10,\n which means that provisioned IOPS can be between 3 and 10 times storage.

" } }, - "SupportsStorageAutoscaling": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

" - } - }, "ProvisionedStorageThroughput": { "target": "com.amazonaws.rds#RangeList", "traits": { @@ -32030,6 +32328,12 @@ "traits": { "smithy.api#documentation": "

The valid range of storage throughput to provisioned IOPS ratios. For example, \n 0-0.25.

" } + }, + "SupportsStorageAutoscaling": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/redshift-data.json b/codegen/sdk/aws-models/redshift-data.json index 2b71db8ee3f..180951ab6b1 100644 --- a/codegen/sdk/aws-models/redshift-data.json +++ b/codegen/sdk/aws-models/redshift-data.json @@ -2244,17 +2244,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2268,17 +2257,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2292,17 +2270,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2316,17 +2283,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/redshift-serverless.json b/codegen/sdk/aws-models/redshift-serverless.json index 0bad2a4712c..247e936fbde 100644 --- a/codegen/sdk/aws-models/redshift-serverless.json +++ b/codegen/sdk/aws-models/redshift-serverless.json @@ -5289,17 +5289,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5313,17 +5302,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5337,17 +5315,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5361,17 +5328,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/redshift.json b/codegen/sdk/aws-models/redshift.json index 1a812f46651..78b72957c26 100644 --- a/codegen/sdk/aws-models/redshift.json +++ b/codegen/sdk/aws-models/redshift.json @@ -3938,12 +3938,18 @@ { "target": "com.amazonaws.redshift#DependentServiceUnavailableFault" }, + { + "target": "com.amazonaws.redshift#InvalidTagFault" + }, { "target": "com.amazonaws.redshift#RedshiftIdcApplicationAlreadyExistsFault" }, { "target": "com.amazonaws.redshift#RedshiftIdcApplicationQuotaExceededFault" }, + { + "target": "com.amazonaws.redshift#TagLimitExceededFault" + }, { "target": "com.amazonaws.redshift#UnsupportedOperationFault" } @@ -4004,6 +4010,18 @@ "traits": { "smithy.api#documentation": "

A collection of service integrations for the Redshift IAM Identity Center application.

" } + }, + "Tags": { + "target": "com.amazonaws.redshift#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags.

" + } + }, + "SsoTagKeys": { + "target": "com.amazonaws.redshift#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of tags keys that Redshift Identity Center applications copy to IAM Identity\n Center. For each input key, the tag corresponding to the key-value pair is\n propagated.

" + } } }, "traits": { @@ -14356,6 +14374,18 @@ "traits": { "smithy.api#documentation": "

A list of service integrations for the Redshift IAM Identity Center application.

" } + }, + "Tags": { + "target": "com.amazonaws.redshift#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags.

" + } + }, + "SsoTagKeys": { + "target": "com.amazonaws.redshift#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of tags keys that Redshift Identity Center applications copy to IAM Identity\n Center. For each input key, the tag corresponding to the key-value pair is\n propagated.

" + } } }, "traits": { @@ -15755,17 +15785,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -15779,17 +15798,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -15803,17 +15811,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -15827,17 +15824,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/rekognition.json b/codegen/sdk/aws-models/rekognition.json index f75772e7787..1f0ae09e737 100644 --- a/codegen/sdk/aws-models/rekognition.json +++ b/codegen/sdk/aws-models/rekognition.json @@ -12128,17 +12128,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -12152,17 +12141,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -12176,17 +12154,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -12200,17 +12167,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/repostspace.json b/codegen/sdk/aws-models/repostspace.json index 1daa1dc2ac3..f8a8d265204 100644 --- a/codegen/sdk/aws-models/repostspace.json +++ b/codegen/sdk/aws-models/repostspace.json @@ -2691,17 +2691,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2715,17 +2704,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2739,17 +2717,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2763,17 +2730,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/resiliencehub.json b/codegen/sdk/aws-models/resiliencehub.json index 18f132ed97a..f7a2742ace5 100644 --- a/codegen/sdk/aws-models/resiliencehub.json +++ b/codegen/sdk/aws-models/resiliencehub.json @@ -2178,17 +2178,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2202,17 +2191,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2226,17 +2204,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2250,17 +2217,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/resource-explorer-2.json b/codegen/sdk/aws-models/resource-explorer-2.json index 0351385ab8c..c9beb3b6381 100644 --- a/codegen/sdk/aws-models/resource-explorer-2.json +++ b/codegen/sdk/aws-models/resource-explorer-2.json @@ -2456,17 +2456,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2480,17 +2469,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2504,17 +2482,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2528,17 +2495,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/resource-groups-tagging-api.json b/codegen/sdk/aws-models/resource-groups-tagging-api.json index 8f97f8cd1db..aa2fcbae263 100644 --- a/codegen/sdk/aws-models/resource-groups-tagging-api.json +++ b/codegen/sdk/aws-models/resource-groups-tagging-api.json @@ -1552,17 +1552,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1576,17 +1565,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1600,17 +1578,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1624,17 +1591,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/resource-groups.json b/codegen/sdk/aws-models/resource-groups.json index 90954b449e6..f131cf5271b 100644 --- a/codegen/sdk/aws-models/resource-groups.json +++ b/codegen/sdk/aws-models/resource-groups.json @@ -1016,17 +1016,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1040,17 +1029,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1064,17 +1042,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1088,17 +1055,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/robomaker.json b/codegen/sdk/aws-models/robomaker.json index bce47bd0a1c..6a8586eaec0 100644 --- a/codegen/sdk/aws-models/robomaker.json +++ b/codegen/sdk/aws-models/robomaker.json @@ -10126,17 +10126,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -10150,17 +10139,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -10174,17 +10152,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -10198,17 +10165,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/rolesanywhere.json b/codegen/sdk/aws-models/rolesanywhere.json index 8d19558919b..7aeaac939a8 100644 --- a/codegen/sdk/aws-models/rolesanywhere.json +++ b/codegen/sdk/aws-models/rolesanywhere.json @@ -2705,17 +2705,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2729,17 +2718,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2753,17 +2731,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2777,17 +2744,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/route-53-domains.json b/codegen/sdk/aws-models/route-53-domains.json index f6f9ae86371..6b1f60cee01 100644 --- a/codegen/sdk/aws-models/route-53-domains.json +++ b/codegen/sdk/aws-models/route-53-domains.json @@ -3103,6 +3103,24 @@ "traits": { "smithy.api#enumValue": "AU_PRIORITY_TOKEN" } + }, + "AU_ELIGIBILITY_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AU_ELIGIBILITY_TYPE" + } + }, + "AU_POLICY_REASON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AU_POLICY_REASON" + } + }, + "AU_REGISTRANT_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AU_REGISTRANT_NAME" + } } } }, @@ -5465,17 +5483,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5489,17 +5496,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5513,17 +5509,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5537,17 +5522,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/route-53.json b/codegen/sdk/aws-models/route-53.json index c951c6f0a01..dc6d87943e5 100644 --- a/codegen/sdk/aws-models/route-53.json +++ b/codegen/sdk/aws-models/route-53.json @@ -1434,17 +1434,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1458,17 +1447,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1513,17 +1491,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1537,17 +1504,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3536,6 +3492,12 @@ "traits": { "smithy.api#enumValue": "eu-isoe-west-1" } + }, + "ap_southeast_6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-6" + } } }, "traits": { @@ -10664,7 +10626,7 @@ "Type": { "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

The DNS record type. For information about different record types and how data is\n\t\t\tencoded for them, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.

\n

Valid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | DS |MX |\n\t\t\t\tNAPTR | NS | PTR | SOA |\n\t\t\tSPF | SRV | TXT| TLSA| SSHFP| SVCB| HTTPS\n

\n

Values for weighted, latency, geolocation, and failover resource record sets: A\n\t\t\t| AAAA | CAA | CNAME | MX |\n\t\t\t\tNAPTR | PTR | SPF | SRV |\n\t\t\t\tTXT| TLSA| SSHFP| SVCB|\n\t\t\t\tHTTPS. When creating a group of weighted, latency, geolocation,\n\t\t\tor\n\t\t\tfailover resource record sets, specify the same value for all of the resource record\n\t\t\tsets in the group.

\n

Valid values for multivalue answer resource record sets: A |\n\t\t\t\tAAAA | MX | NAPTR | PTR |\n\t\t\tSPF | SRV | TXT| CAA| TLSA| SSHFP| SVCB| HTTPS\n

\n \n

SPF records were formerly used to verify the identity of the sender of email\n\t\t\t\tmessages. However, we no longer recommend that you create resource record sets for\n\t\t\t\twhich the value of Type is SPF. RFC 7208, Sender\n\t\t\t\t\tPolicy Framework (SPF) for Authorizing Use of Domains in Email, Version\n\t\t\t\t\t1, has been updated to say, \"...[I]ts existence and mechanism defined\n\t\t\t\tin [RFC4408] have led to some interoperability issues. Accordingly, its use is no\n\t\t\t\tlonger appropriate for SPF version 1; implementations are not to use it.\" In RFC\n\t\t\t\t7208, see section 14.1, The SPF DNS Record Type.

\n
\n

Values for alias resource record sets:

\n
    \n
  • \n

    \n Amazon API Gateway custom regional APIs and\n\t\t\t\t\t\tedge-optimized APIs:\n A\n

    \n
  • \n
  • \n

    \n CloudFront distributions:\n A\n

    \n

    If IPv6 is enabled for the distribution, create two resource record sets to\n\t\t\t\t\troute traffic to your distribution, one with a value of A and one\n\t\t\t\t\twith a value of AAAA.

    \n
  • \n
  • \n

    \n Amazon API Gateway environment that has a regionalized\n\t\t\t\t\t\tsubdomain: A\n

    \n
  • \n
  • \n

    \n ELB load balancers:\n A | AAAA\n

    \n
  • \n
  • \n

    \n Amazon S3 buckets:\n A\n

    \n
  • \n
  • \n

    \n Amazon Virtual Private Cloud interface VPC\n\t\t\t\t\t\tendpoints\n A\n

    \n
  • \n
  • \n

    \n Another resource record set in this hosted\n\t\t\t\t\t\tzone: Specify the type of the resource record set that you're\n\t\t\t\t\tcreating the alias for. All values are supported except NS and\n\t\t\t\t\t\tSOA.

    \n \n

    If you're creating an alias record that has the same name as the hosted\n\t\t\t\t\t\tzone (known as the zone apex), you can't route traffic to a record for which\n\t\t\t\t\t\tthe value of Type is CNAME. This is because the\n\t\t\t\t\t\talias record must have the same type as the record you're routing traffic\n\t\t\t\t\t\tto, and creating a CNAME record for the zone apex isn't supported even for\n\t\t\t\t\t\tan alias record.

    \n
    \n
  • \n
", + "smithy.api#documentation": "

The DNS record type. For information about different record types and how data is\n\t\t\tencoded for them, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.

\n

Valid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | DS |MX |\n\t\t\t\tNAPTR | NS | PTR | SOA |\n\t\t\tSPF | SRV | TXT| TLSA| SSHFP| SVCB| HTTPS\n

\n

Values for weighted, latency, geolocation, and failover resource record sets: A\n\t\t\t| AAAA | CAA | CNAME | MX |\n\t\t\t\tNAPTR | PTR | SPF | SRV |\n\t\t\t\tTXT| TLSA| SSHFP| SVCB|\n\t\t\t\tHTTPS. When creating a group of weighted, latency, geolocation, or\n\t\t\tfailover resource record sets, specify the same value for all of the resource record\n\t\t\tsets in the group.

\n

Valid values for multivalue answer resource record sets: A |\n\t\t\t\tAAAA | MX | NAPTR | PTR |\n\t\t\tSPF | SRV | TXT| CAA| TLSA| SSHFP| SVCB| HTTPS\n

\n \n

SPF records were formerly used to verify the identity of the sender of email\n\t\t\t\tmessages. However, we no longer recommend that you create resource record sets for\n\t\t\t\twhich the value of Type is SPF. RFC 7208, Sender\n\t\t\t\t\tPolicy Framework (SPF) for Authorizing Use of Domains in Email, Version\n\t\t\t\t\t1, has been updated to say, \"...[I]ts existence and mechanism defined\n\t\t\t\tin [RFC4408] have led to some interoperability issues. Accordingly, its use is no\n\t\t\t\tlonger appropriate for SPF version 1; implementations are not to use it.\" In RFC\n\t\t\t\t7208, see section 14.1, The SPF DNS Record Type.

\n
\n

Values for alias resource record sets:

\n
    \n
  • \n

    \n Amazon API Gateway custom regional APIs and\n\t\t\t\t\t\tedge-optimized APIs:\n A\n

    \n
  • \n
  • \n

    \n CloudFront distributions:\n A\n

    \n

    If IPv6 is enabled for the distribution, create two resource record sets to\n\t\t\t\t\troute traffic to your distribution, one with a value of A and one\n\t\t\t\t\twith a value of AAAA.

    \n
  • \n
  • \n

    \n Amazon API Gateway environment that has a regionalized\n\t\t\t\t\t\tsubdomain: A\n

    \n
  • \n
  • \n

    \n ELB load balancers:\n A | AAAA\n

    \n
  • \n
  • \n

    \n Amazon S3 buckets:\n A\n

    \n
  • \n
  • \n

    \n Amazon Virtual Private Cloud interface VPC\n\t\t\t\t\t\tendpoints\n A\n

    \n
  • \n
  • \n

    \n Another resource record set in this hosted\n\t\t\t\t\t\tzone: Specify the type of the resource record set that you're\n\t\t\t\t\tcreating the alias for. All values are supported except NS and\n\t\t\t\t\t\tSOA.

    \n \n

    If you're creating an alias record that has the same name as the hosted\n\t\t\t\t\t\tzone (known as the zone apex), you can't route traffic to a record for which\n\t\t\t\t\t\tthe value of Type is CNAME. This is because the\n\t\t\t\t\t\talias record must have the same type as the record you're routing traffic\n\t\t\t\t\t\tto, and creating a CNAME record for the zone apex isn't supported even for\n\t\t\t\t\t\tan alias record.

    \n
    \n
  • \n
", "smithy.api#required": {} } }, @@ -11001,6 +10963,12 @@ "traits": { "smithy.api#enumValue": "ap-east-2" } + }, + "ap_southeast_6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-6" + } } }, "traits": { @@ -12045,7 +12013,7 @@ "Disabled": { "target": "com.amazonaws.route53#Disabled", "traits": { - "smithy.api#documentation": "

Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:

\n
    \n
  • \n

    \n Health checks that check the health of\n\t\t\t\t\t\tendpoints: Route 53 stops submitting requests to your\n\t\t\t\t\tapplication, server, or other resource.

    \n
  • \n
  • \n

    \n Calculated health checks: Route 53 stops\n\t\t\t\t\taggregating the status of the referenced health checks.

    \n
  • \n
  • \n

    \n Health checks that monitor CloudWatch alarms:\n\t\t\t\t\tRoute 53 stops monitoring the corresponding CloudWatch metrics.

    \n
  • \n
\n

After you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.

\n

Charges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.

" + "smithy.api#documentation": "

Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:

\n
    \n
  • \n

    \n Health checks that check the health of\n\t\t\t\t\t\tendpoints: Route 53 stops submitting requests to your\n\t\t\t\t\tapplication, server, or other resource.

    \n
  • \n
  • \n

    \n Calculated health checks: Route 53 stops\n\t\t\t\t\taggregating the status of the referenced health checks.

    \n
  • \n
  • \n

    \n Health checks that monitor CloudWatch alarms:\n\t\t\t\t\tRoute 53 stops monitoring the corresponding CloudWatch metrics.

    \n
  • \n
\n

After you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. Additionally, in disabled state, you can also invert the\n\t\t\tstatus of the health check to route traffic differently. For more information, see\n\t\t\t\tInverted.

\n

Charges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.

" } }, "HealthThreshold": { @@ -12671,6 +12639,12 @@ "traits": { "smithy.api#enumValue": "eu-isoe-west-1" } + }, + "ap_southeast_6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-6" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/route53-recovery-cluster.json b/codegen/sdk/aws-models/route53-recovery-cluster.json index 333778a4fec..6d6591197c8 100644 --- a/codegen/sdk/aws-models/route53-recovery-cluster.json +++ b/codegen/sdk/aws-models/route53-recovery-cluster.json @@ -1014,17 +1014,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1038,17 +1027,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1062,17 +1040,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1086,17 +1053,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/route53-recovery-control-config.json b/codegen/sdk/aws-models/route53-recovery-control-config.json index 622b76cd575..a930af67d23 100644 --- a/codegen/sdk/aws-models/route53-recovery-control-config.json +++ b/codegen/sdk/aws-models/route53-recovery-control-config.json @@ -2996,17 +2996,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3028,17 +3017,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3060,17 +3038,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3092,17 +3059,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3124,17 +3080,6 @@ "UseDualStack": false } }, - { - "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": { @@ -3156,17 +3101,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3189,18 +3123,28 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://route53-recovery-control-config-fips.us-isof-south-1.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -3211,43 +3155,53 @@ } ] }, - "url": "https://route53-recovery-control-config-fips.us-isof-south-1.csp.hci.ic.gov" + "url": "https://route53-recovery-control-config.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eusc-de-east-1" + } + ] + }, + "url": "https://route53-recovery-control-config-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingRegion": "us-isof-south-1" + "signingRegion": "eusc-de-east-1" } ] }, - "url": "https://route53-recovery-control-config.us-isof-south-1.csp.hci.ic.gov" + "url": "https://route53-recovery-control-config.eusc-de-east-1.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } diff --git a/codegen/sdk/aws-models/route53-recovery-readiness.json b/codegen/sdk/aws-models/route53-recovery-readiness.json index e1f506e5f4e..6aea6e50125 100644 --- a/codegen/sdk/aws-models/route53-recovery-readiness.json +++ b/codegen/sdk/aws-models/route53-recovery-readiness.json @@ -2845,13 +2845,16 @@ "sdkId": "Route53 Recovery Readiness", "arnNamespace": "route53-recovery-readiness", "cloudFormationName": "Route53RecoveryReadiness", - "cloudTrailEventSource": "route53recoveryreadiness.amazonaws.com", + "cloudTrailEventSource": "route53-recovery-readiness.amazonaws.com", "endpointPrefix": "route53-recovery-readiness" }, "aws.auth#sigv4": { "name": "route53-recovery-readiness" }, "aws.protocols#restJson1": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], "smithy.api#documentation": "

Recovery readiness

", "smithy.api#title": "AWS Route53 Recovery Readiness", "smithy.rules#endpointRuleSet": { @@ -3326,17 +3329,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3350,17 +3342,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3374,17 +3355,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3398,17 +3368,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/route53profiles.json b/codegen/sdk/aws-models/route53profiles.json index bbffd5470c5..9e174d976da 100644 --- a/codegen/sdk/aws-models/route53profiles.json +++ b/codegen/sdk/aws-models/route53profiles.json @@ -2106,17 +2106,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2130,17 +2119,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2154,17 +2132,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2178,17 +2145,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/route53resolver.json b/codegen/sdk/aws-models/route53resolver.json index 6539f4ebe47..2504e6fcf8a 100644 --- a/codegen/sdk/aws-models/route53resolver.json +++ b/codegen/sdk/aws-models/route53resolver.json @@ -7897,17 +7897,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -7921,28 +7910,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -7956,17 +7923,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/rum.json b/codegen/sdk/aws-models/rum.json index 503fc4f9717..fee68788c8b 100644 --- a/codegen/sdk/aws-models/rum.json +++ b/codegen/sdk/aws-models/rum.json @@ -3016,17 +3016,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3040,17 +3029,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3064,17 +3042,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3088,17 +3055,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/s3-control.json b/codegen/sdk/aws-models/s3-control.json index b653fba6d56..1acb2520084 100644 --- a/codegen/sdk/aws-models/s3-control.json +++ b/codegen/sdk/aws-models/s3-control.json @@ -9260,12 +9260,12 @@ "S3SubPrefix": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { - "smithy.api#documentation": "

The S3SubPrefix is appended to the location scope creating the grant scope. Use this field to narrow the scope of the grant to a subset of the location scope. This field is required if the location scope is the default location s3:// because you cannot create a grant for all of your S3 data in the Region and must narrow the scope. For example, if the location scope is the default location s3://, the S3SubPrefx can be a /*, so the full grant scope path would be s3:///*. Or the S3SubPrefx can be /*, so the full grant scope path would be or s3:///*.

\n

If the S3SubPrefix includes a prefix, append the wildcard character * after the prefix to indicate that you want to include all object key names in the bucket that start with that prefix.

" + "smithy.api#documentation": "

The S3SubPrefix is appended to the location scope creating the grant scope.\n Use this field to narrow the scope of the grant to a subset of the location scope. This\n field is required if the location scope is the default location s3:// because\n you cannot create a grant for all of your S3 data in the Region and must narrow the scope.\n For example, if the location scope is the default location s3://, the\n S3SubPrefx can be a /*, so the full grant scope path\n would be s3:///*. Or the S3SubPrefx can be\n /*, so the full grant scope path\n would be or s3:///*.

\n

If the S3SubPrefix includes a prefix, append the wildcard character\n * after the prefix to indicate that you want to include all object key\n names in the bucket that start with that prefix.

" } } }, "traits": { - "smithy.api#documentation": "

The configuration options of the S3 Access Grants location. It contains the S3SubPrefix field. The grant scope, the data to which you are granting access, is the result of appending the Subprefix field to the scope of the registered location.

" + "smithy.api#documentation": "

The configuration options of the S3 Access Grants location. It contains the\n S3SubPrefix field. The grant scope, the data to which you are granting\n access, is the result of appending the Subprefix field to the scope of the\n registered location.

" } }, "com.amazonaws.s3control#AccessGrantsLocationId": { @@ -9504,7 +9504,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance. Use this action if you want to create access grants for users or groups from your corporate identity directory. First, you must add your corporate identity directory to Amazon Web Services IAM Identity Center. Then, you can associate this IAM Identity Center instance with your S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:AssociateAccessGrantsIdentityCenter permission to use this operation.

\n
\n
Additional Permissions
\n
\n

You must also have the following permissions: sso:CreateApplication, sso:PutApplicationGrant, and sso:PutApplicationAuthenticationMethod.

\n
\n
", + "smithy.api#documentation": "

Associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance. Use this\n action if you want to create access grants for users or groups from your corporate identity\n directory. First, you must add your corporate identity directory to Amazon Web Services IAM Identity\n Center. Then, you can associate this IAM Identity Center instance with your S3 Access Grants\n instance.

\n
\n
Permissions
\n
\n

You must have the s3:AssociateAccessGrantsIdentityCenter\n permission to use this operation.

\n
\n
Additional Permissions
\n
\n

You must also have the following permissions:\n sso:CreateApplication, sso:PutApplicationGrant, and\n sso:PutApplicationAuthenticationMethod.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -9539,7 +9539,7 @@ "IdentityCenterArn": { "target": "com.amazonaws.s3control#IdentityCenterArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are\n associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate\n identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center\n instances and their ARNs.

", "smithy.api#required": {} } } @@ -9978,6 +9978,64 @@ "smithy.api#documentation": "

A container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics.

\n

For more information about publishing S3 Storage Lens metrics to CloudWatch, see Monitor\n S3 Storage Lens metrics in CloudWatch in the Amazon S3 User Guide.

" } }, + "com.amazonaws.s3control#ComputeObjectChecksumAlgorithm": { + "type": "enum", + "members": { + "CRC32": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRC32" + } + }, + "CRC32C": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRC32C" + } + }, + "CRC64NVME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRC64NVME" + } + }, + "MD5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MD5" + } + }, + "SHA1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHA1" + } + }, + "SHA256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHA256" + } + } + } + }, + "com.amazonaws.s3control#ComputeObjectChecksumType": { + "type": "enum", + "members": { + "FULL_OBJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_OBJECT" + } + }, + "COMPOSITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPOSITE" + } + } + } + }, "com.amazonaws.s3control#ConfigId": { "type": "string", "traits": { @@ -10012,7 +10070,7 @@ "target": "com.amazonaws.s3control#CreateAccessGrantResult" }, "traits": { - "smithy.api#documentation": "

Creates an access grant that gives a grantee access to your S3 data. The grantee can be an IAM user or role or a directory user, or group. Before you can create a grant, you must have an S3 Access Grants instance in the same Region as the S3 data. You can create an S3 Access Grants instance using the CreateAccessGrantsInstance. You must also have registered at least one S3 data location in your S3 Access Grants instance using CreateAccessGrantsLocation.

\n
\n
Permissions
\n
\n

You must have the s3:CreateAccessGrant permission to use this operation.

\n
\n
Additional Permissions
\n
\n

For any directory identity - sso:DescribeInstance and sso:DescribeApplication\n

\n

For directory users - identitystore:DescribeUser\n

\n

For directory groups - identitystore:DescribeGroup\n

\n
\n
", + "smithy.api#documentation": "

Creates an access grant that gives a grantee access to your S3 data. The grantee can be\n an IAM user or role or a directory user, or group. Before you can create a grant, you\n must have an S3 Access Grants instance in the same Region as the S3 data. You can create an S3 Access Grants\n instance using the CreateAccessGrantsInstance. You must also have registered at least one S3 data\n location in your S3 Access Grants instance using CreateAccessGrantsLocation.

\n
\n
Permissions
\n
\n

You must have the s3:CreateAccessGrant permission to use this\n operation.

\n
\n
Additional Permissions
\n
\n

For any directory identity - sso:DescribeInstance and\n sso:DescribeApplication\n

\n

For directory users - identitystore:DescribeUser\n

\n

For directory groups - identitystore:DescribeGroup\n

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -10047,46 +10105,46 @@ "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { - "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

\n

If you are passing the default location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the Subprefix field.

", + "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigns this\n ID when you register the location. S3 Access Grants assigns the ID default to the\n default location s3:// and assigns an auto-generated ID to other locations\n that you register.

\n

If you are passing the default location, you cannot create an access grant\n for the entire default location. You must also specify a bucket or a bucket and prefix in\n the Subprefix field.

", "smithy.api#required": {} } }, "AccessGrantsLocationConfiguration": { "target": "com.amazonaws.s3control#AccessGrantsLocationConfiguration", "traits": { - "smithy.api#documentation": "

The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

" + "smithy.api#documentation": "

The configuration options of the grant location. The grant location is the S3 path to\n the data to which you are granting access. It contains the S3SubPrefix field.\n The grant scope is the result of appending the subprefix to the location scope of the\n registered location.

" } }, "Grantee": { "target": "com.amazonaws.s3control#Grantee", "traits": { - "smithy.api#documentation": "

The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

", + "smithy.api#documentation": "

The user, group, or role to which you are granting access. You can grant access to an\n IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity\n Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee\n can also be a corporate directory user or group.

", "smithy.api#required": {} } }, "Permission": { "target": "com.amazonaws.s3control#Permission", "traits": { - "smithy.api#documentation": "

The type of access that you are granting to your S3 data, which can be set to one of the following values:

\n
    \n
  • \n

    \n READ – Grant read-only access to the S3 data.

    \n
  • \n
  • \n

    \n WRITE – Grant write-only access to the S3 data.

    \n
  • \n
  • \n

    \n READWRITE – Grant both read and write access to the S3 data.

    \n
  • \n
", + "smithy.api#documentation": "

The type of access that you are granting to your S3 data, which can be set to one of the\n following values:

\n
    \n
  • \n

    \n READ – Grant read-only access to the S3 data.

    \n
  • \n
  • \n

    \n WRITE – Grant write-only access to the S3 data.

    \n
  • \n
  • \n

    \n READWRITE – Grant both read and write access to the S3 data.

    \n
  • \n
", "smithy.api#required": {} } }, "ApplicationArn": { "target": "com.amazonaws.s3control#IdentityCenterApplicationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated\n with your Identity Center instance. If an application ARN is included in the request to\n create an access grant, the grantee can only access the S3 data through this application.\n

" } }, "S3PrefixType": { "target": "com.amazonaws.s3control#S3PrefixType", "traits": { - "smithy.api#documentation": "

The type of S3SubPrefix. The only possible value is Object. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.

" + "smithy.api#documentation": "

The type of S3SubPrefix. The only possible value is Object.\n Pass this value if the access grant scope is an object. Do not pass this value if the\n access grant scope is a bucket or a bucket and a prefix.

" } }, "Tags": { "target": "com.amazonaws.s3control#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

" + "smithy.api#documentation": "

The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label\n consisting of a user-defined key and value. Tags can help you manage, identify, organize,\n search for, and filter resources.

" } } }, @@ -10106,7 +10164,7 @@ "AccessGrantId": { "target": "com.amazonaws.s3control#AccessGrantId", "traits": { - "smithy.api#documentation": "

The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

" + "smithy.api#documentation": "

The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access\n grant.

" } }, "AccessGrantArn": { @@ -10118,37 +10176,37 @@ "Grantee": { "target": "com.amazonaws.s3control#Grantee", "traits": { - "smithy.api#documentation": "

The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

" + "smithy.api#documentation": "

The user, group, or role to which you are granting access. You can grant access to an\n IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity\n Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee\n can also be a corporate directory user or group.

" } }, "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { - "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

" + "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigns this\n ID when you register the location. S3 Access Grants assigns the ID default to the\n default location s3:// and assigns an auto-generated ID to other locations\n that you register.

" } }, "AccessGrantsLocationConfiguration": { "target": "com.amazonaws.s3control#AccessGrantsLocationConfiguration", "traits": { - "smithy.api#documentation": "

The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.

" + "smithy.api#documentation": "

The configuration options of the grant location. The grant location is the S3 path to\n the data to which you are granting access.

" } }, "Permission": { "target": "com.amazonaws.s3control#Permission", "traits": { - "smithy.api#documentation": "

The type of access that you are granting to your S3 data, which can be set to one of the following values:

\n
    \n
  • \n

    \n READ – Grant read-only access to the S3 data.

    \n
  • \n
  • \n

    \n WRITE – Grant write-only access to the S3 data.

    \n
  • \n
  • \n

    \n READWRITE – Grant both read and write access to the S3 data.

    \n
  • \n
" + "smithy.api#documentation": "

The type of access that you are granting to your S3 data, which can be set to one of the\n following values:

\n
    \n
  • \n

    \n READ – Grant read-only access to the S3 data.

    \n
  • \n
  • \n

    \n WRITE – Grant write-only access to the S3 data.

    \n
  • \n
  • \n

    \n READWRITE – Grant both read and write access to the S3 data.

    \n
  • \n
" } }, "ApplicationArn": { "target": "com.amazonaws.s3control#IdentityCenterApplicationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated\n with your Identity Center instance. If the grant includes an application ARN, the grantee\n can only access the S3 data through this application.

" } }, "GrantScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { - "smithy.api#documentation": "

The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.

" + "smithy.api#documentation": "

The S3 path of the data to which you are granting access. It is the result of appending\n the Subprefix to the location scope.

" } } }, @@ -10165,7 +10223,7 @@ "target": "com.amazonaws.s3control#CreateAccessGrantsInstanceResult" }, "traits": { - "smithy.api#documentation": "

Creates an S3 Access Grants instance, which serves as a logical grouping for access grants. You can create one S3 Access Grants instance per Region per account.

\n
\n
Permissions
\n
\n

You must have the s3:CreateAccessGrantsInstance permission to use this operation.

\n
\n
Additional Permissions
\n
\n

To associate an IAM Identity Center instance with your S3 Access Grants instance, you must also have the sso:DescribeInstance, sso:CreateApplication, sso:PutApplicationGrant, and sso:PutApplicationAuthenticationMethod permissions.

\n
\n
", + "smithy.api#documentation": "

Creates an S3 Access Grants instance, which serves as a logical grouping for access grants. You\n can create one S3 Access Grants instance per Region per account.

\n
\n
Permissions
\n
\n

You must have the s3:CreateAccessGrantsInstance permission to use\n this operation.

\n
\n
Additional Permissions
\n
\n

To associate an IAM Identity Center instance with your S3 Access Grants instance, you\n must also have the sso:DescribeInstance,\n sso:CreateApplication, sso:PutApplicationGrant, and\n sso:PutApplicationAuthenticationMethod permissions.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -10200,13 +10258,13 @@ "IdentityCenterArn": { "target": "com.amazonaws.s3control#IdentityCenterArn", "traits": { - "smithy.api#documentation": "

If you would like to associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, use this field to pass the Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.

" + "smithy.api#documentation": "

If you would like to associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center\n instance, use this field to pass the Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity\n Center instance that you are associating with your S3 Access Grants instance. An IAM Identity\n Center instance is your corporate identity directory that you added to the IAM Identity\n Center. You can use the ListInstances API\n operation to retrieve a list of your Identity Center instances and their ARNs.

" } }, "Tags": { "target": "com.amazonaws.s3control#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Web Services resource tags that you are adding to the S3 Access Grants instance. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

" + "smithy.api#documentation": "

The Amazon Web Services resource tags that you are adding to the S3 Access Grants instance. Each tag is a label\n consisting of a user-defined key and value. Tags can help you manage, identify, organize,\n search for, and filter resources.

" } } }, @@ -10226,13 +10284,13 @@ "AccessGrantsInstanceId": { "target": "com.amazonaws.s3control#AccessGrantsInstanceId", "traits": { - "smithy.api#documentation": "

The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants instance per Region per account.

" + "smithy.api#documentation": "

The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants\n instance per Region per account.

" } }, "AccessGrantsInstanceArn": { "target": "com.amazonaws.s3control#AccessGrantsInstanceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are\n associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate\n identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center\n instances and their ARNs.

" } }, "IdentityCenterArn": { @@ -10241,19 +10299,19 @@ "smithy.api#deprecated": { "message": "IdentityCenterArn has been deprecated. Use IdentityCenterInstanceArn or IdentityCenterApplicationArn." }, - "smithy.api#documentation": "

If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.

" + "smithy.api#documentation": "

If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance,\n this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance\n application; a subresource of the original Identity Center instance. S3 Access Grants creates this\n Identity Center application for the specific S3 Access Grants instance.

" } }, "IdentityCenterInstanceArn": { "target": "com.amazonaws.s3control#IdentityCenterArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are\n associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate\n identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center\n instances and their ARNs.

" } }, "IdentityCenterApplicationArn": { "target": "com.amazonaws.s3control#IdentityCenterApplicationArn", "traits": { - "smithy.api#documentation": "

If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.

" + "smithy.api#documentation": "

If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance,\n this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance\n application; a subresource of the original Identity Center instance. S3 Access Grants creates this\n Identity Center application for the specific S3 Access Grants instance.

" } } }, @@ -10270,7 +10328,7 @@ "target": "com.amazonaws.s3control#CreateAccessGrantsLocationResult" }, "traits": { - "smithy.api#documentation": "

The S3 data location that you would like to register in your S3 Access Grants instance. Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:

\n
    \n
  • \n

    The default S3 location s3://\n

    \n
  • \n
  • \n

    A bucket - S3://\n

    \n
  • \n
  • \n

    A bucket and prefix - S3:///\n

    \n
  • \n
\n

When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy. S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.

\n
\n
Permissions
\n
\n

You must have the s3:CreateAccessGrantsLocation permission to use this operation.

\n
\n
Additional Permissions
\n
\n

You must also have the following permission for the specified IAM role: iam:PassRole\n

\n
\n
", + "smithy.api#documentation": "

The S3 data location that you would like to register in your S3 Access Grants instance. Your S3\n data must be in the same Region as your S3 Access Grants instance. The location can be one of the\n following:

\n
    \n
  • \n

    The default S3 location s3://\n

    \n
  • \n
  • \n

    A bucket - S3://\n

    \n
  • \n
  • \n

    A bucket and prefix - S3:///\n

    \n
  • \n
\n

When you register a location, you must include the IAM role that has permission to\n manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role\n using a policy. S3 Access Grants assumes this role to manage access to the location and\n to vend temporary credentials to grantees or client applications.

\n
\n
Permissions
\n
\n

You must have the s3:CreateAccessGrantsLocation permission to use\n this operation.

\n
\n
Additional Permissions
\n
\n

You must also have the following permission for the specified IAM role:\n iam:PassRole\n

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -10305,21 +10363,21 @@ "LocationScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { - "smithy.api#documentation": "

The S3 path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://, or the S3 path to a bucket and prefix s3:///. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

", + "smithy.api#documentation": "

The S3 path to the location that you are registering. The location scope can be the\n default S3 location s3://, the S3 path to a bucket\n s3://, or the S3 path to a bucket and prefix\n s3:///. A prefix in S3 is a string of\n characters at the beginning of an object key name used to organize the objects that you\n store in your S3 buckets. For example, object key names that start with the\n engineering/ prefix or object key names that start with the\n marketing/campaigns/ prefix.

", "smithy.api#required": {} } }, "IAMRoleArn": { "target": "com.amazonaws.s3control#IAMRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants\n assumes this role to manage access to the registered location.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.s3control#TagList", "traits": { - "smithy.api#documentation": "

The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

" + "smithy.api#documentation": "

The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label\n consisting of a user-defined key and value. Tags can help you manage, identify, organize,\n search for, and filter resources.

" } } }, @@ -10339,7 +10397,7 @@ "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { - "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

" + "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigns this\n ID when you register the location. S3 Access Grants assigns the ID default to the\n default location s3:// and assigns an auto-generated ID to other locations\n that you register.

" } }, "AccessGrantsLocationArn": { @@ -10351,13 +10409,13 @@ "LocationScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { - "smithy.api#documentation": "

The S3 URI path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket, or the S3 path to a bucket and prefix. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

" + "smithy.api#documentation": "

The S3 URI path to the location that you are registering. The location scope can be the\n default S3 location s3://, the S3 path to a bucket, or the S3 path to a bucket\n and prefix. A prefix in S3 is a string of characters at the beginning of an object key name\n used to organize the objects that you store in your S3 buckets. For example, object key\n names that start with the engineering/ prefix or object key names that start\n with the marketing/campaigns/ prefix.

" } }, "IAMRoleArn": { "target": "com.amazonaws.s3control#IAMRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants\n assumes this role to manage access to the registered location.

" } } }, @@ -10374,7 +10432,7 @@ "target": "com.amazonaws.s3control#CreateAccessPointResult" }, "traits": { - "smithy.api#documentation": "

Creates an access point and associates it to a specified bucket. For more information, see\n Managing\n access to shared datasets with access points or Managing access to\n shared datasets in directory buckets with access points in the\n Amazon S3 User Guide.

\n

To create an access point and attach it to a volume on an Amazon FSx file system, see CreateAndAttachS3AccessPoint in the Amazon FSx API\n Reference.

\n

\n \n

S3 on Outposts only supports VPC-style access points.

\n

For more information, see Accessing Amazon S3 on Outposts using\n virtual private cloud (VPC) only access points in the\n Amazon S3 User Guide.

\n
\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

\n

The following actions are related to CreateAccessPoint:

\n ", + "smithy.api#documentation": "

Creates an access point and associates it to a specified bucket. For more information, see\n Managing\n access to shared datasets with access points or Managing access to\n shared datasets in directory buckets with access points in the\n Amazon S3 User Guide.

\n

To create an access point and attach it to a volume on an Amazon FSx file system, see CreateAndAttachS3AccessPoint in the Amazon FSx API\n Reference.

\n

\n \n

S3 on Outposts only supports VPC-style access points.

\n

For more information, see Accessing Amazon S3 on Outposts using\n virtual private cloud (VPC) only access points in the\n Amazon S3 User Guide.

\n
\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

\n

The following actions are related to CreateAccessPoint:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -10399,7 +10457,7 @@ "target": "com.amazonaws.s3control#CreateAccessPointForObjectLambdaResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Creates an Object Lambda Access Point. For more information, see Transforming objects with\n Object Lambda Access Points in the Amazon S3 User Guide.

\n

The following actions are related to\n CreateAccessPointForObjectLambda:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Creates an Object Lambda Access Point. For more information, see Transforming objects with\n Object Lambda Access Points in the Amazon S3 User Guide.

\n

The following actions are related to\n CreateAccessPointForObjectLambda:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -10521,7 +10579,7 @@ "BucketAccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

\n

For same account access point when your bucket and access point belong to the same account owner, the BucketAccountId is not required. \n For cross-account access point when your bucket and access point are not in the same account, the BucketAccountId is required.\n

" + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

\n

For same account access point when your bucket and access point belong to the same account owner, the\n BucketAccountId is not required. For cross-account access point when your bucket\n and access point are not in the same account, the BucketAccountId is required.

" } }, "Scope": { @@ -10533,7 +10591,7 @@ "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).

" + "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).

\n \n
    \n
  • \n

    You must have the s3:TagResource permission to create an access point with tags for a general purpose bucket.

    \n
  • \n
  • \n

    You must have the s3express:TagResource permission to create an access point with tags for a directory bucket.

    \n
  • \n
\n
" } } }, @@ -10732,7 +10790,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation creates an S3 Batch Operations job.

\n

You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.\n Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more\n information, see S3 Batch Operations in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

For information about permissions required to use the Batch Operations, see Granting permissions for S3 Batch Operations in the Amazon S3\n User Guide.

\n
\n
\n

\n

Related actions include:

\n ", + "smithy.api#documentation": "

This operation creates an S3 Batch Operations job.

\n

You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.\n Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more\n information, see S3 Batch Operations in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

For information about permissions required to use the Batch Operations, see Granting\n permissions for S3 Batch Operations in the Amazon S3 User\n Guide.

\n
\n
\n

\n

Related actions include:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -10859,7 +10917,7 @@ "target": "com.amazonaws.s3control#CreateMultiRegionAccessPointResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Creates a Multi-Region Access Point and associates it with the specified buckets. For more information\n about creating Multi-Region Access Points, see Creating Multi-Region Access Points in the Amazon S3 User Guide.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.

\n

This request is asynchronous, meaning that you might receive a response before the\n command has completed. When this request provides a response, it provides a token that you\n can use to monitor the status of the request with\n DescribeMultiRegionAccessPointOperation.

\n

The following actions are related to CreateMultiRegionAccessPoint:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Creates a Multi-Region Access Point and associates it with the specified buckets. For more information\n about creating Multi-Region Access Points, see Creating\n Multi-Region Access Points in the Amazon S3 User Guide.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.

\n

This request is asynchronous, meaning that you might receive a response before the\n command has completed. When this request provides a response, it provides a token that you\n can use to monitor the status of the request with\n DescribeMultiRegionAccessPointOperation.

\n

The following actions are related to CreateMultiRegionAccessPoint:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -10959,7 +11017,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID. An\n S3 Storage Lens group is a custom grouping of objects based on prefix, suffix, object tags,\n object size, object age, or a combination of these filters. For each Storage Lens group\n that you’ve created, you can also optionally add Amazon Web Services resource tags. For more information\n about S3 Storage Lens groups, see Working with S3 Storage Lens\n groups.

\n

To use this operation, you must have the permission to perform the\n s3:CreateStorageLensGroup action. If you’re trying to create a Storage Lens\n group with Amazon Web Services resource tags, you must also have permission to perform the\n s3:TagResource action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

\n

For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.

", + "smithy.api#documentation": "

Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID. An\n S3 Storage Lens group is a custom grouping of objects based on prefix, suffix, object tags,\n object size, object age, or a combination of these filters. For each Storage Lens group\n that you’ve created, you can also optionally add Amazon Web Services resource tags. For more information\n about S3 Storage Lens groups, see Working with S3 Storage Lens\n groups.

\n

To use this operation, you must have the permission to perform the\n s3:CreateStorageLensGroup action. If you’re trying to create a Storage Lens\n group with Amazon Web Services resource tags, you must also have permission to perform the\n s3:TagResource action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

\n

For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11020,33 +11078,47 @@ "AccessKeyId": { "target": "com.amazonaws.s3control#AccessKeyId", "traits": { - "smithy.api#documentation": "

The unique access key ID of the Amazon Web Services STS temporary credential that S3 Access Grants vends to grantees and client applications.

" + "smithy.api#documentation": "

The unique access key ID of the Amazon Web Services STS temporary credential that S3 Access Grants vends to grantees\n and client applications.

" } }, "SecretAccessKey": { "target": "com.amazonaws.s3control#SecretAccessKey", "traits": { - "smithy.api#documentation": "

The secret access key of the Amazon Web Services STS temporary credential that S3 Access Grants vends to grantees and client applications.

" + "smithy.api#documentation": "

The secret access key of the Amazon Web Services STS temporary credential that S3 Access Grants vends to grantees\n and client applications.

" } }, "SessionToken": { "target": "com.amazonaws.s3control#SessionToken", "traits": { - "smithy.api#documentation": "

The Amazon Web Services STS temporary credential that S3 Access Grants vends to grantees and client applications.

" + "smithy.api#documentation": "

The Amazon Web Services STS temporary credential that S3 Access Grants vends to grantees and client applications.\n

" } }, "Expiration": { "target": "com.amazonaws.s3control#Expiration", "traits": { - "smithy.api#documentation": "

The expiration date and time of the temporary credential that S3 Access Grants vends to grantees and client applications.

" + "smithy.api#documentation": "

The expiration date and time of the temporary credential that S3 Access Grants vends to grantees\n and client applications.

" } } }, "traits": { - "smithy.api#documentation": "

The Amazon Web Services Security Token Service temporary credential that S3 Access Grants vends to grantees and client applications.

", + "smithy.api#documentation": "

The Amazon Web Services Security Token Service temporary credential that S3 Access Grants vends to grantees and client\n applications.

", "smithy.api#sensitive": {} } }, + "com.amazonaws.s3control#DSSEKMSFilter": { + "type": "structure", + "members": { + "KmsKeyArn": { + "target": "com.amazonaws.s3control#NonEmptyKmsKeyArnString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer managed KMS key to use for the filter \n to return objects that are encrypted by the specified key. For best performance, \n we recommend using the KMSKeyArn filter in conjunction with other object metadata filters, like MatchAnyPrefix, CreatedAfter, or \n MatchAnyStorageClass.

\n \n

You must provide the full KMS Key ARN. You can't use an alias name or alias ARN. \n For more information, see \n KMS keys in the Amazon Web Services Key Management Service Developer Guide.

\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that returns objects that are encrypted by dual-layer server-side encryption with Amazon Web Services Key Management\n Service (KMS) keys (DSSE-KMS). You can further refine your filtering by optionally providing a KMS Key ARN \n to create an object list of DSSE-KMS objects with that specific KMS Key ARN.

" + } + }, "com.amazonaws.s3control#DataSourceId": { "type": "string", "traits": { @@ -11083,7 +11155,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes the access grant from the S3 Access Grants instance. You cannot undo an access grant deletion and the grantee will no longer have access to the S3 data.

\n
\n
Permissions
\n
\n

You must have the s3:DeleteAccessGrant permission to use this operation.

\n
\n
", + "smithy.api#documentation": "

Deletes the access grant from the S3 Access Grants instance. You cannot undo an access grant\n deletion and the grantee will no longer have access to the S3 data.

\n
\n
Permissions
\n
\n

You must have the s3:DeleteAccessGrant permission to use this\n operation.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11118,7 +11190,7 @@ "AccessGrantId": { "target": "com.amazonaws.s3control#AccessGrantId", "traits": { - "smithy.api#documentation": "

The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

", + "smithy.api#documentation": "

The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access\n grant.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11137,7 +11209,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes your S3 Access Grants instance. You must first delete the access grants and locations before S3 Access Grants can delete the instance. See DeleteAccessGrant and DeleteAccessGrantsLocation. If you have associated an IAM Identity Center instance with your S3 Access Grants instance, you must first dissassociate the Identity Center instance from the S3 Access Grants instance before you can delete the S3 Access Grants instance. See AssociateAccessGrantsIdentityCenter and DissociateAccessGrantsIdentityCenter.

\n
\n
Permissions
\n
\n

You must have the s3:DeleteAccessGrantsInstance permission to use this operation.

\n
\n
", + "smithy.api#documentation": "

Deletes your S3 Access Grants instance. You must first delete the access grants and locations\n before S3 Access Grants can delete the instance. See DeleteAccessGrant\n and DeleteAccessGrantsLocation. If you have associated an IAM Identity Center\n instance with your S3 Access Grants instance, you must first dissassociate the Identity Center\n instance from the S3 Access Grants instance before you can delete the S3 Access Grants instance. See AssociateAccessGrantsIdentityCenter and DissociateAccessGrantsIdentityCenter.

\n
\n
Permissions
\n
\n

You must have the s3:DeleteAccessGrantsInstance permission to use\n this operation.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11183,7 +11255,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes the resource policy of the S3 Access Grants instance. The resource policy is used to manage cross-account access to your S3 Access Grants instance. By deleting the resource policy, you delete any cross-account permissions to your S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:DeleteAccessGrantsInstanceResourcePolicy permission to use this operation.

\n
\n
", + "smithy.api#documentation": "

Deletes the resource policy of the S3 Access Grants instance. The resource policy is used to\n manage cross-account access to your S3 Access Grants instance. By deleting the resource policy, you\n delete any cross-account permissions to your S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:DeleteAccessGrantsInstanceResourcePolicy\n permission to use this operation.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11229,7 +11301,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deregisters a location from your S3 Access Grants instance. You can only delete a location registration from an S3 Access Grants instance if there are no grants associated with this location. See Delete a grant for information on how to delete grants. You need to have at least one registered location in your S3 Access Grants instance in order to create access grants.

\n
\n
Permissions
\n
\n

You must have the s3:DeleteAccessGrantsLocation permission to use this operation.

\n
\n
", + "smithy.api#documentation": "

Deregisters a location from your S3 Access Grants instance. You can only delete a location\n registration from an S3 Access Grants instance if there are no grants associated with this location.\n See Delete a grant for\n information on how to delete grants. You need to have at least one registered location in\n your S3 Access Grants instance in order to create access grants.

\n
\n
Permissions
\n
\n

You must have the s3:DeleteAccessGrantsLocation permission to use\n this operation.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11264,7 +11336,7 @@ "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { - "smithy.api#documentation": "

The ID of the registered location that you are deregistering from your S3 Access Grants instance. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

", + "smithy.api#documentation": "

The ID of the registered location that you are deregistering from your S3 Access Grants instance.\n S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID\n default to the default location s3:// and assigns an\n auto-generated ID to other locations that you register.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11283,7 +11355,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes the specified access point.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteAccessPoint:

\n ", + "smithy.api#documentation": "

Deletes the specified access point.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteAccessPoint:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11308,7 +11380,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Deletes the specified Object Lambda Access Point.

\n

The following actions are related to\n DeleteAccessPointForObjectLambda:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Deletes the specified Object Lambda Access Point.

\n

The following actions are related to\n DeleteAccessPointForObjectLambda:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11361,7 +11433,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes the access point policy for the specified access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteAccessPointPolicy:

\n ", + "smithy.api#documentation": "

Deletes the access point policy for the specified access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteAccessPointPolicy:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11386,7 +11458,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Removes the resource policy for an Object Lambda Access Point.

\n

The following actions are related to\n DeleteAccessPointPolicyForObjectLambda:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Removes the resource policy for an Object Lambda Access Point.

\n

The following actions are related to\n DeleteAccessPointPolicyForObjectLambda:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11501,7 +11573,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

\n Deletes an existing access point scope for a directory bucket.

\n \n

When you delete the scope of an access point, all prefixes and permissions are deleted.

\n
\n

To use this operation, you must have the permission to perform the\n s3express:DeleteAccessPointScope action.

\n

For information about REST API errors, see REST error responses.

", + "smithy.api#documentation": "

Deletes an existing access point scope for a directory bucket.

\n \n

When you delete the scope of an access point, all prefixes and permissions are\n deleted.

\n
\n

To use this operation, you must have the permission to perform the\n s3express:DeleteAccessPointScope\n action.

\n

For information about REST API errors, see REST error responses.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#http": { "method": "DELETE", "uri": "/v20180820/accesspoint/{Name}/scope", @@ -11523,7 +11595,7 @@ "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { - "smithy.api#documentation": "

\n The Amazon Web Services account ID that owns the access point with the scope that you want to delete.\n

", + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the access point with the scope that you want to delete.

", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, @@ -11535,7 +11607,7 @@ "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { - "smithy.api#documentation": "

\n The name of the access point with the scope that you want to delete.\n

", + "smithy.api#documentation": "

The name of the access point with the scope that you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -11582,7 +11654,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete\n an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.

\n
\n

Deletes the lifecycle configuration from the specified Outposts bucket.\n Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource\n associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer\n automatically deletes any objects on the basis of rules contained in the deleted lifecycle\n configuration. For more information, see Using Amazon S3 on Outposts in\n Amazon S3 User Guide.

\n

To use this operation, you must have permission to perform the\n s3-outposts:PutLifecycleConfiguration action. By default, the bucket owner\n has this permission and the Outposts bucket owner can grant this permission to\n others.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

For more information about object expiration, see Elements to Describe Lifecycle Actions.

\n

Related actions include:

\n ", + "smithy.api#documentation": "\n

This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete\n an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.

\n
\n

Deletes the lifecycle configuration from the specified Outposts bucket.\n Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource\n associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer\n automatically deletes any objects on the basis of rules contained in the deleted lifecycle\n configuration. For more information, see Using Amazon S3 on Outposts in\n Amazon S3 User Guide.

\n

To use this operation, you must have permission to perform the\n s3-outposts:PutLifecycleConfiguration action. By default, the bucket owner\n has this permission and the Outposts bucket owner can grant this permission to\n others.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

For more information about object expiration, see Elements to Describe Lifecycle Actions.

\n

Related actions include:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11638,7 +11710,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy,\n see DeleteBucketPolicy in the Amazon S3 API Reference.

\n
\n

This implementation of the DELETE action uses the policy subresource to delete the\n policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the\n root user of the Amazon Web Services account that owns the bucket, the calling identity must have the\n s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket\n and belong to the bucket owner's account to use this action. For more information, see\n Using\n Amazon S3 on Outposts in Amazon S3 User Guide.

\n

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n \n

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this action, even if the policy explicitly denies the root user the ability\n to perform this action.

\n
\n

For more information about bucket policies, see Using Bucket Policies and User\n Policies.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteBucketPolicy:

\n ", + "smithy.api#documentation": "\n

This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy,\n see DeleteBucketPolicy in the Amazon S3 API Reference.

\n
\n

This implementation of the DELETE action uses the policy subresource to delete the\n policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the\n root user of the Amazon Web Services account that owns the bucket, the calling identity must have the\n s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket\n and belong to the bucket owner's account to use this action. For more information, see\n Using\n Amazon S3 on Outposts in Amazon S3 User Guide.

\n

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n \n

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this action, even if the policy explicitly denies the root user the ability\n to perform this action.

\n
\n

For more information about bucket policies, see Using Bucket Policies and User\n Policies.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteBucketPolicy:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11694,7 +11766,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This operation deletes an Amazon S3 on Outposts bucket's replication configuration. To\n delete an S3 bucket's replication configuration, see DeleteBucketReplication in the Amazon S3 API Reference.

\n
\n

Deletes the replication configuration from the specified S3 on Outposts bucket.

\n

To use this operation, you must have permissions to perform the\n s3-outposts:PutReplicationConfiguration action. The Outposts bucket owner\n has this permission by default and can grant it to others. For more information about\n permissions, see Setting up IAM with\n S3 on Outposts and Managing access to\n S3 on Outposts buckets in the Amazon S3 User Guide.

\n \n

It can take a while to propagate PUT or DELETE requests for\n a replication configuration to all S3 on Outposts systems. Therefore, the replication\n configuration that's returned by a GET request soon after a\n PUT or DELETE request might return a more recent result\n than what's on the Outpost. If an Outpost is offline, the delay in updating the\n replication configuration on that Outpost can be significant.

\n
\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the\n Amazon S3 User Guide.

\n

The following operations are related to DeleteBucketReplication:

\n ", + "smithy.api#documentation": "\n

This operation deletes an Amazon S3 on Outposts bucket's replication configuration. To\n delete an S3 bucket's replication configuration, see DeleteBucketReplication in the Amazon S3 API Reference.

\n
\n

Deletes the replication configuration from the specified S3 on Outposts bucket.

\n

To use this operation, you must have permissions to perform the\n s3-outposts:PutReplicationConfiguration action. The Outposts bucket owner\n has this permission by default and can grant it to others. For more information about\n permissions, see Setting up IAM with\n S3 on Outposts and Managing access to\n S3 on Outposts buckets in the Amazon S3 User Guide.

\n \n

It can take a while to propagate PUT or DELETE requests for\n a replication configuration to all S3 on Outposts systems. Therefore, the replication\n configuration that's returned by a GET request soon after a\n PUT or DELETE request might return a more recent result\n than what's on the Outpost. If an Outpost is offline, the delay in updating the\n replication configuration on that Outpost can be significant.

\n
\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the\n Amazon S3 User Guide.

\n

The following operations are related to DeleteBucketReplication:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11781,7 +11853,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags,\n see DeleteBucketTagging in the Amazon S3 API Reference.

\n
\n

Deletes the tags from the Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in Amazon S3 User Guide.

\n

To use this action, you must have permission to perform the\n PutBucketTagging action. By default, the bucket owner has this permission\n and can grant this permission to others.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteBucketTagging:

\n ", + "smithy.api#documentation": "\n

This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags,\n see DeleteBucketTagging in the Amazon S3 API Reference.

\n
\n

Deletes the tags from the Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in Amazon S3 User Guide.

\n

To use this action, you must have permission to perform the\n PutBucketTagging action. By default, the bucket owner has this permission\n and can grant this permission to others.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to DeleteBucketTagging:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11848,7 +11920,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the entire tag set from the specified S3 Batch Operations job.

\n
\n
Permissions
\n
\n

To use the\n DeleteJobTagging operation, you must have permission to\n perform the s3:DeleteJobTagging action. For more information, see Controlling\n access and labeling jobs using tags in the\n Amazon S3 User Guide.

\n
\n
\n

Related actions include:

\n ", + "smithy.api#documentation": "

Removes the entire tag set from the specified S3 Batch Operations job.

\n
\n
Permissions
\n
\n

To use the DeleteJobTagging operation, you must have permission to\n perform the s3:DeleteJobTagging action. For more information, see\n Controlling access and labeling jobs using tags in the\n Amazon S3 User Guide.

\n
\n
\n

Related actions include:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -11940,7 +12012,7 @@ "target": "com.amazonaws.s3control#DeleteMultiRegionAccessPointResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point,\n only the Multi-Region Access Point itself.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.

\n

This request is asynchronous, meaning that you might receive a response before the\n command has completed. When this request provides a response, it provides a token that you\n can use to monitor the status of the request with\n DescribeMultiRegionAccessPointOperation.

\n

The following actions are related to DeleteMultiRegionAccessPoint:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point,\n only the Multi-Region Access Point itself.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.

\n

This request is asynchronous, meaning that you might receive a response before the\n command has completed. When this request provides a response, it provides a token that you\n can use to monitor the status of the request with\n DescribeMultiRegionAccessPointOperation.

\n

The following actions are related to DeleteMultiRegionAccessPoint:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -12030,7 +12102,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Removes the PublicAccessBlock configuration for an Amazon Web Services account. For more\n information, see Using Amazon S3 block\n public access.

\n

Related actions include:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Removes the PublicAccessBlock configuration for an Amazon Web Services account. For more\n information, see Using Amazon S3 block\n public access.

\n

Related actions include:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -12075,7 +12147,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage\n activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:DeleteStorageLensConfiguration action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n
", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage\n activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:DeleteStorageLensConfiguration action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -12128,7 +12200,7 @@ "target": "com.amazonaws.s3control#DeleteStorageLensConfigurationTaggingResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:DeleteStorageLensConfigurationTagging action. For more information,\n see Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n
", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:DeleteStorageLensConfigurationTagging action. For more information,\n see Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -12188,7 +12260,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

\nDeletes an existing S3 Storage Lens group.

\n

To use this operation, you must have the permission to perform the\n s3:DeleteStorageLensGroup action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

\n

For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.

", + "smithy.api#documentation": "

\nDeletes an existing S3 Storage Lens group.

\n

To use this operation, you must have the permission to perform the\n s3:DeleteStorageLensGroup action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

\n

For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -12255,7 +12327,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the configuration parameters and status for a Batch Operations job. For more\n information, see S3 Batch Operations in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use the DescribeJob operation, you must have permission to perform the s3:DescribeJob action.

\n
\n
\n

Related actions include:

\n ", + "smithy.api#documentation": "

Retrieves the configuration parameters and status for a Batch Operations job. For more\n information, see S3 Batch Operations in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use the DescribeJob operation, you must have permission to\n perform the s3:DescribeJob action.

\n
\n
\n

Related actions include:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -12322,7 +12394,7 @@ "target": "com.amazonaws.s3control#DescribeMultiRegionAccessPointOperationResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information\n about managing Multi-Region Access Points and how asynchronous requests work, see Using Multi-Region Access Points in the Amazon S3 User Guide.

\n

The following actions are related to GetMultiRegionAccessPoint:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information\n about managing Multi-Region Access Points and how asynchronous requests work, see Using Multi-Region Access Points in the\n Amazon S3 User Guide.

\n

The following actions are related to GetMultiRegionAccessPoint:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -12456,7 +12528,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Dissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:DissociateAccessGrantsIdentityCenter permission to use this operation.

\n
\n
Additional Permissions
\n
\n

You must have the sso:DeleteApplication permission to use this operation.

\n
\n
", + "smithy.api#documentation": "

Dissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:DissociateAccessGrantsIdentityCenter\n permission to use this operation.

\n
\n
Additional Permissions
\n
\n

You must have the sso:DeleteApplication permission to use this\n operation.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -12513,7 +12585,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies encryption-related information for an Amazon S3 bucket that is a destination for\n replicated objects. If you're specifying a customer managed KMS key, we recommend using a fully qualified\n KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the\n requester’s account. This behavior can result in data that's encrypted with a KMS key\n that belongs to the requester, and not the bucket owner.

\n \n

This is not supported by Amazon S3 on Outposts buckets.

\n
" + "smithy.api#documentation": "

Specifies encryption-related information for an Amazon S3 bucket that is a destination for\n replicated objects. If you're specifying a customer managed KMS key, we recommend using a\n fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves\n the key within the requester’s account. This behavior can result in data that's encrypted\n with a KMS key that belongs to the requester, and not the bucket owner.

\n \n

This is not supported by Amazon S3 on Outposts buckets.

\n
" } }, "com.amazonaws.s3control#Endpoints": { @@ -12695,7 +12767,7 @@ "target": "com.amazonaws.s3control#GetAccessGrantResult" }, "traits": { - "smithy.api#documentation": "

Get the details of an access grant from your S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:GetAccessGrant permission to use this operation.

\n
\n
", + "smithy.api#documentation": "

Get the details of an access grant from your S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:GetAccessGrant permission to use this\n operation.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -12730,7 +12802,7 @@ "AccessGrantId": { "target": "com.amazonaws.s3control#AccessGrantId", "traits": { - "smithy.api#documentation": "

The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

", + "smithy.api#documentation": "

The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access\n grant.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12752,7 +12824,7 @@ "AccessGrantId": { "target": "com.amazonaws.s3control#AccessGrantId", "traits": { - "smithy.api#documentation": "

The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

" + "smithy.api#documentation": "

The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access\n grant.

" } }, "AccessGrantArn": { @@ -12764,37 +12836,37 @@ "Grantee": { "target": "com.amazonaws.s3control#Grantee", "traits": { - "smithy.api#documentation": "

The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added a corporate directory to Amazon Web Services IAM Identity Center and associated this Identity Center instance with the S3 Access Grants instance, the grantee can also be a corporate directory user or group.

" + "smithy.api#documentation": "

The user, group, or role to which you are granting access. You can grant access to an\n IAM user or role. If you have added a corporate directory to Amazon Web Services IAM Identity Center\n and associated this Identity Center instance with the S3 Access Grants instance, the grantee can also\n be a corporate directory user or group.

" } }, "Permission": { "target": "com.amazonaws.s3control#Permission", "traits": { - "smithy.api#documentation": "

The type of permission that was granted in the access grant. Can be one of the following values:

\n
    \n
  • \n

    \n READ – Grant read-only access to the S3 data.

    \n
  • \n
  • \n

    \n WRITE – Grant write-only access to the S3 data.

    \n
  • \n
  • \n

    \n READWRITE – Grant both read and write access to the S3 data.

    \n
  • \n
" + "smithy.api#documentation": "

The type of permission that was granted in the access grant. Can be one of the following\n values:

\n
    \n
  • \n

    \n READ – Grant read-only access to the S3 data.

    \n
  • \n
  • \n

    \n WRITE – Grant write-only access to the S3 data.

    \n
  • \n
  • \n

    \n READWRITE – Grant both read and write access to the S3 data.

    \n
  • \n
" } }, "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { - "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

" + "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigns this\n ID when you register the location. S3 Access Grants assigns the ID default to the\n default location s3:// and assigns an auto-generated ID to other locations\n that you register.

" } }, "AccessGrantsLocationConfiguration": { "target": "com.amazonaws.s3control#AccessGrantsLocationConfiguration", "traits": { - "smithy.api#documentation": "

The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.

" + "smithy.api#documentation": "

The configuration options of the grant location. The grant location is the S3 path to\n the data to which you are granting access.

" } }, "GrantScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { - "smithy.api#documentation": "

The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.

" + "smithy.api#documentation": "

The S3 path of the data to which you are granting access. It is the result of appending\n the Subprefix to the location scope.

" } }, "ApplicationArn": { "target": "com.amazonaws.s3control#IdentityCenterApplicationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated\n with your Identity Center instance. If the grant includes an application ARN, the grantee\n can only access the S3 data through this application.

" } } }, @@ -12811,7 +12883,7 @@ "target": "com.amazonaws.s3control#GetAccessGrantsInstanceResult" }, "traits": { - "smithy.api#documentation": "

Retrieves the S3 Access Grants instance for a Region in your account.

\n
\n
Permissions
\n
\n

You must have the s3:GetAccessGrantsInstance permission to use this operation.

\n
\n
\n \n

\n GetAccessGrantsInstance is not supported for cross-account access. You can only call the API from the account that owns the S3 Access Grants instance.

\n
", + "smithy.api#documentation": "

Retrieves the S3 Access Grants instance for a Region in your account.

\n
\n
Permissions
\n
\n

You must have the s3:GetAccessGrantsInstance permission to use\n this operation.

\n
\n
\n \n

\n GetAccessGrantsInstance is not supported for cross-account access. You can only call the API from the account that owns the S3 Access Grants instance.

\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -12837,7 +12909,7 @@ "target": "com.amazonaws.s3control#GetAccessGrantsInstanceForPrefixResult" }, "traits": { - "smithy.api#documentation": "

Retrieve the S3 Access Grants instance that contains a particular prefix.

\n
\n
Permissions
\n
\n

You must have the s3:GetAccessGrantsInstanceForPrefix permission for the caller account to use this operation.

\n
\n
Additional Permissions
\n
\n

The prefix owner account must grant you the following permissions to their S3 Access Grants instance: s3:GetAccessGrantsInstanceForPrefix.

\n
\n
", + "smithy.api#documentation": "

Retrieve the S3 Access Grants instance that contains a particular prefix.

\n
\n
Permissions
\n
\n

You must have the s3:GetAccessGrantsInstanceForPrefix permission\n for the caller account to use this operation.

\n
\n
Additional Permissions
\n
\n

The prefix owner account must grant you the following permissions to their\n S3 Access Grants instance: s3:GetAccessGrantsInstanceForPrefix.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -12894,7 +12966,7 @@ "AccessGrantsInstanceId": { "target": "com.amazonaws.s3control#AccessGrantsInstanceId", "traits": { - "smithy.api#documentation": "

The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants instance per Region per account.

" + "smithy.api#documentation": "

The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants\n instance per Region per account.

" } } }, @@ -12931,7 +13003,7 @@ "target": "com.amazonaws.s3control#GetAccessGrantsInstanceResourcePolicyResult" }, "traits": { - "smithy.api#documentation": "

Returns the resource policy of the S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:GetAccessGrantsInstanceResourcePolicy permission to use this operation.

\n
\n
", + "smithy.api#documentation": "

Returns the resource policy of the S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:GetAccessGrantsInstanceResourcePolicy\n permission to use this operation.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13006,7 +13078,7 @@ "AccessGrantsInstanceId": { "target": "com.amazonaws.s3control#AccessGrantsInstanceId", "traits": { - "smithy.api#documentation": "

The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants instance per Region per account.

" + "smithy.api#documentation": "

The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants\n instance per Region per account.

" } }, "IdentityCenterArn": { @@ -13015,19 +13087,19 @@ "smithy.api#deprecated": { "message": "IdentityCenterArn has been deprecated. Use IdentityCenterInstanceArn or IdentityCenterApplicationArn." }, - "smithy.api#documentation": "

If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.

" + "smithy.api#documentation": "

If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance,\n this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance\n application; a subresource of the original Identity Center instance. S3 Access Grants creates this\n Identity Center application for the specific S3 Access Grants instance.

" } }, "IdentityCenterInstanceArn": { "target": "com.amazonaws.s3control#IdentityCenterArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are\n associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate\n identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center\n instances and their ARNs.

" } }, "IdentityCenterApplicationArn": { "target": "com.amazonaws.s3control#IdentityCenterApplicationArn", "traits": { - "smithy.api#documentation": "

If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.

" + "smithy.api#documentation": "

If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance,\n this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance\n application; a subresource of the original Identity Center instance. S3 Access Grants creates this\n Identity Center application for the specific S3 Access Grants instance.

" } }, "CreatedAt": { @@ -13050,7 +13122,7 @@ "target": "com.amazonaws.s3control#GetAccessGrantsLocationResult" }, "traits": { - "smithy.api#documentation": "

Retrieves the details of a particular location registered in your S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:GetAccessGrantsLocation permission to use this operation.

\n
\n
", + "smithy.api#documentation": "

Retrieves the details of a particular location registered in your S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:GetAccessGrantsLocation permission to use\n this operation.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13085,7 +13157,7 @@ "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { - "smithy.api#documentation": "

The ID of the registered location that you are retrieving. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

", + "smithy.api#documentation": "

The ID of the registered location that you are retrieving. S3 Access Grants assigns this ID when\n you register the location. S3 Access Grants assigns the ID default to the default\n location s3:// and assigns an auto-generated ID to other locations that you\n register.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13107,7 +13179,7 @@ "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { - "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

" + "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigns this\n ID when you register the location. S3 Access Grants assigns the ID default to the\n default location s3:// and assigns an auto-generated ID to other locations\n that you register.

" } }, "AccessGrantsLocationArn": { @@ -13119,13 +13191,13 @@ "LocationScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { - "smithy.api#documentation": "

The S3 URI path to the registered location. The location scope can be the default S3 location s3://, the S3 path to a bucket, or the S3 path to a bucket and prefix. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

" + "smithy.api#documentation": "

The S3 URI path to the registered location. The location scope can be the default S3\n location s3://, the S3 path to a bucket, or the S3 path to a bucket and\n prefix. A prefix in S3 is a string of characters at the beginning of an object key name\n used to organize the objects that you store in your S3 buckets. For example, object key\n names that start with the engineering/ prefix or object key names that start\n with the marketing/campaigns/ prefix.

" } }, "IAMRoleArn": { "target": "com.amazonaws.s3control#IAMRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants\n assumes this role to manage access to the registered location.

" } } }, @@ -13142,7 +13214,7 @@ "target": "com.amazonaws.s3control#GetAccessPointResult" }, "traits": { - "smithy.api#documentation": "

Returns configuration information about the specified access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to GetAccessPoint:

\n ", + "smithy.api#documentation": "

Returns configuration information about the specified access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to GetAccessPoint:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13167,7 +13239,7 @@ "target": "com.amazonaws.s3control#GetAccessPointConfigurationForObjectLambdaResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns configuration for an Object Lambda Access Point.

\n

The following actions are related to\n GetAccessPointConfigurationForObjectLambda:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns configuration for an Object Lambda Access Point.

\n

The following actions are related to\n GetAccessPointConfigurationForObjectLambda:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13234,7 +13306,7 @@ "target": "com.amazonaws.s3control#GetAccessPointForObjectLambdaResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns configuration information about the specified Object Lambda Access Point

\n

The following actions are related to GetAccessPointForObjectLambda:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns configuration information about the specified Object Lambda Access Point

\n

The following actions are related to GetAccessPointForObjectLambda:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13319,7 +13391,7 @@ "target": "com.amazonaws.s3control#GetAccessPointPolicyResult" }, "traits": { - "smithy.api#documentation": "

Returns the access point policy associated with the specified access point.

\n

The following actions are related to GetAccessPointPolicy:

\n ", + "smithy.api#documentation": "

Returns the access point policy associated with the specified access point.

\n

The following actions are related to GetAccessPointPolicy:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13344,7 +13416,7 @@ "target": "com.amazonaws.s3control#GetAccessPointPolicyForObjectLambdaResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns the resource policy for an Object Lambda Access Point.

\n

The following actions are related to\n GetAccessPointPolicyForObjectLambda:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns the resource policy for an Object Lambda Access Point.

\n

The following actions are related to\n GetAccessPointPolicyForObjectLambda:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13456,7 +13528,7 @@ "target": "com.amazonaws.s3control#GetAccessPointPolicyStatusResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Indicates whether the specified access point currently has a policy that allows public access.\n For more information about public access through access points, see Managing Data Access with Amazon S3\n access points in the Amazon S3 User Guide.

", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Indicates whether the specified access point currently has a policy that allows public access.\n For more information about public access through access points, see Managing Data Access with Amazon S3\n access points in the Amazon S3 User Guide.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13481,7 +13553,7 @@ "target": "com.amazonaws.s3control#GetAccessPointPolicyStatusForObjectLambdaResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns the status of the resource policy associated with an Object Lambda Access Point.

", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns the status of the resource policy associated with an Object Lambda Access Point.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13698,7 +13770,7 @@ "target": "com.amazonaws.s3control#GetAccessPointScopeResult" }, "traits": { - "smithy.api#documentation": "

\n Returns the access point scope for a directory bucket.

\n

To use this operation, you must have the permission to perform the\n s3express:GetAccessPointScope action.

\n

For information about REST API errors, see REST error responses.

", + "smithy.api#documentation": "

Returns the access point scope for a directory bucket.

\n

To use this operation, you must have the permission to perform the\n s3express:GetAccessPointScope\n action.

\n

For information about REST API errors, see REST error responses.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#http": { "method": "GET", "uri": "/v20180820/accesspoint/{Name}/scope", @@ -13720,7 +13792,7 @@ "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { - "smithy.api#documentation": "

\n The Amazon Web Services account ID that owns the access point with the scope that you want to retrieve.\n

", + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the access point with the scope that you want to retrieve.\n

", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, @@ -13768,7 +13840,7 @@ "target": "com.amazonaws.s3control#GetBucketResult" }, "traits": { - "smithy.api#documentation": "

Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide.

\n

If you are using an identity other than the root user of the Amazon Web Services account that owns the\n Outposts bucket, the calling identity must have the s3-outposts:GetBucket\n permissions on the specified Outposts bucket and belong to the Outposts bucket owner's\n account in order to use this action. Only users from Outposts bucket owner account with\n the right permissions can perform actions on an Outposts bucket.

\n

If you don't have s3-outposts:GetBucket permissions or you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access\n Denied error.

\n

The following actions are related to GetBucket for Amazon S3 on Outposts:

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n ", + "smithy.api#documentation": "

Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide.

\n

If you are using an identity other than the root user of the Amazon Web Services account that owns the\n Outposts bucket, the calling identity must have the s3-outposts:GetBucket\n permissions on the specified Outposts bucket and belong to the Outposts bucket owner's\n account in order to use this action. Only users from Outposts bucket owner account with\n the right permissions can perform actions on an Outposts bucket.

\n

If you don't have s3-outposts:GetBucket permissions or you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access\n Denied error.

\n

The following actions are related to GetBucket for Amazon S3 on Outposts:

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13793,7 +13865,7 @@ "target": "com.amazonaws.s3control#GetBucketLifecycleConfigurationResult" }, "traits": { - "smithy.api#documentation": "\n

This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3\n bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.\n

\n
\n

Returns the lifecycle configuration information set on the Outposts bucket. For more\n information, see Using Amazon S3 on Outposts and for\n information about lifecycle configuration, see Object Lifecycle\n Management in Amazon S3 User Guide.

\n

To use this action, you must have permission to perform the\n s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner\n has this permission, by default. The bucket owner can grant this permission to others. For\n more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

\n GetBucketLifecycleConfiguration has the following special error:

\n
    \n
  • \n

    Error code: NoSuchLifecycleConfiguration\n

    \n
      \n
    • \n

      Description: The lifecycle configuration does not exist.

      \n
    • \n
    • \n

      HTTP Status Code: 404 Not Found

      \n
    • \n
    • \n

      SOAP Fault Code Prefix: Client

      \n
    • \n
    \n
  • \n
\n

The following actions are related to\n GetBucketLifecycleConfiguration:

\n ", + "smithy.api#documentation": "\n

This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3\n bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.\n

\n
\n

Returns the lifecycle configuration information set on the Outposts bucket. For more\n information, see Using Amazon S3 on Outposts and for\n information about lifecycle configuration, see Object Lifecycle\n Management in Amazon S3 User Guide.

\n

To use this action, you must have permission to perform the\n s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner\n has this permission, by default. The bucket owner can grant this permission to others. For\n more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

\n GetBucketLifecycleConfiguration has the following special error:

\n
    \n
  • \n

    Error code: NoSuchLifecycleConfiguration\n

    \n
      \n
    • \n

      Description: The lifecycle configuration does not exist.

      \n
    • \n
    • \n

      HTTP Status Code: 404 Not Found

      \n
    • \n
    • \n

      SOAP Fault Code Prefix: Client

      \n
    • \n
    \n
  • \n
\n

The following actions are related to\n GetBucketLifecycleConfiguration:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -13863,7 +13935,7 @@ "target": "com.amazonaws.s3control#GetBucketPolicyResult" }, "traits": { - "smithy.api#documentation": "\n

This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for\n an S3 bucket, see GetBucketPolicy in the\n Amazon S3 API Reference.

\n
\n

Returns the policy of a specified Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in the Amazon S3 User Guide.

\n

If you are using an identity other than the root user of the Amazon Web Services account that owns the\n bucket, the calling identity must have the GetBucketPolicy permissions on the\n specified bucket and belong to the bucket owner's account in order to use this\n action.

\n

Only users from Outposts bucket owner account with the right permissions can perform\n actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy\n permissions or you're not using an identity that belongs to the bucket owner's account,\n Amazon S3 returns a 403 Access Denied error.

\n \n

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this action, even if the policy explicitly denies the root user the ability\n to perform this action.

\n
\n

For more information about bucket policies, see Using Bucket Policies and User\n Policies.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to GetBucketPolicy:

\n ", + "smithy.api#documentation": "\n

This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for\n an S3 bucket, see GetBucketPolicy in the\n Amazon S3 API Reference.

\n
\n

Returns the policy of a specified Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in the Amazon S3 User Guide.

\n

If you are using an identity other than the root user of the Amazon Web Services account that owns the\n bucket, the calling identity must have the GetBucketPolicy permissions on the\n specified bucket and belong to the bucket owner's account in order to use this\n action.

\n

Only users from Outposts bucket owner account with the right permissions can perform\n actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy\n permissions or you're not using an identity that belongs to the bucket owner's account,\n Amazon S3 returns a 403 Access Denied error.

\n \n

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this action, even if the policy explicitly denies the root user the ability\n to perform this action.

\n
\n

For more information about bucket policies, see Using Bucket Policies and User\n Policies.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to GetBucketPolicy:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -14209,7 +14281,7 @@ "target": "com.amazonaws.s3control#GetDataAccessResult" }, "traits": { - "smithy.api#documentation": "

Returns a temporary access credential from S3 Access Grants to the grantee or client application. The temporary credential is an Amazon Web Services STS token that grants them access to the S3 data.

\n
\n
Permissions
\n
\n

You must have the s3:GetDataAccess permission to use this operation.

\n
\n
Additional Permissions
\n
\n

The IAM role that S3 Access Grants assumes must have the following permissions specified in the trust policy when registering the location: sts:AssumeRole, for directory users or groups sts:SetContext, and for IAM users or roles sts:SetSourceIdentity.

\n
\n
", + "smithy.api#documentation": "

Returns a temporary access credential from S3 Access Grants to the grantee or client application.\n The temporary credential is an Amazon Web Services STS token that grants them access to the S3 data.

\n
\n
Permissions
\n
\n

You must have the s3:GetDataAccess permission to use this\n operation.

\n
\n
Additional Permissions
\n
\n

The IAM role that S3 Access Grants assumes must have the following permissions\n specified in the trust policy when registering the location:\n sts:AssumeRole, for directory users or groups\n sts:SetContext, and for IAM users or roles\n sts:SetSourceIdentity.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -14244,7 +14316,7 @@ "Target": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { - "smithy.api#documentation": "

The S3 URI path of the data to which you are requesting temporary access credentials. If the requesting account has an access grant for this data, S3 Access Grants vends temporary access credentials in the response.

", + "smithy.api#documentation": "

The S3 URI path of the data to which you are requesting temporary access credentials. If\n the requesting account has an access grant for this data, S3 Access Grants vends temporary access\n credentials in the response.

", "smithy.api#httpQuery": "target", "smithy.api#required": {} } @@ -14252,7 +14324,7 @@ "Permission": { "target": "com.amazonaws.s3control#Permission", "traits": { - "smithy.api#documentation": "

The type of permission granted to your S3 data, which can be set to one of the following values:

\n
    \n
  • \n

    \n READ – Grant read-only access to the S3 data.

    \n
  • \n
  • \n

    \n WRITE – Grant write-only access to the S3 data.

    \n
  • \n
  • \n

    \n READWRITE – Grant both read and write access to the S3 data.

    \n
  • \n
", + "smithy.api#documentation": "

The type of permission granted to your S3 data, which can be set to one of the following\n values:

\n
    \n
  • \n

    \n READ – Grant read-only access to the S3 data.

    \n
  • \n
  • \n

    \n WRITE – Grant write-only access to the S3 data.

    \n
  • \n
  • \n

    \n READWRITE – Grant both read and write access to the S3 data.

    \n
  • \n
", "smithy.api#httpQuery": "permission", "smithy.api#required": {} } @@ -14260,21 +14332,21 @@ "DurationSeconds": { "target": "com.amazonaws.s3control#DurationSeconds", "traits": { - "smithy.api#documentation": "

The session duration, in seconds, of the temporary access credential that S3 Access Grants vends to the grantee or client application. The default value is 1 hour, but the grantee can specify a range from 900 seconds (15 minutes) up to 43200 seconds (12 hours). If the grantee requests a value higher than this maximum, the operation fails.

", + "smithy.api#documentation": "

The session duration, in seconds, of the temporary access credential that S3 Access Grants vends\n to the grantee or client application. The default value is 1 hour, but the grantee can\n specify a range from 900 seconds (15 minutes) up to 43200 seconds (12 hours). If the\n grantee requests a value higher than this maximum, the operation fails.

", "smithy.api#httpQuery": "durationSeconds" } }, "Privilege": { "target": "com.amazonaws.s3control#Privilege", "traits": { - "smithy.api#documentation": "

The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.

\n
    \n
  • \n

    \n Default – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.

    \n
  • \n
  • \n

    \n Minimal – The scope of the returned temporary access token is the same as the requested target scope as long as the requested scope is the same as or a subset of the grant scope.

    \n
  • \n
", + "smithy.api#documentation": "

The scope of the temporary access credential that S3 Access Grants vends to the grantee or client\n application.

\n
    \n
  • \n

    \n Default – The scope of the returned temporary access token is the scope\n of the grant that is closest to the target scope.

    \n
  • \n
  • \n

    \n Minimal – The scope of the returned temporary access token is the same\n as the requested target scope as long as the requested scope is the same as or a\n subset of the grant scope.

    \n
  • \n
", "smithy.api#httpQuery": "privilege" } }, "TargetType": { "target": "com.amazonaws.s3control#S3PrefixType", "traits": { - "smithy.api#documentation": "

The type of Target. The only possible value is Object. Pass this value if the target data that you would like to access is a path to an object. Do not pass this value if the target data is a bucket or a bucket and a prefix.

", + "smithy.api#documentation": "

The type of Target. The only possible value is Object. Pass\n this value if the target data that you would like to access is a path to an object. Do not\n pass this value if the target data is a bucket or a bucket and a prefix.

", "smithy.api#httpQuery": "targetType" } } @@ -14295,13 +14367,13 @@ "MatchedGrantTarget": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { - "smithy.api#documentation": "

The S3 URI path of the data to which you are being granted temporary access credentials.

" + "smithy.api#documentation": "

The S3 URI path of the data to which you are being granted temporary access credentials.\n

" } }, "Grantee": { "target": "com.amazonaws.s3control#Grantee", "traits": { - "smithy.api#documentation": "

The user, group, or role that was granted access to the S3 location scope. For directory identities, this API also returns the grants of the IAM role used for the identity-aware request. For more information on identity-aware sessions, see Granting permissions to use identity-aware console sessions.\n

" + "smithy.api#documentation": "

The user, group, or role that was granted access to the S3 location scope. For directory\n identities, this API also returns the grants of the IAM role used for the identity-aware\n request. For more information on identity-aware sessions, see Granting permissions to use identity-aware console sessions.

" } } }, @@ -14329,7 +14401,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the tags on an S3 Batch Operations job.

\n
\n
Permissions
\n
\n

To use the\n GetJobTagging operation, you must have permission to\n perform the s3:GetJobTagging action. For more information, see Controlling\n access and labeling jobs using tags in the\n Amazon S3 User Guide.

\n
\n
\n

Related actions include:

\n ", + "smithy.api#documentation": "

Returns the tags on an S3 Batch Operations job.

\n
\n
Permissions
\n
\n

To use the GetJobTagging operation, you must have permission to\n perform the s3:GetJobTagging action. For more information, see Controlling access and labeling jobs using tags in the\n Amazon S3 User Guide.

\n
\n
\n

Related actions include:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -14396,7 +14468,7 @@ "target": "com.amazonaws.s3control#GetMultiRegionAccessPointResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns configuration information about the specified Multi-Region Access Point.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.

\n

The following actions are related to GetMultiRegionAccessPoint:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns configuration information about the specified Multi-Region Access Point.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.

\n

The following actions are related to GetMultiRegionAccessPoint:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -14422,7 +14494,7 @@ "target": "com.amazonaws.s3control#GetMultiRegionAccessPointPolicyResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns the access control policy of the specified Multi-Region Access Point.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.

\n

The following actions are related to\n GetMultiRegionAccessPointPolicy:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns the access control policy of the specified Multi-Region Access Point.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.

\n

The following actions are related to\n GetMultiRegionAccessPointPolicy:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -14490,7 +14562,7 @@ "target": "com.amazonaws.s3control#GetMultiRegionAccessPointPolicyStatusResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Indicates whether the specified Multi-Region Access Point has an access control policy that allows public\n access.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.

\n

The following actions are related to\n GetMultiRegionAccessPointPolicyStatus:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Indicates whether the specified Multi-Region Access Point has an access control policy that allows public\n access.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.

\n

The following actions are related to\n GetMultiRegionAccessPointPolicyStatus:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -14597,7 +14669,7 @@ "target": "com.amazonaws.s3control#GetMultiRegionAccessPointRoutesResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or\n passive.

\n

To obtain routing control changes and failover requests, use the Amazon S3 failover control\n infrastructure endpoints in these five Amazon Web Services Regions:

\n
    \n
  • \n

    \n us-east-1\n

    \n
  • \n
  • \n

    \n us-west-2\n

    \n
  • \n
  • \n

    \n ap-southeast-2\n

    \n
  • \n
  • \n

    \n ap-northeast-1\n

    \n
  • \n
  • \n

    \n eu-west-1\n

    \n
  • \n
", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or\n passive.

\n

To obtain routing control changes and failover requests, use the Amazon S3 failover control\n infrastructure endpoints in these five Amazon Web Services Regions:

\n
    \n
  • \n

    \n us-east-1\n

    \n
  • \n
  • \n

    \n us-west-2\n

    \n
  • \n
  • \n

    \n ap-southeast-2\n

    \n
  • \n
  • \n

    \n ap-northeast-1\n

    \n
  • \n
  • \n

    \n eu-west-1\n

    \n
  • \n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -14676,7 +14748,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. For\n more information, see Using Amazon S3 block\n public access.

\n

Related actions include:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. For\n more information, see Using Amazon S3 block\n public access.

\n

Related actions include:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -14736,7 +14808,7 @@ "target": "com.amazonaws.s3control#GetStorageLensConfigurationResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage\n activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n
", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage\n activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -14804,7 +14876,7 @@ "target": "com.amazonaws.s3control#GetStorageLensConfigurationTaggingResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:GetStorageLensConfigurationTagging action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n
", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:GetStorageLensConfigurationTagging action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -14871,7 +14943,7 @@ "target": "com.amazonaws.s3control#GetStorageLensGroupResult" }, "traits": { - "smithy.api#documentation": "

\nRetrieves the Storage Lens group configuration details.

\n

To use this operation, you must have the permission to perform the\n s3:GetStorageLensGroup action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

\n

For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.

", + "smithy.api#documentation": "

\nRetrieves the Storage Lens group configuration details.

\n

To use this operation, you must have the permission to perform the\n s3:GetStorageLensGroup action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

\n

For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -14951,18 +15023,18 @@ "GranteeType": { "target": "com.amazonaws.s3control#GranteeType", "traits": { - "smithy.api#documentation": "

The type of the grantee to which access has been granted. It can be one of the following values:

\n
    \n
  • \n

    \n IAM - An IAM user or role.

    \n
  • \n
  • \n

    \n DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

    \n
  • \n
  • \n

    \n DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

    \n
  • \n
" + "smithy.api#documentation": "

The type of the grantee to which access has been granted. It can be one of the following\n values:

\n
    \n
  • \n

    \n IAM - An IAM user or role.

    \n
  • \n
  • \n

    \n DIRECTORY_USER - Your corporate directory user. You can use\n this option if you have added your corporate identity directory to IAM Identity\n Center and associated the IAM Identity Center instance with your S3 Access Grants\n instance.

    \n
  • \n
  • \n

    \n DIRECTORY_GROUP - Your corporate directory group. You can use\n this option if you have added your corporate identity directory to IAM Identity\n Center and associated the IAM Identity Center instance with your S3 Access Grants\n instance.

    \n
  • \n
" } }, "GranteeIdentifier": { "target": "com.amazonaws.s3control#GranteeIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the Grantee. If the grantee type is IAM, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from your Amazon Web Services IAM Identity Center instance.

" + "smithy.api#documentation": "

The unique identifier of the Grantee. If the grantee type is\n IAM, the identifier is the IAM Amazon Resource Name (ARN) of the user\n or role. If the grantee type is a directory user or group, the identifier is 128-bit\n universally unique identifier (UUID) in the format\n a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from your\n Amazon Web Services IAM Identity Center instance.

" } } }, "traits": { - "smithy.api#documentation": "

The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

" + "smithy.api#documentation": "

The user, group, or role to which you are granting access. You can grant access to an\n IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity\n Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee\n can also be a corporate directory user or group.

" } }, "com.amazonaws.s3control#GranteeIdentifier": { @@ -15499,6 +15571,12 @@ "traits": { "smithy.api#documentation": "

If provided, the generated manifest includes only source bucket objects that are stored\n with the specified storage class.

" } + }, + "MatchAnyObjectEncryption": { + "target": "com.amazonaws.s3control#ObjectEncryptionFilterList", + "traits": { + "smithy.api#documentation": "

If provided, the generated object list includes \n only source bucket objects with the indicated server-side encryption type (SSE-S3, SSE-KMS, DSSE-KMS, SSE-C, or NOT-SSE). \n If you select SSE-KMS or DSSE-KMS, you can optionally further filter your results by specifying a specific KMS Key ARN. \n If you select SSE-KMS, you can also optionally further filter your results by Bucket Key enabled status.

" + } } }, "traits": { @@ -15622,6 +15700,12 @@ "traits": { "smithy.api#documentation": "

Directs the specified job to invoke ReplicateObject on every object in the\n job's manifest.

\n \n

This functionality is not supported by directory buckets.

\n
" } + }, + "S3ComputeObjectChecksum": { + "target": "com.amazonaws.s3control#S3ComputeObjectChecksumOperation", + "traits": { + "smithy.api#documentation": "

Directs the specified job to compute checksum values for every object in the\n manifest.

" + } } }, "traits": { @@ -15679,7 +15763,7 @@ "Bucket": { "target": "com.amazonaws.s3control#S3BucketArnString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will\n be stored.

\n \n

\n Directory buckets - Directory buckets aren't supported \n as a location for Batch Operations to store job completion reports.

\n
" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will\n be stored.

\n \n

\n Directory buckets - Directory buckets\n aren't supported as a location for Batch Operations to store job completion reports.

\n
" } }, "Format": { @@ -15707,6 +15791,12 @@ "traits": { "smithy.api#documentation": "

Indicates whether the job-completion report will include details of all tasks or only\n failed tasks.

" } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3control#AccountId", + "traits": { + "smithy.api#documentation": "

Lists the Amazon Web Services account ID that owns the target bucket, where the completion report is received.

" + } } }, "traits": { @@ -15893,19 +15983,19 @@ "MatchAnyPrefix": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024StringList", "traits": { - "smithy.api#documentation": "

If provided, the generated manifest includes objects where the specified string appears\n at the start of the object key string. Each KeyNameConstraint filter accepts an array of strings with a length of 1 string.

" + "smithy.api#documentation": "

If provided, the generated manifest includes objects where the specified string appears\n at the start of the object key string. Each KeyNameConstraint filter accepts an array of\n strings with a length of 1 string.

" } }, "MatchAnySuffix": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024StringList", "traits": { - "smithy.api#documentation": "

If provided, the generated manifest includes objects where the specified string appears\n at the end of the object key string. Each KeyNameConstraint filter accepts an array of strings with a length of 1 string.

" + "smithy.api#documentation": "

If provided, the generated manifest includes objects where the specified string appears\n at the end of the object key string. Each KeyNameConstraint filter accepts an array of\n strings with a length of 1 string.

" } }, "MatchAnySubstring": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024StringList", "traits": { - "smithy.api#documentation": "

If provided, the generated manifest includes objects where the specified string appears\n anywhere within the object key string. Each KeyNameConstraint filter accepts an array of strings with a length of 1 string.

" + "smithy.api#documentation": "

If provided, the generated manifest includes objects where the specified string appears\n anywhere within the object key string. Each KeyNameConstraint filter accepts an array of\n strings with a length of 1 string.

" } } }, @@ -15934,13 +16024,13 @@ "InvocationSchemaVersion": { "target": "com.amazonaws.s3control#NonEmptyMaxLength64String", "traits": { - "smithy.api#documentation": "

Specifies the schema version for the payload that Batch Operations sends when invoking\n an Lambda function. Version 1.0 is the default. Version\n 2.0 is required when you use Batch Operations to invoke Lambda functions that act on directory buckets, or if you need to specify\n UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and\n Lambda in the Amazon Web Services Storage Blog.

\n \n

Ensure that your Lambda function code expects\n InvocationSchemaVersion\n 2.0 and uses bucket name rather than bucket ARN. If the\n InvocationSchemaVersion does not match what your Lambda\n function expects, your function might not work as expected.

\n
\n \n

\n Directory buckets - To initiate Amazon Web Services Lambda function to perform custom actions on objects in directory buckets, you must specify 2.0.

\n
" + "smithy.api#documentation": "

Specifies the schema version for the payload that Batch Operations sends when invoking\n an Lambda function. Version 1.0 is the default. Version\n 2.0 is required when you use Batch Operations to invoke Lambda functions that act on directory buckets, or if you need to specify\n UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and\n Lambda in the Amazon Web Services Storage Blog.

\n \n

Ensure that your Lambda function code expects\n InvocationSchemaVersion\n 2.0 and uses bucket name rather than bucket ARN. If the\n InvocationSchemaVersion does not match what your Lambda\n function expects, your function might not work as expected.

\n
\n \n

\n Directory buckets - To initiate Amazon Web Services Lambda\n function to perform custom actions on objects in directory buckets, you must specify\n 2.0.

\n
" } }, "UserArguments": { "target": "com.amazonaws.s3control#UserArguments", "traits": { - "smithy.api#documentation": "

Key-value pairs that are passed in the payload that Batch Operations sends when invoking\n an Lambda function. You must specify InvocationSchemaVersion\n 2.0 for LambdaInvoke operations that include\n UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and\n Lambda in the Amazon Web Services Storage Blog.

" + "smithy.api#documentation": "

Key-value pairs that are passed in the payload that Batch Operations sends when invoking\n an Lambda function. You must specify InvocationSchemaVersion\n 2.0 for LambdaInvoke operations that include\n UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and\n Lambda in the Amazon Web Services Storage Blog.

" } } }, @@ -15982,7 +16072,7 @@ "target": "com.amazonaws.s3control#ExpiredObjectDeleteMarker", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set\n to true, the delete marker will be expired. If set to false, the policy takes no action.\n This cannot be specified with Days or Date in a Lifecycle Expiration Policy. To learn more about delete markers, see Working with delete markers.

" + "smithy.api#documentation": "

Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set\n to true, the delete marker will be expired. If set to false, the policy takes no action.\n This cannot be specified with Days or Date in a Lifecycle Expiration Policy. To learn more\n about delete markers, see Working with delete\n markers.

" } } }, @@ -16027,7 +16117,7 @@ "NoncurrentVersionTransitions": { "target": "com.amazonaws.s3control#NoncurrentVersionTransitionList", "traits": { - "smithy.api#documentation": "

Specifies the transition rule for the lifecycle rule that describes when noncurrent\n objects transition to a specific storage class. If your bucket is versioning-enabled (or\n versioning is suspended), you can set this action to request that Amazon S3 transition\n noncurrent object versions to a specific storage class at a set period in the object's\n lifetime.

\n \n

This is not supported by Amazon S3 on Outposts buckets.

\n
" + "smithy.api#documentation": "

Specifies the transition rule for the lifecycle rule that describes when non-current\n objects transition to a specific storage class. If your bucket is versioning-enabled (or\n versioning is suspended), you can set this action to request that Amazon S3 transition\n noncurrent object versions to a specific storage class at a set period in the object's\n lifetime.

\n \n

This is not supported by Amazon S3 on Outposts buckets.

\n
" } }, "NoncurrentVersionExpiration": { @@ -16066,14 +16156,14 @@ "target": "com.amazonaws.s3control#ObjectSizeGreaterThanBytes", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The non-inclusive minimum object size for the lifecycle rule. Setting this property to 7 means the rule applies to objects with a size that is greater than 7.

" + "smithy.api#documentation": "

The non-inclusive minimum object size for the lifecycle rule. Setting this property to 7\n means the rule applies to objects with a size that is greater than 7.

" } }, "ObjectSizeLessThan": { "target": "com.amazonaws.s3control#ObjectSizeLessThanBytes", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The non-inclusive maximum object size for the lifecycle rule. Setting this property to 77 means the rule applies to objects with a size that is less than 77.

" + "smithy.api#documentation": "

The non-inclusive maximum object size for the lifecycle rule. Setting this property to\n 77 means the rule applies to objects with a size that is less than 77.

" } } }, @@ -16139,7 +16229,7 @@ "AccessGrantId": { "target": "com.amazonaws.s3control#AccessGrantId", "traits": { - "smithy.api#documentation": "

The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

" + "smithy.api#documentation": "

The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access\n grant.

" } }, "AccessGrantArn": { @@ -16151,37 +16241,37 @@ "Grantee": { "target": "com.amazonaws.s3control#Grantee", "traits": { - "smithy.api#documentation": "

The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

" + "smithy.api#documentation": "

The user, group, or role to which you are granting access. You can grant access to an\n IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity\n Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee\n can also be a corporate directory user or group.

" } }, "Permission": { "target": "com.amazonaws.s3control#Permission", "traits": { - "smithy.api#documentation": "

The type of access granted to your S3 data, which can be set to one of the following values:

\n
    \n
  • \n

    \n READ – Grant read-only access to the S3 data.

    \n
  • \n
  • \n

    \n WRITE – Grant write-only access to the S3 data.

    \n
  • \n
  • \n

    \n READWRITE – Grant both read and write access to the S3 data.

    \n
  • \n
" + "smithy.api#documentation": "

The type of access granted to your S3 data, which can be set to one of the following\n values:

\n
    \n
  • \n

    \n READ – Grant read-only access to the S3 data.

    \n
  • \n
  • \n

    \n WRITE – Grant write-only access to the S3 data.

    \n
  • \n
  • \n

    \n READWRITE – Grant both read and write access to the S3 data.

    \n
  • \n
" } }, "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { - "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

" + "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigns this\n ID when you register the location. S3 Access Grants assigns the ID default to the\n default location s3:// and assigns an auto-generated ID to other locations\n that you register.

" } }, "AccessGrantsLocationConfiguration": { "target": "com.amazonaws.s3control#AccessGrantsLocationConfiguration", "traits": { - "smithy.api#documentation": "

The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.

" + "smithy.api#documentation": "

The configuration options of the grant location. The grant location is the S3 path to\n the data to which you are granting access.

" } }, "GrantScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { - "smithy.api#documentation": "

The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.

" + "smithy.api#documentation": "

The S3 path of the data to which you are granting access. It is the result of appending\n the Subprefix to the location scope.

" } }, "ApplicationArn": { "target": "com.amazonaws.s3control#IdentityCenterApplicationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated\n with your Identity Center instance. If the grant includes an application ARN, the grantee\n can only access the S3 data through this application.

" } } }, @@ -16198,7 +16288,7 @@ "target": "com.amazonaws.s3control#ListAccessGrantsResult" }, "traits": { - "smithy.api#documentation": "

Returns the list of access grants in your S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:ListAccessGrants permission to use this operation.

\n
\n
", + "smithy.api#documentation": "

Returns the list of access grants in your S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:ListAccessGrants permission to use this\n operation.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -16226,7 +16316,7 @@ "AccessGrantsInstanceId": { "target": "com.amazonaws.s3control#AccessGrantsInstanceId", "traits": { - "smithy.api#documentation": "

The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants instance per Region per account.

" + "smithy.api#documentation": "

The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants\n instance per Region per account.

" } }, "AccessGrantsInstanceArn": { @@ -16247,19 +16337,19 @@ "smithy.api#deprecated": { "message": "IdentityCenterArn has been deprecated. Use IdentityCenterInstanceArn or IdentityCenterApplicationArn." }, - "smithy.api#documentation": "

If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.

" + "smithy.api#documentation": "

If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance,\n this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance\n application; a subresource of the original Identity Center instance. S3 Access Grants creates this\n Identity Center application for the specific S3 Access Grants instance.

" } }, "IdentityCenterInstanceArn": { "target": "com.amazonaws.s3control#IdentityCenterArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are\n associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate\n identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center\n instances and their ARNs.

" } }, "IdentityCenterApplicationArn": { "target": "com.amazonaws.s3control#IdentityCenterApplicationArn", "traits": { - "smithy.api#documentation": "

If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.

" + "smithy.api#documentation": "

If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance,\n this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance\n application; a subresource of the original Identity Center instance. S3 Access Grants creates this\n Identity Center application for the specific S3 Access Grants instance.

" } } }, @@ -16276,7 +16366,7 @@ "target": "com.amazonaws.s3control#ListAccessGrantsInstancesResult" }, "traits": { - "smithy.api#documentation": "

Returns a list of S3 Access Grants instances. An S3 Access Grants instance serves as a logical grouping for your individual access grants. You can only have one S3 Access Grants instance per Region per account.

\n
\n
Permissions
\n
\n

You must have the s3:ListAccessGrantsInstances permission to use this operation.

\n
\n
", + "smithy.api#documentation": "

Returns a list of S3 Access Grants instances. An S3 Access Grants instance serves as a logical grouping for\n your individual access grants. You can only have one S3 Access Grants instance per Region per\n account.

\n
\n
Permissions
\n
\n

You must have the s3:ListAccessGrantsInstances permission to use\n this operation.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -16316,7 +16406,7 @@ "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { - "smithy.api#documentation": "

A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Instances request in order to retrieve the next page of results.

", + "smithy.api#documentation": "

A pagination token to request the next page of results. Pass this value into a\n subsequent List Access Grants Instances request in order to retrieve the next\n page of results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -16324,7 +16414,7 @@ "target": "com.amazonaws.s3control#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

", + "smithy.api#documentation": "

The maximum number of access grants that you would like returned in the List\n Access Grants response. If the results include the pagination token\n NextToken, make another call using the NextToken to determine\n if there are more results.

", "smithy.api#httpQuery": "maxResults" } } @@ -16339,7 +16429,7 @@ "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { - "smithy.api#documentation": "

A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Instances request in order to retrieve the next page of results.

" + "smithy.api#documentation": "

A pagination token to request the next page of results. Pass this value into a\n subsequent List Access Grants Instances request in order to retrieve the next\n page of results.

" } }, "AccessGrantsInstancesList": { @@ -16362,7 +16452,7 @@ "target": "com.amazonaws.s3control#ListAccessGrantsLocationsResult" }, "traits": { - "smithy.api#documentation": "

Returns a list of the locations registered in your S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:ListAccessGrantsLocations permission to use this operation.

\n
\n
", + "smithy.api#documentation": "

Returns a list of the locations registered in your S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:ListAccessGrantsLocations permission to use\n this operation.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -16396,7 +16486,7 @@ "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { - "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

" + "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigns this\n ID when you register the location. S3 Access Grants assigns the ID default to the\n default location s3:// and assigns an auto-generated ID to other locations\n that you register.

" } }, "AccessGrantsLocationArn": { @@ -16408,13 +16498,13 @@ "LocationScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { - "smithy.api#documentation": "

The S3 path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://, or the S3 path to a bucket and prefix s3:///. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

" + "smithy.api#documentation": "

The S3 path to the location that you are registering. The location scope can be the\n default S3 location s3://, the S3 path to a bucket\n s3://, or the S3 path to a bucket and prefix\n s3:///. A prefix in S3 is a string of\n characters at the beginning of an object key name used to organize the objects that you\n store in your S3 buckets. For example, object key names that start with the\n engineering/ prefix or object key names that start with the\n marketing/campaigns/ prefix.

" } }, "IAMRoleArn": { "target": "com.amazonaws.s3control#IAMRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants\n assumes this role to manage access to the registered location.

" } } }, @@ -16440,7 +16530,7 @@ "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { - "smithy.api#documentation": "

A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Locations request in order to retrieve the next page of results.

", + "smithy.api#documentation": "

A pagination token to request the next page of results. Pass this value into a\n subsequent List Access Grants Locations request in order to retrieve the next\n page of results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -16448,14 +16538,14 @@ "target": "com.amazonaws.s3control#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

", + "smithy.api#documentation": "

The maximum number of access grants that you would like returned in the List\n Access Grants response. If the results include the pagination token\n NextToken, make another call using the NextToken to determine\n if there are more results.

", "smithy.api#httpQuery": "maxResults" } }, "LocationScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { - "smithy.api#documentation": "

The S3 path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://, or the S3 path to a bucket and prefix s3:///. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

", + "smithy.api#documentation": "

The S3 path to the location that you are registering. The location scope can be the\n default S3 location s3://, the S3 path to a bucket\n s3://, or the S3 path to a bucket and prefix\n s3:///. A prefix in S3 is a string of\n characters at the beginning of an object key name used to organize the objects that you\n store in your S3 buckets. For example, object key names that start with the\n engineering/ prefix or object key names that start with the\n marketing/campaigns/ prefix.

", "smithy.api#httpQuery": "locationscope" } } @@ -16470,7 +16560,7 @@ "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { - "smithy.api#documentation": "

A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Locations request in order to retrieve the next page of results.

" + "smithy.api#documentation": "

A pagination token to request the next page of results. Pass this value into a\n subsequent List Access Grants Locations request in order to retrieve the next\n page of results.

" } }, "AccessGrantsLocationsList": { @@ -16502,7 +16592,7 @@ "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { - "smithy.api#documentation": "

A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants request in order to retrieve the next page of results.

", + "smithy.api#documentation": "

A pagination token to request the next page of results. Pass this value into a\n subsequent List Access Grants request in order to retrieve the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -16510,42 +16600,42 @@ "target": "com.amazonaws.s3control#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

", + "smithy.api#documentation": "

The maximum number of access grants that you would like returned in the List\n Access Grants response. If the results include the pagination token\n NextToken, make another call using the NextToken to determine\n if there are more results.

", "smithy.api#httpQuery": "maxResults" } }, "GranteeType": { "target": "com.amazonaws.s3control#GranteeType", "traits": { - "smithy.api#documentation": "

The type of the grantee to which access has been granted. It can be one of the following values:

\n
    \n
  • \n

    \n IAM - An IAM user or role.

    \n
  • \n
  • \n

    \n DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

    \n
  • \n
  • \n

    \n DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

    \n
  • \n
", + "smithy.api#documentation": "

The type of the grantee to which access has been granted. It can be one of the following\n values:

\n
    \n
  • \n

    \n IAM - An IAM user or role.

    \n
  • \n
  • \n

    \n DIRECTORY_USER - Your corporate directory user. You can use\n this option if you have added your corporate identity directory to IAM Identity\n Center and associated the IAM Identity Center instance with your S3 Access Grants\n instance.

    \n
  • \n
  • \n

    \n DIRECTORY_GROUP - Your corporate directory group. You can use\n this option if you have added your corporate identity directory to IAM Identity\n Center and associated the IAM Identity Center instance with your S3 Access Grants\n instance.

    \n
  • \n
", "smithy.api#httpQuery": "granteetype" } }, "GranteeIdentifier": { "target": "com.amazonaws.s3control#GranteeIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifer of the Grantee. If the grantee type is IAM, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from your Amazon Web Services IAM Identity Center instance.

", + "smithy.api#documentation": "

The unique identifer of the Grantee. If the grantee type is\n IAM, the identifier is the IAM Amazon Resource Name (ARN) of the user\n or role. If the grantee type is a directory user or group, the identifier is 128-bit\n universally unique identifier (UUID) in the format\n a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from your\n Amazon Web Services IAM Identity Center instance.

", "smithy.api#httpQuery": "granteeidentifier" } }, "Permission": { "target": "com.amazonaws.s3control#Permission", "traits": { - "smithy.api#documentation": "

The type of permission granted to your S3 data, which can be set to one of the following values:

\n
    \n
  • \n

    \n READ – Grant read-only access to the S3 data.

    \n
  • \n
  • \n

    \n WRITE – Grant write-only access to the S3 data.

    \n
  • \n
  • \n

    \n READWRITE – Grant both read and write access to the S3 data.

    \n
  • \n
", + "smithy.api#documentation": "

The type of permission granted to your S3 data, which can be set to one of the following\n values:

\n
    \n
  • \n

    \n READ – Grant read-only access to the S3 data.

    \n
  • \n
  • \n

    \n WRITE – Grant write-only access to the S3 data.

    \n
  • \n
  • \n

    \n READWRITE – Grant both read and write access to the S3 data.

    \n
  • \n
", "smithy.api#httpQuery": "permission" } }, "GrantScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { - "smithy.api#documentation": "

The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.

", + "smithy.api#documentation": "

The S3 path of the data to which you are granting access. It is the result of appending\n the Subprefix to the location scope.

", "smithy.api#httpQuery": "grantscope" } }, "ApplicationArn": { "target": "com.amazonaws.s3control#IdentityCenterApplicationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated\n with your Identity Center instance. If the grant includes an application ARN, the grantee\n can only access the S3 data through this application.

", "smithy.api#httpQuery": "application_arn" } } @@ -16560,7 +16650,7 @@ "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { - "smithy.api#documentation": "

A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants request in order to retrieve the next page of results.

" + "smithy.api#documentation": "

A pagination token to request the next page of results. Pass this value into a\n subsequent List Access Grants request in order to retrieve the next page of\n results.

" } }, "AccessGrantsList": { @@ -16583,7 +16673,7 @@ "target": "com.amazonaws.s3control#ListAccessPointsResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns a list of the access points. You can retrieve up to 1,000 access points per call. If the call\n returns more than 1,000 access points (or the number specified in maxResults,\n whichever is less), the response will include a continuation token that you can use to list\n the additional access points.

\n

Returns only access points attached to S3 buckets by default. To return all access points specify\n DataSourceType as ALL.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to ListAccessPoints:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns a list of the access points. You can retrieve up to 1,000 access points per call. If the call\n returns more than 1,000 access points (or the number specified in maxResults,\n whichever is less), the response will include a continuation token that you can use to list\n the additional access points.

\n

Returns only access points attached to S3 buckets by default. To return all access points specify\n DataSourceType as ALL.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to ListAccessPoints:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -16613,7 +16703,7 @@ "target": "com.amazonaws.s3control#ListAccessPointsForDirectoryBucketsResult" }, "traits": { - "smithy.api#documentation": "

Returns a list of the access points that are owned by the Amazon Web Services account and that are associated with the specified directory bucket.

\n

To list access points for general purpose buckets, see ListAccesspoints.

\n

To use this operation, you must have the permission to perform the\n s3express:ListAccessPointsForDirectoryBuckets action.

\n

For information about REST API errors, see REST error responses.

", + "smithy.api#documentation": "

Returns a list of the access points that are owned by the Amazon Web Services account and that are associated\n with the specified directory bucket.

\n

To list access points for general purpose buckets, see ListAccesspoints.

\n

To use this operation, you must have the permission to perform the\n s3express:ListAccessPointsForDirectoryBuckets\n action.

\n

For information about REST API errors, see REST error responses.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#http": { "method": "GET", "uri": "/v20180820/accesspointfordirectory", @@ -16660,7 +16750,7 @@ "NextToken": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { - "smithy.api#documentation": "

\n If NextToken is returned, there are more access points available than requested in the maxResults value. The value of NextToken is a\n unique pagination token for each page. Make the call again using the returned token to\n retrieve the next page. Keep all other arguments unchanged. Each pagination token expires\n after 24 hours.\n

", + "smithy.api#documentation": "

If NextToken is returned, there are more access points available than requested in\n the maxResults value. The value of NextToken is a unique\n pagination token for each page. Make the call again using the returned token to retrieve\n the next page. Keep all other arguments unchanged. Each pagination token expires after 24\n hours.

", "smithy.api#httpQuery": "nextToken" } }, @@ -16668,7 +16758,7 @@ "target": "com.amazonaws.s3control#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of access points that you would like returned in the ListAccessPointsForDirectoryBuckets response. If the directory bucket is associated with more than this number of access points, the results include the pagination token NextToken. Make another call using the NextToken to retrieve more results.

", + "smithy.api#documentation": "

The maximum number of access points that you would like returned in the\n ListAccessPointsForDirectoryBuckets response. If the directory bucket is\n associated with more than this number of access points, the results include the pagination token\n NextToken. Make another call using the NextToken to retrieve\n more results.

", "smithy.api#httpQuery": "maxResults" } } @@ -16683,13 +16773,13 @@ "AccessPointList": { "target": "com.amazonaws.s3control#AccessPointList", "traits": { - "smithy.api#documentation": "

Contains identification and configuration information for one or more access points associated with the directory bucket.

" + "smithy.api#documentation": "

Contains identification and configuration information for one or more access points associated\n with the directory bucket.

" } }, "NextToken": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { - "smithy.api#documentation": "

\n If NextToken is returned, there are more access points available than requested in the maxResults value. The value of NextToken is a\n unique pagination token for each page. Make the call again using the returned token to\n retrieve the next page. Keep all other arguments unchanged. Each pagination token expires\n after 24 hours.\n

" + "smithy.api#documentation": "

If NextToken is returned, there are more access points available than requested in\n the maxResults value. The value of NextToken is a unique\n pagination token for each page. Make the call again using the returned token to retrieve\n the next page. Keep all other arguments unchanged. Each pagination token expires after 24\n hours.

" } } }, @@ -16706,7 +16796,7 @@ "target": "com.amazonaws.s3control#ListAccessPointsForObjectLambdaResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there\n are more access points than what can be returned in one call, the response will include a\n continuation token that you can use to list the additional access points.

\n

The following actions are related to\n ListAccessPointsForObjectLambda:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there\n are more access points than what can be returned in one call, the response will include a\n continuation token that you can use to list the additional access points.

\n

The following actions are related to\n ListAccessPointsForObjectLambda:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -16833,7 +16923,7 @@ "DataSourceType": { "target": "com.amazonaws.s3control#DataSourceType", "traits": { - "smithy.api#documentation": "

The type of the data source that the access point is attached to. Returns only access points attached to S3 buckets by default. To return all access points specify\n DataSourceType as ALL.

", + "smithy.api#documentation": "

The type of the data source that the access point is attached to. Returns only access points attached to\n S3 buckets by default. To return all access points specify DataSourceType as\n ALL.

", "smithy.api#httpQuery": "dataSourceType" } } @@ -16871,7 +16961,7 @@ "target": "com.amazonaws.s3control#ListCallerAccessGrantsResult" }, "traits": { - "smithy.api#documentation": "

Use this API to list the access grants that grant the caller access to Amazon S3 data through S3 Access Grants. The caller (grantee) can be an Identity and Access Management (IAM) identity or Amazon Web Services Identity Center corporate directory identity. You must pass the Amazon Web Services account of the S3 data owner (grantor) in the request. You can, optionally, narrow the results by GrantScope, using a fragment of the data's S3 path, and S3 Access Grants will return only the grants with a path that contains the path fragment. You can also pass the AllowedByApplication filter in the request, which returns only the grants authorized for applications, whether the application is the caller's Identity Center application or any other application (ALL). For more information, see List the caller's access grants in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

You must have the s3:ListCallerAccessGrants permission to use this operation.

\n
\n
", + "smithy.api#documentation": "

Use this API to list the access grants that grant the caller access to Amazon S3 data through\n S3 Access Grants. The caller (grantee) can be an Identity and Access Management (IAM) identity or Amazon Web Services Identity Center\n corporate directory identity. You must pass the Amazon Web Services account of the S3 data owner\n (grantor) in the request. You can, optionally, narrow the results by\n GrantScope, using a fragment of the data's S3 path, and S3 Access Grants will return\n only the grants with a path that contains the path fragment. You can also pass the\n AllowedByApplication filter in the request, which returns only the grants\n authorized for applications, whether the application is the caller's Identity Center\n application or any other application (ALL). For more information, see List\n the caller's access grants in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

You must have the s3:ListCallerAccessGrants permission to use this\n operation.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -16912,12 +17002,12 @@ "ApplicationArn": { "target": "com.amazonaws.s3control#IdentityCenterApplicationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated\n with your Identity Center instance. If the grant includes an application ARN, the grantee\n can only access the S3 data through this application.

" } } }, "traits": { - "smithy.api#documentation": "

Part of ListCallerAccessGrantsResult. Each entry includes the\n permission level (READ, WRITE, or READWRITE) and the grant scope of the access grant. If the grant also includes an application ARN, the grantee can only access the S3 data through this application.

" + "smithy.api#documentation": "

Part of ListCallerAccessGrantsResult. Each entry includes the permission\n level (READ, WRITE, or READWRITE) and the grant scope of the access grant. If the grant\n also includes an application ARN, the grantee can only access the S3 data through this\n application.

" } }, "com.amazonaws.s3control#ListCallerAccessGrantsRequest": { @@ -16938,14 +17028,14 @@ "GrantScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { - "smithy.api#documentation": "

The S3 path of the data that you would like to access. Must start with s3://. You can optionally pass only the beginning characters of a path, and S3 Access Grants will search for all applicable grants for the path fragment.

", + "smithy.api#documentation": "

The S3 path of the data that you would like to access. Must start with\n s3://. You can optionally pass only the beginning characters of a path, and\n S3 Access Grants will search for all applicable grants for the path fragment.

", "smithy.api#httpQuery": "grantscope" } }, "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { - "smithy.api#documentation": "

A pagination token to request the next page of results. Pass this value into a subsequent List Caller Access Grants request in order to retrieve the next page of results.

", + "smithy.api#documentation": "

A pagination token to request the next page of results. Pass this value into a\n subsequent List Caller Access Grants request in order to retrieve the next\n page of results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -16953,7 +17043,7 @@ "target": "com.amazonaws.s3control#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of access grants that you would like returned in the List Caller Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

", + "smithy.api#documentation": "

The maximum number of access grants that you would like returned in the List\n Caller Access Grants response. If the results include the pagination token\n NextToken, make another call using the NextToken to determine\n if there are more results.

", "smithy.api#httpQuery": "maxResults" } }, @@ -16961,7 +17051,7 @@ "target": "com.amazonaws.s3control#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If this optional parameter is passed in the request, a filter is applied to the results. The results will include only the access grants for the caller's Identity Center application or for any other applications (ALL).

", + "smithy.api#documentation": "

If this optional parameter is passed in the request, a filter is applied to the results.\n The results will include only the access grants for the caller's Identity Center\n application or for any other applications (ALL).

", "smithy.api#httpQuery": "allowedByApplication" } } @@ -16976,13 +17066,13 @@ "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { - "smithy.api#documentation": "

A pagination token that you can use to request the next page of results. Pass this value into a subsequent List Caller Access Grants request in order to retrieve the next page of results.

" + "smithy.api#documentation": "

A pagination token that you can use to request the next page of results. Pass this value\n into a subsequent List Caller Access Grants request in order to retrieve the\n next page of results.

" } }, "CallerAccessGrantsList": { "target": "com.amazonaws.s3control#CallerAccessGrantsList", "traits": { - "smithy.api#documentation": "

A list of the caller's access grants that were created using S3 Access Grants and that grant the caller access to the S3 data of the Amazon Web Services account ID that was specified in the request.

" + "smithy.api#documentation": "

A list of the caller's access grants that were created using S3 Access Grants and that grant the\n caller access to the S3 data of the Amazon Web Services account ID that was specified in the request.\n

" } } }, @@ -17010,7 +17100,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90\n days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use the\n ListJobs operation, you must have permission to\n perform the s3:ListJobs action.

\n
\n
\n

Related actions include:

\n

\n ", + "smithy.api#documentation": "

Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90\n days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use the ListJobs operation, you must have permission to perform\n the s3:ListJobs action.

\n
\n
\n

Related actions include:

\n

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -17102,7 +17192,7 @@ "target": "com.amazonaws.s3control#ListMultiRegionAccessPointsResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.\n Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be\n associated with a single account.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.

\n

The following actions are related to ListMultiRegionAccessPoint:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.\n Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be\n associated with a single account.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.

\n

The following actions are related to ListMultiRegionAccessPoint:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -17188,7 +17278,7 @@ "target": "com.amazonaws.s3control#ListRegionalBucketsResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated\n sender of the request. For more information, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide.

\n

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts\n endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.

", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated\n sender of the request. For more information, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide.

\n

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts\n endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -17319,7 +17409,7 @@ "target": "com.amazonaws.s3control#ListStorageLensConfigurationsResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:ListStorageLensConfigurations action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n
", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:ListStorageLensConfigurations action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -17427,7 +17517,7 @@ "target": "com.amazonaws.s3control#ListStorageLensGroupsResult" }, "traits": { - "smithy.api#documentation": "

\nLists all the Storage Lens groups in the specified home Region.\n

\n

To use this operation, you must have the permission to perform the\n s3:ListStorageLensGroups action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

\n

For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.

", + "smithy.api#documentation": "

\nLists all the Storage Lens groups in the specified home Region.\n

\n

To use this operation, you must have the permission to perform the\n s3:ListStorageLensGroups action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

\n

For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -17505,7 +17595,7 @@ "target": "com.amazonaws.s3control#ListTagsForResourceResult" }, "traits": { - "smithy.api#documentation": "

This operation allows you to list all of the tags for a specified resource. Each tag is a label consisting of a key and value. Tags can help you organize, track costs for, and control access to resources.

\n \n

This operation is only supported for the following Amazon S3 resources:

\n \n
\n
\n
Permissions
\n
\n

For Storage Lens groups and S3 Access Grants, you must have the s3:ListTagsForResource permission to use this operation.

\n

For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

\n
\n
Directory bucket permissions
\n
\n

For directory buckets, you must have the s3express:ListTagsForResource permission to use this operation. For more information about directory buckets policies and permissions, see Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

\n
\n
\n

For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.

", + "smithy.api#documentation": "

This operation allows you to list all of the tags for a specified resource. Each tag is\n a label consisting of a key and value. Tags can help you organize, track costs for, and\n control access to resources.

\n \n

This operation is only supported for the following Amazon S3 resources:

\n \n
\n
\n
Permissions
\n
\n

For Storage Lens groups and S3 Access Grants, you must have the\n s3:ListTagsForResource permission to use this operation.

\n

For more information about the required Storage Lens Groups permissions, see\n Setting account permissions to use S3 Storage Lens groups.

\n
\n
Directory bucket permissions
\n
\n

For directory buckets and access points for directory buckets, you must have the s3express:ListTagsForResource permission to use this operation. For more information about directory buckets policies and permissions, see Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

\n
\n
\n

For information about S3 Tagging errors, see List of Amazon S3\n Tagging error codes.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -17527,7 +17617,7 @@ "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { - "smithy.api#documentation": "

\nThe Amazon Web Services account ID of the resource owner.\n

", + "smithy.api#documentation": "

The Amazon Web Services account ID of the resource owner.

", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, @@ -17539,7 +17629,7 @@ "ResourceArn": { "target": "com.amazonaws.s3control#S3ResourceArn", "traits": { - "smithy.api#documentation": "

\nThe Amazon Resource Name (ARN) of the S3 resource that you want to list tags for. The tagged resource can be a directory bucket, S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.\n

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the S3 resource that you want to list tags for. The\n tagged resource can be a directory bucket, S3 Storage Lens group or S3 Access Grants instance,\n registered location, or grant.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -17558,7 +17648,7 @@ "Tags": { "target": "com.amazonaws.s3control#TagList", "traits": { - "smithy.api#documentation": "

\nThe Amazon Web Services resource tags that are associated with the resource. \n

" + "smithy.api#documentation": "

The Amazon Web Services resource tags that are associated with the resource.

" } } }, @@ -18012,6 +18102,16 @@ "com.amazonaws.s3control#NoSuchPublicAccessBlockConfigurationMessage": { "type": "string" }, + "com.amazonaws.s3control#NonEmptyKmsKeyArnString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#pattern": "^arn:aws[a-zA-Z0-9-]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-zA-Z0-9-]+$" + } + }, "com.amazonaws.s3control#NonEmptyMaxLength1024String": { "type": "string", "traits": { @@ -18124,6 +18224,13 @@ "smithy.api#error": "client" } }, + "com.amazonaws.s3control#NotSSEFilter": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A filter that returns objects that aren't server-side encrypted.

" + } + }, "com.amazonaws.s3control#ObjectAgeValue": { "type": "integer", "traits": { @@ -18133,6 +18240,64 @@ "com.amazonaws.s3control#ObjectCreationTime": { "type": "timestamp" }, + "com.amazonaws.s3control#ObjectEncryptionFilter": { + "type": "union", + "members": { + "SSES3": { + "target": "com.amazonaws.s3control#SSES3Filter", + "traits": { + "smithy.api#documentation": "

Filters for objects that are encrypted by server-side encryption with Amazon S3 managed keys (SSE-S3).

", + "smithy.api#xmlName": "SSE-S3" + } + }, + "SSEKMS": { + "target": "com.amazonaws.s3control#SSEKMSFilter", + "traits": { + "smithy.api#documentation": "

Filters for objects that are encrypted by server-side encryption with Amazon Web Services Key Management Service (KMS) keys (SSE-KMS).

", + "smithy.api#xmlName": "SSE-KMS" + } + }, + "DSSEKMS": { + "target": "com.amazonaws.s3control#DSSEKMSFilter", + "traits": { + "smithy.api#documentation": "

Filters for objects that are encrypted by dual-layer server-side encryption with Amazon Web Services Key Management\n Service (KMS) keys (DSSE-KMS).

", + "smithy.api#xmlName": "DSSE-KMS" + } + }, + "SSEC": { + "target": "com.amazonaws.s3control#SSECFilter", + "traits": { + "smithy.api#documentation": "

Filters for objects that are encrypted by server-side encryption with customer-provided keys (SSE-C).

", + "smithy.api#xmlName": "SSE-C" + } + }, + "NOTSSE": { + "target": "com.amazonaws.s3control#NotSSEFilter", + "traits": { + "smithy.api#documentation": "

Filters for objects that are not encrypted by server-side encryption.

", + "smithy.api#xmlName": "NOT-SSE" + } + } + }, + "traits": { + "smithy.api#documentation": "

An optional filter for the \n S3JobManifestGenerator that identifies the subset of objects by encryption type. \n This filter is used to create an object list for S3 Batch Operations jobs. If provided, this filter will generate an object list \n that only includes objects with the specified encryption type.

" + } + }, + "com.amazonaws.s3control#ObjectEncryptionFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3control#ObjectEncryptionFilter", + "traits": { + "smithy.api#xmlName": "ObjectEncryption" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.s3control#ObjectLambdaAccessPoint": { "type": "structure", "members": { @@ -18491,6 +18656,12 @@ "traits": { "smithy.api#enumValue": "S3ReplicateObject" } + }, + "S3ComputeObjectChecksum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3ComputeObjectChecksum" + } } } }, @@ -18714,7 +18885,7 @@ "target": "com.amazonaws.s3control#PutAccessGrantsInstanceResourcePolicyResult" }, "traits": { - "smithy.api#documentation": "

Updates the resource policy of the S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:PutAccessGrantsInstanceResourcePolicy permission to use this operation.

\n
\n
", + "smithy.api#documentation": "

Updates the resource policy of the S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:PutAccessGrantsInstanceResourcePolicy\n permission to use this operation.

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -18799,7 +18970,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Replaces configuration for an Object Lambda Access Point.

\n

The following actions are related to\n PutAccessPointConfigurationForObjectLambda:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Replaces configuration for an Object Lambda Access Point.

\n

The following actions are related to\n PutAccessPointConfigurationForObjectLambda:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -18859,7 +19030,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Associates an access policy with the specified access point. Each access point can have only one policy,\n so a request made to this API replaces any existing policy associated with the specified\n access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to PutAccessPointPolicy:

\n ", + "smithy.api#documentation": "

Associates an access policy with the specified access point. Each access point can have only one policy,\n so a request made to this API replaces any existing policy associated with the specified\n access point.

\n

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following actions are related to PutAccessPointPolicy:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -18884,7 +19055,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.

\n

The following actions are related to\n PutAccessPointPolicyForObjectLambda:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.

\n

The following actions are related to\n PutAccessPointPolicyForObjectLambda:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -18964,7 +19135,7 @@ "Policy": { "target": "com.amazonaws.s3control#Policy", "traits": { - "smithy.api#documentation": "

The policy that you want to apply to the specified access point. For more information about access point\n policies, see Managing data access with Amazon S3\n access points or Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The policy that you want to apply to the specified access point. For more information about access point\n policies, see Managing data access with Amazon S3\n access points or Managing access to\n shared datasets in directory buckets with access points in the\n Amazon S3 User Guide.

", "smithy.api#required": {} } } @@ -18982,7 +19153,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Creates or replaces the access point scope for a directory bucket. You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.

\n \n

You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.

\n
\n

To use this operation, you must have the permission to perform the\n s3express:PutAccessPointScope action.

\n

For information about REST API errors, see REST error responses.

", + "smithy.api#documentation": "

Creates or replaces the access point scope for a directory bucket. You can use the access point\n scope to restrict access to specific prefixes, API operations, or a combination of\n both.

\n \n

You can specify any amount of prefixes, but the total length of characters of all\n prefixes must be less than 256 bytes in size.

\n
\n

To use this operation, you must have the permission to perform the\n s3express:PutAccessPointScope\n action.

\n

For information about REST API errors, see REST error responses.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#http": { "method": "PUT", "uri": "/v20180820/accesspoint/{Name}/scope", @@ -19004,7 +19175,7 @@ "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { - "smithy.api#documentation": "

\n The Amazon Web Services account ID that owns the access point with scope that you want to create or replace.\n

", + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the access point with scope that you want to create or replace.\n

", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, @@ -19314,7 +19485,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This operation sets the versioning state\n for\n S3 on Outposts\n buckets\n only. To set the versioning state for an S3 bucket, see PutBucketVersioning in the Amazon S3 API Reference.

\n
\n

Sets the versioning state for an S3 on Outposts bucket. With\n S3\n Versioning,\n you can save multiple distinct copies of your\n objects\n and recover from unintended user actions and application failures.

\n

You can set the versioning state to one of the following:

\n
    \n
  • \n

    \n Enabled - Enables versioning for the objects in\n the bucket. All objects added to the bucket receive a unique version ID.

    \n
  • \n
  • \n

    \n Suspended - Suspends versioning for the objects\n in the bucket. All objects added to the bucket receive the version ID\n null.

    \n
  • \n
\n

If you've never set versioning on your bucket, it has no versioning state. In that case,\n a \n GetBucketVersioning request does not return a versioning state value.

\n

When you enable S3 Versioning, for each object in your bucket, you have a current\n version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle\n rules to expire noncurrent versions after a specified time period. For more information,\n see Creating and managing\n a lifecycle configuration for your S3 on Outposts bucket in the Amazon S3\n User Guide.

\n

If you have an object expiration lifecycle configuration in your non-versioned bucket\n and you want to maintain the same permanent delete behavior when you enable versioning, you\n must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration\n will manage the deletes of the noncurrent object versions in the version-enabled bucket.\n For more information, see Versioning in the Amazon S3\n User Guide.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following operations are related to PutBucketVersioning for\n S3 on Outposts.

\n ", + "smithy.api#documentation": "\n

This operation sets the versioning state\n for\n S3 on Outposts\n buckets\n only. To set the versioning state for an S3 bucket, see PutBucketVersioning in the Amazon S3 API Reference.

\n
\n

Sets the versioning state for an S3 on Outposts bucket. With\n S3\n Versioning,\n you can save multiple distinct copies of your\n objects\n and recover from unintended user actions and application failures.

\n

You can set the versioning state to one of the following:

\n
    \n
  • \n

    \n Enabled - Enables versioning for the objects in\n the bucket. All objects added to the bucket receive a unique version ID.

    \n
  • \n
  • \n

    \n Suspended - Suspends versioning for the objects\n in the bucket. All objects added to the bucket receive the version ID\n null.

    \n
  • \n
\n

If you've never set versioning on your bucket, it has no versioning state. In that case,\n a \n GetBucketVersioning request does not return a versioning state value.

\n

When you enable S3 Versioning, for each object in your bucket, you have a current\n version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle\n rules to expire noncurrent versions after a specified time period. For more information,\n see Creating and managing\n a lifecycle configuration for your S3 on Outposts bucket in the Amazon S3\n User Guide.

\n

If you have an object expiration lifecycle configuration in your non-versioned bucket\n and you want to maintain the same permanent delete behavior when you enable versioning, you\n must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration\n will manage the deletes of the noncurrent object versions in the version-enabled bucket.\n For more information, see Versioning in the Amazon S3\n User Guide.

\n

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

\n

The following operations are related to PutBucketVersioning for\n S3 on Outposts.

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -19401,7 +19572,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the supplied tag-set on an S3 Batch Operations job.

\n

A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending\n a PUT request against the tagging subresource that is associated with the job. To modify\n the existing tag set, you can either replace the existing tag set entirely, or make changes\n within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this operation to replace the tag set\n with the one you modified. For more information, see Controlling\n access and labeling jobs using tags in the Amazon S3 User Guide.

\n \n
    \n
  • \n

    If you send this request with an empty tag set, Amazon S3 deletes the existing\n tag set on the Batch Operations job. If you use this method, you are charged for a Tier\n 1 Request (PUT). For more information, see Amazon S3 pricing.

    \n
  • \n
  • \n

    For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same\n result without incurring charges.

    \n
  • \n
  • \n

    A few things to consider about using tags:

    \n
      \n
    • \n

      Amazon S3 limits the maximum number of tags to 50 tags per job.

      \n
    • \n
    • \n

      You can associate up to 50 tags with a job as long as they have unique\n tag keys.

      \n
    • \n
    • \n

      A tag key can be up to 128 Unicode characters in length, and tag values\n can be up to 256 Unicode characters in length.

      \n
    • \n
    • \n

      The key and values are case sensitive.

      \n
    • \n
    • \n

      For tagging-related restrictions related to characters and encodings, see\n User-Defined Tag Restrictions in the Billing and Cost Management User Guide.

      \n
    • \n
    \n
  • \n
\n
\n
\n
Permissions
\n
\n

To use the\n PutJobTagging operation, you must have permission to\n perform the s3:PutJobTagging action.

\n
\n
\n

Related actions include:

\n ", + "smithy.api#documentation": "

Sets the supplied tag-set on an S3 Batch Operations job.

\n

A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending\n a PUT request against the tagging subresource that is associated with the job. To modify\n the existing tag set, you can either replace the existing tag set entirely, or make changes\n within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this operation to replace the tag\n set with the one you modified. For more information, see Controlling\n access and labeling jobs using tags in the Amazon S3 User Guide.

\n \n
    \n
  • \n

    If you send this request with an empty tag set, Amazon S3 deletes the existing\n tag set on the Batch Operations job. If you use this method, you are charged for a Tier\n 1 Request (PUT). For more information, see Amazon S3 pricing.

    \n
  • \n
  • \n

    For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same\n result without incurring charges.

    \n
  • \n
  • \n

    A few things to consider about using tags:

    \n
      \n
    • \n

      Amazon S3 limits the maximum number of tags to 50 tags per job.

      \n
    • \n
    • \n

      You can associate up to 50 tags with a job as long as they have unique\n tag keys.

      \n
    • \n
    • \n

      A tag key can be up to 128 Unicode characters in length, and tag values\n can be up to 256 Unicode characters in length.

      \n
    • \n
    • \n

      The key and values are case sensitive.

      \n
    • \n
    • \n

      For tagging-related restrictions related to characters and encodings, see\n User-Defined Tag Restrictions in the Billing and Cost Management User Guide.

      \n
    • \n
    \n
  • \n
\n
\n
\n
Permissions
\n
\n

To use the PutJobTagging operation, you must have permission to\n perform the s3:PutJobTagging action.

\n
\n
\n

Related actions include:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -19468,7 +19639,7 @@ "target": "com.amazonaws.s3control#PutMultiRegionAccessPointPolicyResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only\n one policy, so a request made to this action replaces any existing policy that is\n associated with the specified Multi-Region Access Point.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.

\n

The following actions are related to\n PutMultiRegionAccessPointPolicy:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only\n one policy, so a request made to this action replaces any existing policy that is\n associated with the specified Multi-Region Access Point.

\n

This action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.

\n

The following actions are related to\n PutMultiRegionAccessPointPolicy:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -19565,7 +19736,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Creates or modifies the PublicAccessBlock configuration for an\n Amazon Web Services account. For this operation, users must have the\n s3:PutAccountPublicAccessBlock permission. For more information, see \n Using Amazon S3 block public access.

\n

Related actions include:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Creates or modifies the PublicAccessBlock configuration for an\n Amazon Web Services account. For this operation, users must have the\n s3:PutAccountPublicAccessBlock permission. For more information, see \n Using Amazon S3 block public access.

\n

Related actions include:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -19619,7 +19790,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with\n Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n
", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with\n Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -19685,7 +19856,7 @@ "target": "com.amazonaws.s3control#PutStorageLensConfigurationTaggingResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information\n about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:PutStorageLensConfigurationTagging action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n
", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information\n about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.

\n \n

To use this action, you must have permission to perform the\n s3:PutStorageLensConfigurationTagging action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.

\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -20464,6 +20635,26 @@ } } }, + "com.amazonaws.s3control#S3ComputeObjectChecksumOperation": { + "type": "structure", + "members": { + "ChecksumAlgorithm": { + "target": "com.amazonaws.s3control#ComputeObjectChecksumAlgorithm", + "traits": { + "smithy.api#documentation": "

Indicates the algorithm that you want Amazon S3 to use to create the checksum. For more\n information, see Checking object\n integrity in the Amazon S3 User Guide.

" + } + }, + "ChecksumType": { + "target": "com.amazonaws.s3control#ComputeObjectChecksumType", + "traits": { + "smithy.api#documentation": "

Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum\n value. For more information, see Checking object\n integrity in the Amazon S3 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Directs the specified job to invoke the ComputeObjectChecksum operation on every object listed in the job's manifest.

" + } + }, "com.amazonaws.s3control#S3ContentLength": { "type": "long", "traits": { @@ -20479,7 +20670,7 @@ "TargetResource": { "target": "com.amazonaws.s3control#S3RegionalOrS3ExpressBucketArnString", "traits": { - "smithy.api#documentation": "

Specifies the destination bucket\n Amazon Resource Name\n (ARN)\n for the batch copy operation.

\n
    \n
  • \n

    \n General purpose buckets - For example, to copy objects to a general purpose bucket named\n destinationBucket, set the TargetResource property to\n arn:aws:s3:::destinationBucket.

    \n
  • \n
  • \n

    \n Directory buckets - For example, to copy objects to a directory bucket named\n destinationBucket in the Availability Zone identified by the AZ ID usw2-az1, set the TargetResource property to\n arn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az1--x-s3. A directory bucket as a destination bucket can be in Availability Zone or Local Zone.

    \n \n

    Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, \n you get an HTTP 400 Bad Request error with the error code InvalidRequest.

    \n
    \n
  • \n
" + "smithy.api#documentation": "

Specifies the destination bucket\n Amazon Resource Name\n (ARN)\n for the batch copy operation.

\n
    \n
  • \n

    \n General purpose buckets - For example, to copy\n objects to a general purpose bucket named destinationBucket, set the\n TargetResource property to\n arn:aws:s3:::destinationBucket.

    \n
  • \n
  • \n

    \n Directory buckets - For example, to copy\n objects to a directory bucket named destinationBucket in the Availability Zone\n identified by the AZ ID usw2-az1, set the TargetResource\n property to\n arn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az1--x-s3.\n A directory bucket as a destination bucket can be in Availability Zone or Local Zone.

    \n \n

    Copying objects across different Amazon Web Services Regions isn't supported when the source\n or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must\n have the same parent Amazon Web Services Region. Otherwise, you get an HTTP 400 Bad\n Request error with the error code InvalidRequest.

    \n
    \n
  • \n
" } }, "CannedAccessControlList": { @@ -20515,13 +20706,13 @@ "NewObjectTagging": { "target": "com.amazonaws.s3control#S3TagSet", "traits": { - "smithy.api#documentation": "

Specifies a list of tags to add to the destination objects after they are copied. \n If NewObjectTagging is not specified, the tags of the source objects are copied to destination objects by default.

\n \n

\n Directory buckets - Tags aren't supported by directory buckets. \n If your source objects have tags and your destination bucket is a directory bucket, specify an empty tag set in the NewObjectTagging field \n to prevent copying the source object tags to the directory bucket.

\n
" + "smithy.api#documentation": "

Specifies a list of tags to add to the destination objects after they are copied. If\n NewObjectTagging is not specified, the tags of the source objects are\n copied to destination objects by default.

\n \n

\n Directory buckets - Tags aren't supported by\n directory buckets. If your source objects have tags and your destination bucket is a\n directory bucket, specify an empty tag set in the NewObjectTagging field\n to prevent copying the source object tags to the directory bucket.

\n
" } }, "RedirectLocation": { "target": "com.amazonaws.s3control#NonEmptyMaxLength2048String", "traits": { - "smithy.api#documentation": "

If the destination bucket is configured as a website, specifies an optional metadata property for website redirects,\n x-amz-website-redirect-location. Allows webpage redirects if the object copy is\n accessed through a website endpoint.

\n \n

This functionality is not supported by directory buckets.

\n
" + "smithy.api#documentation": "

If the destination bucket is configured as a website, specifies an optional metadata\n property for website redirects, x-amz-website-redirect-location. Allows\n webpage redirects if the object copy is accessed through a website endpoint.

\n \n

This functionality is not supported by directory buckets.

\n
" } }, "RequesterPays": { @@ -20534,7 +20725,7 @@ "StorageClass": { "target": "com.amazonaws.s3control#S3StorageClass", "traits": { - "smithy.api#documentation": "

Specify the storage class for the destination objects in a Copy operation.

\n \n

\n Directory buckets - This functionality is not supported by directory buckets.

\n
" + "smithy.api#documentation": "

Specify the storage class for the destination objects in a Copy\n operation.

\n \n

\n Directory buckets -\n This functionality is not supported by directory buckets.

\n
" } }, "UnModifiedSinceConstraint": { @@ -20749,7 +20940,7 @@ "SourceBucket": { "target": "com.amazonaws.s3control#S3BucketArnString", "traits": { - "smithy.api#documentation": "

The ARN of the source bucket used by the ManifestGenerator.

\n \n

\n Directory buckets - Directory buckets aren't supported \n as the source buckets used by S3JobManifestGenerator to generate the job manifest.

\n
", + "smithy.api#documentation": "

The ARN of the source bucket used by the ManifestGenerator.

\n \n

\n Directory buckets - Directory buckets\n aren't supported as the source buckets used by S3JobManifestGenerator to\n generate the job manifest.

\n
", "smithy.api#required": {} } }, @@ -20762,7 +20953,7 @@ "Filter": { "target": "com.amazonaws.s3control#JobManifestGeneratorFilter", "traits": { - "smithy.api#documentation": "

Specifies rules the S3JobManifestGenerator should use to decide whether an object\n in the source bucket should or should not be included in the generated job manifest.

" + "smithy.api#documentation": "

Specifies rules the S3JobManifestGenerator should use to decide whether an object in the\n source bucket should or should not be included in the generated job manifest.

" } }, "EnableManifestOutput": { @@ -20800,7 +20991,7 @@ "Bucket": { "target": "com.amazonaws.s3control#S3BucketArnString", "traits": { - "smithy.api#documentation": "

The bucket ARN the generated manifest should be written to.

\n \n

\n Directory buckets - Directory buckets aren't supported \n as the buckets to store the generated manifest.

\n
", + "smithy.api#documentation": "

The bucket ARN the generated manifest should be written to.

\n \n

\n Directory buckets - Directory buckets\n aren't supported as the buckets to store the generated manifest.

\n
", "smithy.api#required": {} } }, @@ -20979,7 +21170,7 @@ "SSEAlgorithm": { "target": "com.amazonaws.s3control#S3SSEAlgorithm", "traits": { - "smithy.api#documentation": "

The server-side encryption algorithm used when storing objects in Amazon S3.

\n

\n Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (KMS). For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For the Copy operation in Batch Operations, see S3CopyObjectOperation.

" + "smithy.api#documentation": "

The server-side encryption algorithm used when storing objects in Amazon S3.

\n

\n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (KMS). For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.\n For the Copy operation in Batch Operations, see S3CopyObjectOperation.

" } } }, @@ -21300,6 +21491,13 @@ } } }, + "com.amazonaws.s3control#SSECFilter": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A filter that returns objects that are encrypted by server-side encryption with customer-provided keys (SSE-C).

" + } + }, "com.amazonaws.s3control#SSEKMS": { "type": "structure", "members": { @@ -21332,6 +21530,27 @@ "smithy.api#xmlName": "SSE-KMS" } }, + "com.amazonaws.s3control#SSEKMSFilter": { + "type": "structure", + "members": { + "KmsKeyArn": { + "target": "com.amazonaws.s3control#NonEmptyKmsKeyArnString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer managed KMS key to use for the filter \n to return objects that are encrypted by the specified key. For best performance, \n we recommend using the KMSKeyArn filter in conjunction with other object metadata filters, like MatchAnyPrefix, CreatedAfter, or \n MatchAnyStorageClass.

\n \n

You must provide the full KMS Key ARN. You can't use an alias name or alias ARN. \n For more information, see \n KMS keys in the Amazon Web Services Key Management Service Developer Guide.

\n
" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3control#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption \n using Amazon Web Services Key Management Service (Amazon Web Services KMS) keys (SSE-KMS). If specified, will filter SSE-KMS encrypted objects by S3 Bucket Key status. \n For more information, see Reducing the cost of SSE-KMS with Amazon S3 Bucket Keys\n in the Amazon S3 User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that returns objects that are encrypted by server-side encryption with Amazon Web Services KMS (SSE-KMS).

" + } + }, "com.amazonaws.s3control#SSEKMSKeyId": { "type": "string" }, @@ -21351,13 +21570,20 @@ "smithy.api#xmlName": "SSE-S3" } }, + "com.amazonaws.s3control#SSES3Filter": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A filter that returns objects that are encrypted by server-side encryption with Amazon S3 managed keys (SSE-S3).

" + } + }, "com.amazonaws.s3control#Scope": { "type": "structure", "members": { "Prefixes": { "target": "com.amazonaws.s3control#PrefixesList", "traits": { - "smithy.api#documentation": "

You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.

", + "smithy.api#documentation": "

You can specify any amount of prefixes, but the total length of characters of all\n prefixes must be less than 256 bytes in size.

", "smithy.api#xmlName": "Prefixes" } }, @@ -21370,7 +21596,7 @@ } }, "traits": { - "smithy.api#documentation": "

You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.

\n

For more information, see Manage the scope of your access points for directory buckets.

" + "smithy.api#documentation": "

You can use the access point scope to restrict access to specific prefixes, API operations, or a\n combination of both.

\n

For more information, see Manage\n the scope of your access points for directory buckets.

" } }, "com.amazonaws.s3control#ScopePermission": { @@ -21882,25 +22108,25 @@ "MatchAnySuffix": { "target": "com.amazonaws.s3control#MatchAnySuffix", "traits": { - "smithy.api#documentation": "

\nFilters objects that match any of the specified suffixes.\n

" + "smithy.api#documentation": "

Filters objects that match any of the specified suffixes.

" } }, "MatchAnyTag": { "target": "com.amazonaws.s3control#MatchAnyTag", "traits": { - "smithy.api#documentation": "

\nFilters objects that match any of the specified S3 object tags.\n

" + "smithy.api#documentation": "

Filters objects that match any of the specified S3 object tags.

" } }, "MatchObjectAge": { "target": "com.amazonaws.s3control#MatchObjectAge", "traits": { - "smithy.api#documentation": "

\nFilters objects that match the specified object age range.\n

" + "smithy.api#documentation": "

Filters objects that match the specified object age range.

" } }, "MatchObjectSize": { "target": "com.amazonaws.s3control#MatchObjectSize", "traits": { - "smithy.api#documentation": "

\nFilters objects that match the specified object size range.\n

" + "smithy.api#documentation": "

Filters objects that match the specified object size range.

" } } }, @@ -21976,7 +22202,7 @@ "target": "com.amazonaws.s3control#SubmitMultiRegionAccessPointRoutesResult" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the\n routing status for the specified Regions from active to passive, or from passive to active.\n A value of 0 indicates a passive status, which means that traffic won't be\n routed to the specified Region. A value of 100 indicates an active status,\n which means that traffic will be routed to the specified Region. At least one Region must\n be active at all times.

\n

When the routing configuration is changed, any in-progress operations (uploads, copies,\n deletes, and so on) to formerly active Regions will continue to run to their final\n completion state (success or failure). The routing configurations of any Regions that\n aren’t specified remain unchanged.

\n \n

Updated routing configurations might not be immediately applied. It can take up to 2\n minutes for your changes to take effect.

\n
\n

To submit routing control changes and failover requests, use the Amazon S3 failover control\n infrastructure endpoints in these five Amazon Web Services Regions:

\n
    \n
  • \n

    \n us-east-1\n

    \n
  • \n
  • \n

    \n us-west-2\n

    \n
  • \n
  • \n

    \n ap-southeast-2\n

    \n
  • \n
  • \n

    \n ap-northeast-1\n

    \n
  • \n
  • \n

    \n eu-west-1\n

    \n
  • \n
", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n
\n

Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the\n routing status for the specified Regions from active to passive, or from passive to active.\n A value of 0 indicates a passive status, which means that traffic won't be\n routed to the specified Region. A value of 100 indicates an active status,\n which means that traffic will be routed to the specified Region. At least one Region must\n be active at all times.

\n

When the routing configuration is changed, any in-progress operations (uploads, copies,\n deletes, and so on) to formerly active Regions will continue to run to their final\n completion state (success or failure). The routing configurations of any Regions that\n aren’t specified remain unchanged.

\n \n

Updated routing configurations might not be immediately applied. It can take up to 2\n minutes for your changes to take effect.

\n
\n

To submit routing control changes and failover requests, use the Amazon S3 failover control\n infrastructure endpoints in these five Amazon Web Services Regions:

\n
    \n
  • \n

    \n us-east-1\n

    \n
  • \n
  • \n

    \n us-west-2\n

    \n
  • \n
  • \n

    \n ap-southeast-2\n

    \n
  • \n
  • \n

    \n ap-northeast-1\n

    \n
  • \n
  • \n

    \n eu-west-1\n

    \n
  • \n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -22056,20 +22282,20 @@ "Key": { "target": "com.amazonaws.s3control#TagKeyString", "traits": { - "smithy.api#documentation": "

The key of the key-value pair of a tag added to your Amazon Web Services resource. A tag key can be up to 128 Unicode characters in length and is case-sensitive. System created tags that begin with aws: aren’t supported.\n

", + "smithy.api#documentation": "

The key of the key-value pair of a tag added to your Amazon Web Services resource. A tag key can be up\n to 128 Unicode characters in length and is case-sensitive. System created tags that begin\n with aws: aren’t supported.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.s3control#TagValueString", "traits": { - "smithy.api#documentation": "

\n The value of the key-value pair of a tag added to your Amazon Web Services resource. A tag value can be up to 256 Unicode characters in length and is case-sensitive.\n

", + "smithy.api#documentation": "

The value of the key-value pair of a tag added to your Amazon Web Services resource. A tag value can\n be up to 256 Unicode characters in length and is case-sensitive.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n A key-value pair that you use to label your resources. You can add tags to new resources when you create them, or you can add tags to existing resources. Tags can help you organize, track costs for, and control access to resources.\n

" + "smithy.api#documentation": "

A key-value pair that you use to label your resources. You can add tags to new\n resources when you create them, or you can add tags to existing resources. Tags can help\n you organize, track costs for, and control access to resources.

" } }, "com.amazonaws.s3control#TagKeyList": { @@ -22118,7 +22344,7 @@ "target": "com.amazonaws.s3control#TagResourceResult" }, "traits": { - "smithy.api#documentation": "

Creates a new user-defined tag or updates an existing tag. Each tag is a label consisting of a key and value that is applied to your resource. Tags can help you organize, track costs for, and control access to your resources. You can add up to 50 Amazon Web Services resource tags for each S3 resource.

\n \n

This operation is only supported for the following Amazon S3 resource:

\n \n
\n
\n
Permissions
\n
\n

For Storage Lens groups and S3 Access Grants, you must have the s3:TagResource permission to use this operation.

\n

For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

\n
\n
Directory bucket permissions
\n
\n

For directory buckets, you must have the s3express:TagResource permission to use this operation. For more information about directory buckets policies and permissions, see Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

\n
\n
\n

For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.

", + "smithy.api#documentation": "

Creates a new user-defined tag or updates an existing tag. Each tag is a label consisting of a key and value that is applied to your resource. Tags can help you organize, track costs for, and control access to your resources. You can add up to 50 Amazon Web Services resource tags for each S3 resource.

\n \n

This operation is only supported for the following Amazon S3 resource:

\n \n
\n \n

This operation is only supported for the following Amazon S3 resource:

\n \n
\n
\n
Permissions
\n
\n

For Storage Lens groups and S3 Access Grants, you must have the\n s3:TagResource permission to use this operation.

\n

For more information about the required Storage Lens Groups permissions, see\n Setting account permissions to use S3 Storage Lens groups.

\n
\n
Directory bucket permissions
\n
\n

For directory buckets and access points for directory buckets, you must have the s3express:TagResource permission to use this operation. For more information about directory buckets policies and permissions, see Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

\n
\n
\n

For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -22152,7 +22378,7 @@ "ResourceArn": { "target": "com.amazonaws.s3control#S3ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the S3 resource that you're applying tags to. The tagged resource can be a directory bucket, S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the S3 resource that you're applying tags to. The\n tagged resource can be a directory bucket, S3 Storage Lens group or S3 Access Grants instance,\n registered location, or grant.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -22163,7 +22389,7 @@ "Tags": { "target": "com.amazonaws.s3control#TagList", "traits": { - "smithy.api#documentation": "

\nThe Amazon Web Services resource tags that you want to add to the specified S3 resource. \n

", + "smithy.api#documentation": "

The Amazon Web Services resource tags that you want to add to the specified S3 resource.

", "smithy.api#required": {} } } @@ -22320,7 +22546,7 @@ "target": "com.amazonaws.s3control#UntagResourceResult" }, "traits": { - "smithy.api#documentation": "

This operation removes the specified user-defined tags from an S3 resource. You can pass one or more tag keys.

\n \n

This operation is only supported for the following Amazon S3 resources:

\n \n
\n
\n
Permissions
\n
\n

For Storage Lens groups and S3 Access Grants, you must have the s3:UntagResource permission to use this operation.

\n

For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

\n
\n
Directory bucket permissions
\n
\n

For directory buckets, you must have the s3express:UntagResource permission to use this operation. For more information about directory buckets policies and permissions, see Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

\n
\n
\n

For information about S3 Tagging errors, see List of Amazon S3\n Tagging error codes.

", + "smithy.api#documentation": "

This operation removes the specified user-defined tags from an S3 resource. You can pass\n one or more tag keys.

\n \n

This operation is only supported for the following Amazon S3 resources:

\n \n
\n
\n
Permissions
\n
\n

For Storage Lens groups and S3 Access Grants, you must have the\n s3:UntagResource permission to use this operation.

\n

For more information about the required Storage Lens Groups permissions, see\n Setting account permissions to use S3 Storage Lens groups.

\n
\n
Directory bucket permissions
\n
\n

For directory buckets and access points for directory buckets, you must have\n the s3express:UntagResource permission to use this operation.\n For more information about directory buckets policies and permissions, see Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

\n
\n
\n

For information about S3 Tagging errors, see List of Amazon S3\n Tagging error codes.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -22342,7 +22568,7 @@ "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { - "smithy.api#documentation": "

\n The Amazon Web Services account ID that owns the resource that you're trying to remove the tags from.\n

", + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the resource that you're trying to remove the tags from.\n

", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, @@ -22354,7 +22580,7 @@ "ResourceArn": { "target": "com.amazonaws.s3control#S3ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the S3 resource that you're removing tags from. The tagged resource can be a directory bucket, S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the S3 resource that you're removing tags from. The\n tagged resource can be a directory bucket, S3 Storage Lens group or S3 Access Grants instance,\n registered location, or grant.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -22365,7 +22591,7 @@ "TagKeys": { "target": "com.amazonaws.s3control#TagKeyList", "traits": { - "smithy.api#documentation": "

\n The array of tag key-value pairs that you're trying to remove from of the S3 resource.\n

", + "smithy.api#documentation": "

The array of tag key-value pairs that you're trying to remove from of the S3 resource.\n

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -22391,7 +22617,7 @@ "target": "com.amazonaws.s3control#UpdateAccessGrantsLocationResult" }, "traits": { - "smithy.api#documentation": "

Updates the IAM role of a registered location in your S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:UpdateAccessGrantsLocation permission to use this operation.

\n
\n
Additional Permissions
\n
\n

You must also have the following permission: iam:PassRole\n

\n
\n
", + "smithy.api#documentation": "

Updates the IAM role of a registered location in your S3 Access Grants instance.

\n
\n
Permissions
\n
\n

You must have the s3:UpdateAccessGrantsLocation permission to use\n this operation.

\n
\n
Additional Permissions
\n
\n

You must also have the following permission: iam:PassRole\n

\n
\n
\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -22426,7 +22652,7 @@ "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { - "smithy.api#documentation": "

The ID of the registered location that you are updating. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

\n

The ID of the registered location to which you are granting access. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

\n

If you are passing the default location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the Subprefix field.

", + "smithy.api#documentation": "

The ID of the registered location that you are updating. S3 Access Grants assigns this ID when you\n register the location. S3 Access Grants assigns the ID default to the default location\n s3:// and assigns an auto-generated ID to other locations that you\n register.

\n

The ID of the registered location to which you are granting access. S3 Access Grants assigned this\n ID when you registered the location. S3 Access Grants assigns the ID default to the\n default location s3:// and assigns an auto-generated ID to other locations\n that you register.

\n

If you are passing the default location, you cannot create an access grant\n for the entire default location. You must also specify a bucket or a bucket and prefix in\n the Subprefix field.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -22434,7 +22660,7 @@ "IAMRoleArn": { "target": "com.amazonaws.s3control#IAMRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants\n assumes this role to manage access to the registered location.

", "smithy.api#required": {} } } @@ -22455,7 +22681,7 @@ "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { - "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

" + "smithy.api#documentation": "

The ID of the registered location to which you are granting access. S3 Access Grants assigned this\n ID when you registered the location. S3 Access Grants assigns the ID default to the\n default location s3:// and assigns an auto-generated ID to other locations\n that you register.

" } }, "AccessGrantsLocationArn": { @@ -22467,13 +22693,13 @@ "LocationScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { - "smithy.api#documentation": "

The S3 URI path of the location that you are updating. You cannot update the scope of the registered location. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://, or the S3 path to a bucket and prefix s3:///.

" + "smithy.api#documentation": "

The S3 URI path of the location that you are updating. You cannot update the scope of\n the registered location. The location scope can be the default S3 location\n s3://, the S3 path to a bucket s3://, or the S3\n path to a bucket and prefix s3:///.

" } }, "IAMRoleArn": { "target": "com.amazonaws.s3control#IAMRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role of the registered location. S3 Access Grants assumes this role to manage access to the registered location.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role of the registered location. S3 Access Grants\n assumes this role to manage access to the registered location.

" } } }, @@ -22504,7 +22730,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use the\n UpdateJobPriority operation, you must have permission to\n perform the s3:UpdateJobPriority action.

\n
\n
\n

Related actions include:

\n ", + "smithy.api#documentation": "

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use the UpdateJobPriority operation, you must have permission\n to perform the s3:UpdateJobPriority action.

\n
\n
\n

Related actions include:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -22606,7 +22832,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the status for the specified job. Use this operation to confirm that you want to\n run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use the\n UpdateJobStatus operation, you must have permission to\n perform the s3:UpdateJobStatus action.

\n
\n
\n

Related actions include:

\n ", + "smithy.api#documentation": "

Updates the status for the specified job. Use this operation to confirm that you want to\n run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

\n
\n
Permissions
\n
\n

To use the UpdateJobStatus operation, you must have permission to\n perform the s3:UpdateJobStatus action.

\n
\n
\n

Related actions include:

\n \n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, @@ -22700,7 +22926,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

\nUpdates the existing Storage Lens group.

\n

To use this operation, you must have the permission to perform the\n s3:UpdateStorageLensGroup action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

\n

For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.

", + "smithy.api#documentation": "

\nUpdates the existing Storage Lens group.

\n

To use this operation, you must have the permission to perform the\n s3:UpdateStorageLensGroup action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.

\n

For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.

\n \n

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

\n
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, diff --git a/codegen/sdk/aws-models/s3.json b/codegen/sdk/aws-models/s3.json index f2122a975f5..00f9ff32dc6 100644 --- a/codegen/sdk/aws-models/s3.json +++ b/codegen/sdk/aws-models/s3.json @@ -25718,7 +25718,7 @@ "type": "boolean" }, "com.amazonaws.s3#Expires": { - "type": "timestamp" + "type": "string" }, "com.amazonaws.s3#ExposeHeader": { "type": "string" @@ -37087,7 +37087,7 @@ "Payload": { "target": "com.amazonaws.s3#Body", "traits": { - "smithy.api#documentation": "

The byte array of partial, one or more result records. S3 Select doesn't guarantee that a record\n will be self-contained in one record frame. To ensure continuous streaming of data, S3 Select might\n split the same record across multiple record frames instead of aggregating the results in memory. Some\n S3 clients (for example, the SDKforJava) handle this behavior by creating a\n ByteStream out of the response by default. Other clients might not handle this behavior\n by default. In those cases, you must aggregate the results on the client side and parse the\n response.

", + "smithy.api#documentation": "

The byte array of partial, one or more result records. S3 Select doesn't guarantee that a record\n will be self-contained in one record frame. To ensure continuous streaming of data, S3 Select might\n split the same record across multiple record frames instead of aggregating the results in memory. Some\n S3 clients (for example, the SDK for Java) handle this behavior by creating a\n ByteStream out of the response by default. Other clients might not handle this behavior\n by default. In those cases, you must aggregate the results on the client side and parse the\n response.

", "smithy.api#eventPayload": {} } } diff --git a/codegen/sdk/aws-models/s3outposts.json b/codegen/sdk/aws-models/s3outposts.json index 33a96e5b0c3..8c9dc54f593 100644 --- a/codegen/sdk/aws-models/s3outposts.json +++ b/codegen/sdk/aws-models/s3outposts.json @@ -1579,17 +1579,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1603,17 +1592,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1627,17 +1605,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1651,17 +1618,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/s3tables.json b/codegen/sdk/aws-models/s3tables.json index 1aa8cbbdd9c..fbb008bc59f 100644 --- a/codegen/sdk/aws-models/s3tables.json +++ b/codegen/sdk/aws-models/s3tables.json @@ -3586,17 +3586,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3610,17 +3599,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3634,17 +3612,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3658,17 +3625,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/s3vectors.json b/codegen/sdk/aws-models/s3vectors.json index 718bc63d570..c308a1b3a1b 100644 --- a/codegen/sdk/aws-models/s3vectors.json +++ b/codegen/sdk/aws-models/s3vectors.json @@ -2126,102 +2126,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://s3vectors-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://s3vectors.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://s3vectors-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://s3vectors.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://s3vectors-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://s3vectors.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://s3vectors-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://s3vectors.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { diff --git a/codegen/sdk/aws-models/sagemaker-a2i-runtime.json b/codegen/sdk/aws-models/sagemaker-a2i-runtime.json index 112e05d2737..79d31d3bf89 100644 --- a/codegen/sdk/aws-models/sagemaker-a2i-runtime.json +++ b/codegen/sdk/aws-models/sagemaker-a2i-runtime.json @@ -535,17 +535,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -559,17 +548,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -583,17 +561,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -607,17 +574,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/sagemaker-edge.json b/codegen/sdk/aws-models/sagemaker-edge.json index b0fb191aa87..e0b1450683a 100644 --- a/codegen/sdk/aws-models/sagemaker-edge.json +++ b/codegen/sdk/aws-models/sagemaker-edge.json @@ -594,17 +594,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -618,17 +607,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -642,17 +620,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -666,17 +633,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/sagemaker-featurestore-runtime.json b/codegen/sdk/aws-models/sagemaker-featurestore-runtime.json index d5b49fa58a1..999447a7545 100644 --- a/codegen/sdk/aws-models/sagemaker-featurestore-runtime.json +++ b/codegen/sdk/aws-models/sagemaker-featurestore-runtime.json @@ -545,17 +545,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -569,17 +558,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -593,17 +571,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -617,17 +584,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/sagemaker-geospatial.json b/codegen/sdk/aws-models/sagemaker-geospatial.json index 245736a9ca3..654271e3fb8 100644 --- a/codegen/sdk/aws-models/sagemaker-geospatial.json +++ b/codegen/sdk/aws-models/sagemaker-geospatial.json @@ -3661,17 +3661,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3685,17 +3674,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3709,17 +3687,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3733,17 +3700,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/sagemaker-metrics.json b/codegen/sdk/aws-models/sagemaker-metrics.json index 01dcf6ecd4f..7bebdfc7e4f 100644 --- a/codegen/sdk/aws-models/sagemaker-metrics.json +++ b/codegen/sdk/aws-models/sagemaker-metrics.json @@ -1459,17 +1459,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1483,17 +1472,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1507,17 +1485,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1531,17 +1498,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/sagemaker-runtime.json b/codegen/sdk/aws-models/sagemaker-runtime.json index 473ef10b797..1e09131d6c3 100644 --- a/codegen/sdk/aws-models/sagemaker-runtime.json +++ b/codegen/sdk/aws-models/sagemaker-runtime.json @@ -56,7 +56,7 @@ "name": "sagemaker" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The Amazon SageMaker runtime API.

", + "smithy.api#documentation": "

The Amazon SageMaker AI runtime API.

", "smithy.api#title": "Amazon SageMaker Runtime", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -931,17 +931,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -955,28 +944,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -990,17 +957,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1236,7 +1192,7 @@ } ], "traits": { - "smithy.api#documentation": "

After you deploy a model into production using Amazon SageMaker hosting services,\n your client applications use this API to get inferences from the model hosted at the\n specified endpoint.

\n

For an overview of Amazon SageMaker, see How It Works.

\n

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add\n additional headers. You should not rely on the behavior of headers outside those\n enumerated in the request syntax.

\n

Calls to InvokeEndpoint are authenticated by using Amazon Web Services\n Signature Version 4. For information, see Authenticating\n Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

\n

A customer's model containers must respond to requests within 60 seconds. The model\n itself can have a maximum processing time of 60 seconds before responding to\n invocations. If your model is going to take 50-60 seconds of processing time, the SDK\n socket timeout should be set to be 70 seconds.

\n \n

Endpoints are scoped to an individual account, and are not public. The URL does\n not contain the account ID, but Amazon SageMaker determines the account ID from\n the authentication token that is supplied by the caller.

\n
", + "smithy.api#documentation": "

After you deploy a model into production using Amazon SageMaker AI hosting services,\n your client applications use this API to get inferences from the model hosted at the\n specified endpoint.

\n

For an overview of Amazon SageMaker AI, see How It Works.

\n

Amazon SageMaker AI strips all POST headers except those supported by the API. Amazon SageMaker AI might add\n additional headers. You should not rely on the behavior of headers outside those\n enumerated in the request syntax.

\n

Calls to InvokeEndpoint are authenticated by using Amazon Web Services\n Signature Version 4. For information, see Authenticating\n Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

\n

A customer's model containers must respond to requests within 60 seconds. The model\n itself can have a maximum processing time of 60 seconds before responding to\n invocations. If your model is going to take 50-60 seconds of processing time, the SDK\n socket timeout should be set to be 70 seconds.

\n \n

Endpoints are scoped to an individual account, and are not public. The URL does\n not contain the account ID, but Amazon SageMaker AI determines the account ID from\n the authentication token that is supplied by the caller.

\n
", "smithy.api#http": { "method": "POST", "uri": "/endpoints/{EndpointName}/invocations", @@ -1264,7 +1220,7 @@ } ], "traits": { - "smithy.api#documentation": "

After you deploy a model into production using Amazon SageMaker hosting services,\n your client applications use this API to get inferences from the model hosted at the\n specified endpoint in an asynchronous manner.

\n

Inference requests sent to this API are enqueued for asynchronous processing. The\n processing of the inference request may or may not complete before you receive a\n response from this API. The response from this API will not contain the result of the\n inference request but contain information about where you can locate it.

\n

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add\n additional headers. You should not rely on the behavior of headers outside those\n enumerated in the request syntax.

\n

Calls to InvokeEndpointAsync are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating\n Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

", + "smithy.api#documentation": "

After you deploy a model into production using Amazon SageMaker AI hosting services,\n your client applications use this API to get inferences from the model hosted at the\n specified endpoint in an asynchronous manner.

\n

Inference requests sent to this API are enqueued for asynchronous processing. The\n processing of the inference request may or may not complete before you receive a\n response from this API. The response from this API will not contain the result of the\n inference request but contain information about where you can locate it.

\n

Amazon SageMaker AI strips all POST headers except those supported by the API. Amazon SageMaker AI might add\n additional headers. You should not rely on the behavior of headers outside those\n enumerated in the request syntax.

\n

Calls to InvokeEndpointAsync are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating\n Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

", "smithy.api#http": { "method": "POST", "uri": "/endpoints/{EndpointName}/async-invocations", @@ -1300,14 +1256,14 @@ "CustomAttributes": { "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", "traits": { - "smithy.api#documentation": "

Provides additional information about a request for an inference submitted to a model\n hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded\n verbatim. You could use this value, for example, to provide an ID that you can use to\n track a request or to provide other metadata that a service endpoint was programmed to\n process. The value must consist of no more than 1024 visible US-ASCII characters as\n specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol\n (HTTP/1.1).

\n

The code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.

\n

This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker\n Python SDK.

", + "smithy.api#documentation": "

Provides additional information about a request for an inference submitted to a model\n hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is forwarded\n verbatim. You could use this value, for example, to provide an ID that you can use to\n track a request or to provide other metadata that a service endpoint was programmed to\n process. The value must consist of no more than 1024 visible US-ASCII characters as\n specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol\n (HTTP/1.1).

\n

The code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.

\n

This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker AI\n Python SDK.

", "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" } }, "InferenceId": { "target": "com.amazonaws.sagemakerruntime#InferenceId", "traits": { - "smithy.api#documentation": "

The identifier for the inference request. Amazon SageMaker will generate an\n identifier for you if none is specified.

", + "smithy.api#documentation": "

The identifier for the inference request. Amazon SageMaker AI will generate an\n identifier for you if none is specified.

", "smithy.api#httpHeader": "X-Amzn-SageMaker-Inference-Id" } }, @@ -1345,7 +1301,7 @@ "InferenceId": { "target": "com.amazonaws.sagemakerruntime#Header", "traits": { - "smithy.api#documentation": "

Identifier for an inference request. This will be the same as the\n InferenceId specified in the input. Amazon SageMaker will generate\n an identifier for you if you do not specify one.

" + "smithy.api#documentation": "

Identifier for an inference request. This will be the same as the\n InferenceId specified in the input. Amazon SageMaker AI will generate\n an identifier for you if you do not specify one.

" } }, "OutputLocation": { @@ -1382,7 +1338,7 @@ "target": "com.amazonaws.sagemakerruntime#BodyBlob", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Provides input data, in the format specified in the ContentType\n request header. Amazon SageMaker passes all of the data in the body to the model.

\n

For information about the format of the request body, see Common Data\n Formats-Inference.

", + "smithy.api#documentation": "

Provides input data, in the format specified in the ContentType\n request header. Amazon SageMaker AI passes all of the data in the body to the model.

\n

For information about the format of the request body, see Common Data\n Formats-Inference.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -1404,7 +1360,7 @@ "CustomAttributes": { "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", "traits": { - "smithy.api#documentation": "

Provides additional information about a request for an inference submitted to a model\n hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded\n verbatim. You could use this value, for example, to provide an ID that you can use to\n track a request or to provide other metadata that a service endpoint was programmed to\n process. The value must consist of no more than 1024 visible US-ASCII characters as\n specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol\n (HTTP/1.1).

\n

The code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.

\n

This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker\n Python SDK.

", + "smithy.api#documentation": "

Provides additional information about a request for an inference submitted to a model\n hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is forwarded\n verbatim. You could use this value, for example, to provide an ID that you can use to\n track a request or to provide other metadata that a service endpoint was programmed to\n process. The value must consist of no more than 1024 visible US-ASCII characters as\n specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol\n (HTTP/1.1).

\n

The code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.

\n

This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker AI\n Python SDK.

", "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" } }, @@ -1453,7 +1409,7 @@ "SessionId": { "target": "com.amazonaws.sagemakerruntime#SessionIdOrNewSessionConstantHeader", "traits": { - "smithy.api#documentation": "

Creates a stateful session or identifies an existing one. You can do one of the\n following:

\n
    \n
  • \n

    Create a stateful session by specifying the value\n NEW_SESSION.

    \n
  • \n
  • \n

    Send your request to an existing stateful session by specifying the ID of that\n session.

    \n
  • \n
\n

With a stateful session, you can send multiple requests to a stateful model. When you\n create a session with a stateful model, the model must create the session ID and set the\n expiration time. The model must also provide that information in the response to your\n request. You can get the ID and timestamp from the NewSessionId response\n parameter. For any subsequent request where you specify that session ID, SageMaker routes the request to the same instance that supports the session.

", + "smithy.api#documentation": "

Creates a stateful session or identifies an existing one. You can do one of the\n following:

\n
    \n
  • \n

    Create a stateful session by specifying the value\n NEW_SESSION.

    \n
  • \n
  • \n

    Send your request to an existing stateful session by specifying the ID of that\n session.

    \n
  • \n
\n

With a stateful session, you can send multiple requests to a stateful model. When you\n create a session with a stateful model, the model must create the session ID and set the\n expiration time. The model must also provide that information in the response to your\n request. You can get the ID and timestamp from the NewSessionId response\n parameter. For any subsequent request where you specify that session ID, SageMaker AI routes the request to the same instance that supports the session.

", "smithy.api#httpHeader": "X-Amzn-SageMaker-Session-Id" } } @@ -1491,7 +1447,7 @@ "CustomAttributes": { "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", "traits": { - "smithy.api#documentation": "

Provides additional information in the response about the inference returned by a\n model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is\n forwarded verbatim. You could use this value, for example, to return an ID received in\n the CustomAttributes header of a request or other metadata that a service\n endpoint was programmed to produce. The value must consist of no more than 1024 visible\n US-ASCII characters as specified in Section 3.3.6. Field Value\n Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer\n wants the custom attribute returned, the model must set the custom attribute to be\n included on the way back.

\n

The code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.

\n

This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker\n Python SDK.

", + "smithy.api#documentation": "

Provides additional information in the response about the inference returned by a\n model hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is\n forwarded verbatim. You could use this value, for example, to return an ID received in\n the CustomAttributes header of a request or other metadata that a service\n endpoint was programmed to produce. The value must consist of no more than 1024 visible\n US-ASCII characters as specified in Section 3.3.6. Field Value\n Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer\n wants the custom attribute returned, the model must set the custom attribute to be\n included on the way back.

\n

The code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.

\n

This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker AI\n Python SDK.

", "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" } }, @@ -1543,7 +1499,7 @@ } ], "traits": { - "smithy.api#documentation": "

Invokes a model at the specified endpoint to return the inference response as a\n stream. The inference stream provides the response payload incrementally as a series of\n parts. Before you can get an inference stream, you must have access to a model that's\n deployed using Amazon SageMaker hosting services, and the container for that model\n must support inference streaming.

\n

For more information that can help you use this API, see the following sections in the\n Amazon SageMaker Developer Guide:

\n \n

Before you can use this operation, your IAM permissions must allow the\n sagemaker:InvokeEndpoint action. For more information about Amazon SageMaker actions for IAM policies, see Actions, resources, and condition keys for Amazon SageMaker in the IAM Service Authorization\n Reference.

\n

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add\n additional headers. You should not rely on the behavior of headers outside those\n enumerated in the request syntax.

\n

Calls to InvokeEndpointWithResponseStream are authenticated by using\n Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the\n Amazon S3 API Reference.

", + "smithy.api#documentation": "

Invokes a model at the specified endpoint to return the inference response as a\n stream. The inference stream provides the response payload incrementally as a series of\n parts. Before you can get an inference stream, you must have access to a model that's\n deployed using Amazon SageMaker AI hosting services, and the container for that model\n must support inference streaming.

\n

For more information that can help you use this API, see the following sections in the\n Amazon SageMaker AI Developer Guide:

\n \n

Before you can use this operation, your IAM permissions must allow the\n sagemaker:InvokeEndpoint action. For more information about Amazon SageMaker AI actions for IAM policies, see Actions, resources, and condition keys for Amazon SageMaker AI in the IAM Service Authorization\n Reference.

\n

Amazon SageMaker AI strips all POST headers except those supported by the API. Amazon SageMaker AI might add\n additional headers. You should not rely on the behavior of headers outside those\n enumerated in the request syntax.

\n

Calls to InvokeEndpointWithResponseStream are authenticated by using\n Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the\n Amazon S3 API Reference.

", "smithy.api#http": { "method": "POST", "uri": "/endpoints/{EndpointName}/invocations-response-stream", @@ -1566,7 +1522,7 @@ "target": "com.amazonaws.sagemakerruntime#BodyBlob", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Provides input data, in the format specified in the ContentType\n request header. Amazon SageMaker passes all of the data in the body to the model.

\n

For information about the format of the request body, see Common Data\n Formats-Inference.

", + "smithy.api#documentation": "

Provides input data, in the format specified in the ContentType\n request header. Amazon SageMaker AI passes all of the data in the body to the model.

\n

For information about the format of the request body, see Common Data\n Formats-Inference.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -1588,7 +1544,7 @@ "CustomAttributes": { "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", "traits": { - "smithy.api#documentation": "

Provides additional information about a request for an inference submitted to a model\n hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded\n verbatim. You could use this value, for example, to provide an ID that you can use to\n track a request or to provide other metadata that a service endpoint was programmed to\n process. The value must consist of no more than 1024 visible US-ASCII characters as\n specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol\n (HTTP/1.1).

\n

The code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.

\n

This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker\n Python SDK.

", + "smithy.api#documentation": "

Provides additional information about a request for an inference submitted to a model\n hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is forwarded\n verbatim. You could use this value, for example, to provide an ID that you can use to\n track a request or to provide other metadata that a service endpoint was programmed to\n process. The value must consist of no more than 1024 visible US-ASCII characters as\n specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol\n (HTTP/1.1).

\n

The code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.

\n

This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker AI\n Python SDK.

", "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" } }, @@ -1659,7 +1615,7 @@ "CustomAttributes": { "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", "traits": { - "smithy.api#documentation": "

Provides additional information in the response about the inference returned by a\n model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is\n forwarded verbatim. You could use this value, for example, to return an ID received in\n the CustomAttributes header of a request or other metadata that a service\n endpoint was programmed to produce. The value must consist of no more than 1024 visible\n US-ASCII characters as specified in Section 3.3.6. Field Value\n Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer\n wants the custom attribute returned, the model must set the custom attribute to be\n included on the way back.

\n

The code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.

\n

This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker\n Python SDK.

", + "smithy.api#documentation": "

Provides additional information in the response about the inference returned by a\n model hosted at an Amazon SageMaker AI endpoint. The information is an opaque value that is\n forwarded verbatim. You could use this value, for example, to return an ID received in\n the CustomAttributes header of a request or other metadata that a service\n endpoint was programmed to produce. The value must consist of no more than 1024 visible\n US-ASCII characters as specified in Section 3.3.6. Field Value\n Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer\n wants the custom attribute returned, the model must set the custom attribute to be\n included on the way back.

\n

The code in your model is responsible for setting or updating any custom attributes in\n the response. If your code does not set this value in the response, an empty value is\n returned. For example, if a custom attribute represents the trace ID, your model can\n prepend the custom attribute with Trace ID: in your post-processing\n function.

\n

This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker AI\n Python SDK.

", "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" } } @@ -1737,12 +1693,12 @@ "ErrorCode": { "target": "com.amazonaws.sagemakerruntime#ErrorCode", "traits": { - "smithy.api#documentation": "

This error can have the following error codes:

\n
\n
ModelInvocationTimeExceeded
\n
\n

The model failed to finish sending the response within the timeout period\n allowed by Amazon SageMaker.

\n
\n
StreamBroken
\n
\n

The Transmission Control Protocol (TCP) connection between the client and\n the model was reset or closed.

\n
\n
" + "smithy.api#documentation": "

This error can have the following error codes:

\n
\n
ModelInvocationTimeExceeded
\n
\n

The model failed to finish sending the response within the timeout period\n allowed by Amazon SageMaker AI.

\n
\n
StreamBroken
\n
\n

The Transmission Control Protocol (TCP) connection between the client and\n the model was reset or closed.

\n
\n
" } } }, "traits": { - "smithy.api#documentation": "

An error occurred while streaming the response body. This error can have the\n following error codes:

\n
\n
ModelInvocationTimeExceeded
\n
\n

The model failed to finish sending the response within the timeout period allowed by Amazon SageMaker.

\n
\n
StreamBroken
\n
\n

The Transmission Control Protocol (TCP) connection between the client and\n the model was reset or closed.

\n
\n
", + "smithy.api#documentation": "

An error occurred while streaming the response body. This error can have the\n following error codes:

\n
\n
ModelInvocationTimeExceeded
\n
\n

The model failed to finish sending the response within the timeout period allowed by Amazon SageMaker AI.

\n
\n
StreamBroken
\n
\n

The Transmission Control Protocol (TCP) connection between the client and\n the model was reset or closed.

\n
\n
", "smithy.api#error": "client" } }, @@ -1798,7 +1754,7 @@ "ModelStreamError": { "target": "com.amazonaws.sagemakerruntime#ModelStreamError", "traits": { - "smithy.api#documentation": "

An error occurred while streaming the response body. This error can have the\n following error codes:

\n
\n
ModelInvocationTimeExceeded
\n
\n

The model failed to finish sending the response within the timeout period allowed by Amazon SageMaker.

\n
\n
StreamBroken
\n
\n

The Transmission Control Protocol (TCP) connection between the client and\n the model was reset or closed.

\n
\n
" + "smithy.api#documentation": "

An error occurred while streaming the response body. This error can have the\n following error codes:

\n
\n
ModelInvocationTimeExceeded
\n
\n

The model failed to finish sending the response within the timeout period allowed by Amazon SageMaker AI.

\n
\n
StreamBroken
\n
\n

The Transmission Control Protocol (TCP) connection between the client and\n the model was reset or closed.

\n
\n
" } }, "InternalStreamFailure": { diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index 87aef299171..01525c8c9c4 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -1,6 +1,15 @@ { "smithy": "2.0", "shapes": { + "com.amazonaws.sagemaker#AcceleratorsAmount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 10000000 + } + } + }, "com.amazonaws.sagemaker#Accept": { "type": "string", "traits": { @@ -1646,6 +1655,12 @@ "smithy.api#enumValue": "ml.p5en.48xlarge" } }, + "ML_P6_B200_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p6-b200.48xlarge" + } + }, "ML_M6I_LARGE": { "target": "smithy.api#Unit", "traits": { @@ -3030,7 +3045,7 @@ } ], "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.

" + "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": { @@ -4867,6 +4882,14 @@ } } }, + "com.amazonaws.sagemaker#AvailableSpareInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.sagemaker#AwsManagedHumanLoopRequestSource": { "type": "enum", "members": { @@ -7621,6 +7644,119 @@ "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$" } }, + "com.amazonaws.sagemaker#ClusterAutoScalerType": { + "type": "enum", + "members": { + "KARPENTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Karpenter" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterAutoScalingConfig": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.sagemaker#ClusterAutoScalingMode", + "traits": { + "smithy.api#documentation": "

Describes whether autoscaling is enabled or disabled for the cluster. Valid values are Enable and Disable.

", + "smithy.api#required": {} + } + }, + "AutoScalerType": { + "target": "com.amazonaws.sagemaker#ClusterAutoScalerType", + "traits": { + "smithy.api#documentation": "

The type of autoscaler to use. Currently supported value is Karpenter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the autoscaling configuration for a HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterAutoScalingConfigOutput": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.sagemaker#ClusterAutoScalingMode", + "traits": { + "smithy.api#documentation": "

Describes whether autoscaling is enabled or disabled for the cluster.

", + "smithy.api#required": {} + } + }, + "AutoScalerType": { + "target": "com.amazonaws.sagemaker#ClusterAutoScalerType", + "traits": { + "smithy.api#documentation": "

The type of autoscaler configured for the cluster.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ClusterAutoScalingStatus", + "traits": { + "smithy.api#documentation": "

The current status of the autoscaling configuration. Valid values are InService, Failed, Creating, and Deleting.

", + "smithy.api#required": {} + } + }, + "FailureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

If the autoscaling status is Failed, this field contains a message describing the failure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The autoscaling configuration and status information for a HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterAutoScalingMode": { + "type": "enum", + "members": { + "ENABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enable" + } + }, + "DISABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disable" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterAutoScalingStatus": { + "type": "enum", + "members": { + "INSERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, "com.amazonaws.sagemaker#ClusterAvailabilityZone": { "type": "string", "traits": { @@ -7633,6 +7769,23 @@ "smithy.api#pattern": "^[a-z]{3}\\d-az\\d$" } }, + "com.amazonaws.sagemaker#ClusterConfigMode": { + "type": "enum", + "members": { + "ENABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enable" + } + }, + "DISABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disable" + } + } + } + }, "com.amazonaws.sagemaker#ClusterEbsVolumeConfig": { "type": "structure", "members": { @@ -7642,6 +7795,20 @@ "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.

" } + }, + "VolumeKmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of a KMS key to encrypt the Amazon EBS volume.

" + } + }, + "RootVolume": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume. You can specify two ClusterEbsVolumeConfig fields to configure both the root and secondary volumes. Set the value to True if you'd like to provide your own customer managed Amazon Web Services KMS key to encrypt the root volume. When True:

  • The configuration is applied to the root volume.

  • You can't specify the VolumeSizeInGB field. The size of the root volume is determined for you.

  • You must specify a KMS key ID for VolumeKmsKeyId to encrypt the root volume with your own KMS key instead of an Amazon Web Services owned KMS key.

Otherwise, by default, the value is False, and the following applies:

  • The configuration is applied to the secondary volume, while the root volume is encrypted with an Amazon Web Services owned key.

  • You must specify the VolumeSizeInGB field.

  • You can optionally specify the VolumeKmsKeyId to encrypt the secondary volume with your own KMS key instead of an Amazon Web Services owned KMS key.

" + } } }, "traits": { @@ -7672,7 +7839,7 @@ "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#documentation": "

The Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.

", "smithy.api#required": {} } }, @@ -7680,7 +7847,7 @@ "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#documentation": "

The name of the HyperPod cluster associated with the event.

", "smithy.api#required": {} } }, @@ -7700,7 +7867,7 @@ "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#documentation": "

The type of resource associated with the event. Valid values are Cluster, InstanceGroup, or Instance.

", "smithy.api#required": {} } }, @@ -7788,7 +7955,7 @@ "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#documentation": "

The Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.

", "smithy.api#required": {} } }, @@ -7796,7 +7963,7 @@ "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#documentation": "

The name of the HyperPod cluster associated with the event.

", "smithy.api#required": {} } }, @@ -7809,14 +7976,14 @@ "InstanceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The EC2 instance ID associated with the event, if applicable.

" + "smithy.api#documentation": "

The Amazon Elastic Compute Cloud (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#documentation": "

The type of resource associated with the event. Valid values are Cluster, InstanceGroup, or Instance.

", "smithy.api#required": {} } }, @@ -7836,7 +8003,7 @@ } }, "traits": { - "smithy.api#documentation": "

A summary of an event in a SageMaker HyperPod cluster.

" + "smithy.api#documentation": "

A summary of an event in a HyperPod cluster.

" } }, "com.amazonaws.sagemaker#ClusterInstanceCount": { @@ -8050,7 +8217,7 @@ "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.

" + "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

If 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. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.

" } } }, @@ -8082,6 +8249,15 @@ } } }, + "com.amazonaws.sagemaker#ClusterInstanceMemoryAllocationPercentage": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.sagemaker#ClusterInstancePlacement": { "type": "structure", "members": { @@ -8218,6 +8394,12 @@ "smithy.api#enumValue": "ml.p5.48xlarge" } }, + "ML_P6E_GB200_36XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p6e-gb200.36xlarge" + } + }, "ML_TRN1_32XLARGE": { "target": "smithy.api#Unit", "traits": { @@ -8920,18 +9102,18 @@ "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.

" + "smithy.api#documentation": "

A list of Amazon EKS IAM role ARNs associated with the cluster. This is created by 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.

" + "smithy.api#documentation": "

The Service-Linked Role (SLR) associated with the cluster. This is created by 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.

" + "smithy.api#documentation": "

Metadata information about a HyperPod cluster showing information about the cluster level operations, such as creating, updating, and deleting.

" } }, "com.amazonaws.sagemaker#ClusterName": { @@ -9058,6 +9240,13 @@ "traits": { "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) desired for the node.

" } + }, + "UltraServerInfo": { + "target": "com.amazonaws.sagemaker#UltraServerInfo", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Contains information about the UltraServer.

" + } } }, "traits": { @@ -9197,6 +9386,13 @@ "smithy.api#documentation": "

The status of the instance.

", "smithy.api#required": {} } + }, + "UltraServerInfo": { + "target": "com.amazonaws.sagemaker#UltraServerInfo", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Contains information about the UltraServer.

" + } } }, "traits": { @@ -9669,6 +9865,28 @@ } } }, + "com.amazonaws.sagemaker#ClusterTieredStorageConfig": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.sagemaker#ClusterConfigMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies whether managed tier checkpointing is enabled or disabled for the HyperPod cluster. When set to Enable, the system installs a memory management daemon that provides disaggregated memory as a service for checkpoint storage. When set to Disable, the feature is turned off and the memory management daemon is removed from the cluster.

", + "smithy.api#required": {} + } + }, + "InstanceMemoryAllocationPercentage": { + "target": "com.amazonaws.sagemaker#ClusterInstanceMemoryAllocationPercentage", + "traits": { + "smithy.api#documentation": "

The percentage (int) of cluster memory to allocate for checkpointing.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the configuration for managed tier checkpointing in a HyperPod cluster. Managed tier checkpointing uses multiple storage tiers, including cluster CPU memory, to provide faster checkpoint operations and improved fault tolerance for large-scale model training. The system automatically saves checkpoints at high frequency to memory and periodically persists them to durable storage, like Amazon S3.

" + } + }, "com.amazonaws.sagemaker#CodeEditorAppImageConfig": { "type": "structure", "members": { @@ -10295,6 +10513,24 @@ "traits": { "smithy.api#documentation": "

The number of instances to add to the instance group of a SageMaker HyperPod cluster.

" } + }, + "Accelerators": { + "target": "com.amazonaws.sagemaker#AcceleratorsAmount", + "traits": { + "smithy.api#documentation": "

The number of accelerators to allocate. If you don't specify a value for vCPU and MemoryInGiB, SageMaker AI automatically allocates ratio-based values for those parameters based on the number of accelerators you provide. For example, if you allocate 16 out of 32 total accelerators, SageMaker AI uses the ratio of 0.5 and allocates values to vCPU and MemoryInGiB.

" + } + }, + "VCpu": { + "target": "com.amazonaws.sagemaker#VCpuAmount", + "traits": { + "smithy.api#documentation": "

The number of vCPU to allocate. If you specify a value only for vCPU, SageMaker AI automatically allocates ratio-based values for MemoryInGiB based on this vCPU parameter. For example, if you allocate 20 out of 40 total vCPU, SageMaker AI uses the ratio of 0.5 and allocates values to MemoryInGiB. Accelerators are set to 0.

" + } + }, + "MemoryInGiB": { + "target": "com.amazonaws.sagemaker#MemoryInGiBAmount", + "traits": { + "smithy.api#documentation": "

The amount of memory in GiB to allocate. If you specify a value only for this parameter, SageMaker AI automatically allocates a ratio-based value for vCPU based on this memory that you provide. For example, if you allocate 200 out of 400 total memory in GiB, SageMaker AI uses the ratio of 0.5 and allocates values to vCPU. Accelerators are set to 0.

" + } } }, "traits": { @@ -10490,6 +10726,14 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.sagemaker#ConfiguredSpareInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.sagemaker#ConflictException": { "type": "structure", "members": { @@ -11671,7 +11915,7 @@ "Orchestrator": { "target": "com.amazonaws.sagemaker#ClusterOrchestrator", "traits": { - "smithy.api#documentation": "

The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported value is \"eks\", which is to use an Amazon Elastic Kubernetes Service (EKS) cluster as the orchestrator.

" + "smithy.api#documentation": "

The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported value is \"eks\", which is to use an Amazon Elastic Kubernetes Service cluster as the orchestrator.

" } }, "NodeRecovery": { @@ -11680,11 +11924,29 @@ "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.

" } }, + "TieredStorageConfig": { + "target": "com.amazonaws.sagemaker#ClusterTieredStorageConfig", + "traits": { + "smithy.api#documentation": "

The configuration for managed tier checkpointing on the HyperPod cluster. When enabled, this feature uses a multi-tier storage approach for storing model checkpoints, providing faster checkpoint operations and improved fault tolerance across cluster nodes.

" + } + }, "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.

" } + }, + "ClusterRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes to perform cluster autoscaling operations. This role must have permissions for sagemaker:BatchAddClusterNodes and sagemaker:BatchDeleteClusterNodes. This is only required when autoscaling is enabled and when HyperPod is performing autoscaling operations.

" + } + }, + "AutoScaling": { + "target": "com.amazonaws.sagemaker#ClusterAutoScalingConfig", + "traits": { + "smithy.api#documentation": "

The autoscaling configuration for the cluster. Enables automatic scaling of cluster nodes based on workload demand using a Karpenter-based system.

" + } } }, "traits": { @@ -14056,7 +14318,7 @@ "target": "com.amazonaws.sagemaker#LabelAttributeName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The LabelAttributeName must meet the following requirements.

  • The name can't end with \"-metadata\".

  • If you are using one of the following built-in task types, the attribute name must end with \"-ref\". If the task type you are using is not listed below, the attribute name must not end with \"-ref\".

    • Image semantic segmentation (SemanticSegmentation), and adjustment (AdjustmentSemanticSegmentation) and verification (VerificationSemanticSegmentation) labeling jobs for this task type.

    • Video frame object detection (VideoObjectDetection), and adjustment and verification (AdjustmentVideoObjectDetection) labeling jobs for this task type.

    • Video frame object tracking (VideoObjectTracking), and adjustment and verification (AdjustmentVideoObjectTracking) labeling jobs for this task type.

    • 3D point cloud semantic segmentation (3DPointCloudSemanticSegmentation), and adjustment and verification (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this task type.

    • 3D point cloud object tracking (3DPointCloudObjectTracking), and adjustment and verification (Adjustment3DPointCloudObjectTracking) labeling jobs for this task type.

If you are creating an adjustment or verification labeling job, you must use a different LabelAttributeName than the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see Verify and Adjust Labels.

", + "smithy.api#documentation": "

The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The LabelAttributeName must meet the following requirements.

  • The name can't end with \"-metadata\".

  • If you are using one of the built-in task types or one of the following, the attribute name must end with \"-ref\".

    • Image semantic segmentation (SemanticSegmentation) and adjustment (AdjustmentSemanticSegmentation) labeling jobs for this task type. One exception is that verification (VerificationSemanticSegmentation) must not end with -\"ref\".

    • Video frame object detection (VideoObjectDetection), and adjustment and verification (AdjustmentVideoObjectDetection) labeling jobs for this task type.

    • Video frame object tracking (VideoObjectTracking), and adjustment and verification (AdjustmentVideoObjectTracking) labeling jobs for this task type.

    • 3D point cloud semantic segmentation (3DPointCloudSemanticSegmentation), and adjustment and verification (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this task type.

    • 3D point cloud object tracking (3DPointCloudObjectTracking), and adjustment and verification (Adjustment3DPointCloudObjectTracking) labeling jobs for this task type.

If you are creating an adjustment or verification labeling job, you must use a different LabelAttributeName than the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see Verify and Adjust Labels.

", "smithy.api#required": {} } }, @@ -15166,6 +15428,12 @@ "smithy.api#documentation": "

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

" } }, + "IpAddressType": { + "target": "com.amazonaws.sagemaker#IPAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4.

" + } + }, "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { @@ -16532,6 +16800,12 @@ "smithy.api#required": {} } }, + "SpareInstanceCountPerUltraServer": { + "target": "com.amazonaws.sagemaker#SpareInstanceCountPerUltraServer", + "traits": { + "smithy.api#documentation": "

Number of spare instances to reserve per UltraServer for enhanced resiliency. Default is 1.

" + } + }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { @@ -20902,6 +21176,12 @@ "smithy.api#documentation": "

The status.

" } }, + "EffectiveTrustedIdentityPropagationStatus": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "

The effective status of Trusted Identity Propagation (TIP) for this application. When enabled, user identities from IAM Identity Center are being propagated through the application to TIP enabled Amazon Web Services services. When disabled, standard IAM role-based access is used.

" + } + }, "RecoveryMode": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { @@ -21637,6 +21917,12 @@ "smithy.api#documentation": "

The type of orchestrator used for the SageMaker HyperPod cluster.

" } }, + "TieredStorageConfig": { + "target": "com.amazonaws.sagemaker#ClusterTieredStorageConfig", + "traits": { + "smithy.api#documentation": "

The current configuration for managed tier checkpointing on the HyperPod cluster. For example, this shows whether the feature is enabled and the percentage of cluster memory allocated for checkpoint storage.

" + } + }, "NodeRecovery": { "target": "com.amazonaws.sagemaker#ClusterNodeRecovery", "traits": { @@ -21648,6 +21934,18 @@ "traits": { "smithy.api#documentation": "

The mode used for provisioning nodes in the cluster.

" } + }, + "ClusterRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that HyperPod uses for cluster autoscaling operations.

" + } + }, + "AutoScaling": { + "target": "com.amazonaws.sagemaker#ClusterAutoScalingConfigOutput", + "traits": { + "smithy.api#documentation": "

The current autoscaling configuration and status for the autoscaler.

" + } } }, "traits": { @@ -26925,6 +27223,12 @@ "smithy.api#documentation": "

The type of ML compute instance running on the notebook instance.

" } }, + "IpAddressType": { + "target": "com.amazonaws.sagemaker#IPAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type configured for the notebook instance. Returns ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity.

" + } + }, "SubnetId": { "target": "com.amazonaws.sagemaker#SubnetId", "traits": { @@ -27247,7 +27551,7 @@ "Status": { "target": "com.amazonaws.sagemaker#PartnerAppStatus", "traits": { - "smithy.api#documentation": "

The status of the SageMaker Partner AI App.

" + "smithy.api#documentation": "

The status of the SageMaker Partner AI App.

  • Creating: SageMaker AI is creating the partner AI app. The partner AI app is not available during creation.

  • Updating: SageMaker AI is updating the partner AI app. The partner AI app is not available when updating.

  • Deleting: SageMaker AI is deleting the partner AI app. The partner AI app is not available during deletion.

  • Available: The partner AI app is provisioned and accessible.

  • Failed: The partner AI app is in a failed state and isn't available. SageMaker AI is investigating the issue. For further guidance, contact Amazon Web Services Support.

  • UpdateFailed: The partner AI app couldn't be updated but is available.

  • Deleted: The partner AI app is permanently deleted and not available.

" } }, "CreationTime": { @@ -27965,6 +28269,131 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#DescribeReservedCapacity": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeReservedCapacityRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeReservedCapacityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves details about a reserved capacity.

" + } + }, + "com.amazonaws.sagemaker#DescribeReservedCapacityRequest": { + "type": "structure", + "members": { + "ReservedCapacityArn": { + "target": "com.amazonaws.sagemaker#ReservedCapacityArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ARN of the reserved capacity to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeReservedCapacityResponse": { + "type": "structure", + "members": { + "ReservedCapacityArn": { + "target": "com.amazonaws.sagemaker#ReservedCapacityArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

ARN of the reserved capacity.

", + "smithy.api#required": {} + } + }, + "ReservedCapacityType": { + "target": "com.amazonaws.sagemaker#ReservedCapacityType", + "traits": { + "smithy.api#documentation": "

The type of reserved capacity.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ReservedCapacityStatus", + "traits": { + "smithy.api#documentation": "

The current status of the reserved capacity.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.sagemaker#AvailabilityZone", + "traits": { + "smithy.api#documentation": "

The Availability Zone where the reserved capacity is provisioned.

" + } + }, + "DurationHours": { + "target": "com.amazonaws.sagemaker#ReservedCapacityDurationHours", + "traits": { + "smithy.api#documentation": "

The total duration of the reserved capacity in hours.

" + } + }, + "DurationMinutes": { + "target": "com.amazonaws.sagemaker#ReservedCapacityDurationMinutes", + "traits": { + "smithy.api#documentation": "

The number of minutes for the duration of the reserved capacity. For example, if a reserved capacity starts at 08:55 and ends at 11:30, the minutes field would be 35.

" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the reserved capacity becomes active.

" + } + }, + "EndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the reserved capacity expires.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon EC2 instance type used in the reserved capacity.

", + "smithy.api#required": {} + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.sagemaker#TotalInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The total number of instances allocated to this reserved capacity.

", + "smithy.api#required": {} + } + }, + "AvailableInstanceCount": { + "target": "com.amazonaws.sagemaker#AvailableInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances currently available for use in this reserved capacity.

" + } + }, + "InUseInstanceCount": { + "target": "com.amazonaws.sagemaker#InUseInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances currently in use from this reserved capacity.

" + } + }, + "UltraServerSummary": { + "target": "com.amazonaws.sagemaker#UltraServerSummary", + "traits": { + "smithy.api#documentation": "

A summary of the UltraServer associated with this reserved capacity.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DescribeSpace": { "type": "operation", "input": { @@ -28682,6 +29111,24 @@ "smithy.api#documentation": "

The number of instances currently in use from this training plan.

" } }, + "UnhealthyInstanceCount": { + "target": "com.amazonaws.sagemaker#UnhealthyInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances in the training plan that are currently in an unhealthy state.

" + } + }, + "AvailableSpareInstanceCount": { + "target": "com.amazonaws.sagemaker#AvailableSpareInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of available spare instances in the training plan.

" + } + }, + "TotalUltraServerCount": { + "target": "com.amazonaws.sagemaker#UltraServerCount", + "traits": { + "smithy.api#documentation": "

The total number of UltraServers reserved to this training plan.

" + } + }, "TargetResources": { "target": "com.amazonaws.sagemaker#SageMakerResourceNames", "traits": { @@ -29449,7 +29896,7 @@ } ], "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.

" + "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": { @@ -30199,6 +30646,12 @@ "traits": { "smithy.api#documentation": "

The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.

" } + }, + "RootlessDocker": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether to use rootless Docker.

" + } } }, "traits": { @@ -30343,6 +30796,12 @@ "smithy.api#documentation": "

The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key.

" } }, + "TrustedIdentityPropagationSettings": { + "target": "com.amazonaws.sagemaker#TrustedIdentityPropagationSettings", + "traits": { + "smithy.api#documentation": "

The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.

" + } + }, "DockerSettings": { "target": "com.amazonaws.sagemaker#DockerSettings", "traits": { @@ -30360,6 +30819,12 @@ "traits": { "smithy.api#documentation": "

The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

" } + }, + "IpAddressType": { + "target": "com.amazonaws.sagemaker#IPAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4.

" + } } }, "traits": { @@ -30387,6 +30852,12 @@ "smithy.api#documentation": "

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

" } }, + "TrustedIdentityPropagationSettings": { + "target": "com.amazonaws.sagemaker#TrustedIdentityPropagationSettings", + "traits": { + "smithy.api#documentation": "

The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.

" + } + }, "DockerSettings": { "target": "com.amazonaws.sagemaker#DockerSettings", "traits": { @@ -30404,6 +30875,12 @@ "traits": { "smithy.api#documentation": "

The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

" } + }, + "IpAddressType": { + "target": "com.amazonaws.sagemaker#IPAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks.

" + } } }, "traits": { @@ -36565,6 +37042,23 @@ } } }, + "com.amazonaws.sagemaker#IPAddressType": { + "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#IamIdentity": { "type": "structure", "members": { @@ -38616,7 +39110,7 @@ } }, "traits": { - "smithy.api#documentation": "

Metadata information about an instance group in a SageMaker HyperPod cluster.

" + "smithy.api#documentation": "

Metadata information about an instance group in a HyperPod cluster.

" } }, "com.amazonaws.sagemaker#InstanceGroupName": { @@ -38795,6 +39289,26 @@ "smithy.api#documentation": "

Information on the IMDS configuration of the notebook instance

" } }, + "com.amazonaws.sagemaker#InstancePlacementConfig": { + "type": "structure", + "members": { + "EnableMultipleJobs": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

If set to true, allows multiple jobs to share the same UltraServer instances. If set to false, ensures this job's instances are placed on an UltraServer exclusively, with no other jobs sharing the same UltraServer. Default is false.

" + } + }, + "PlacementSpecifications": { + "target": "com.amazonaws.sagemaker#PlacementSpecifications", + "traits": { + "smithy.api#documentation": "

A list of specifications for how instances should be placed on specific UltraServers. Maximum of 10 items is supported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for how instances are placed and allocated within UltraServers. This is only applicable for UltraServer capacity.

" + } + }, "com.amazonaws.sagemaker#InstanceType": { "type": "enum", "members": { @@ -39296,6 +39810,12 @@ "smithy.api#enumValue": "ml.p5.48xlarge" } }, + "ML_P6_B200_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p6-b200.48xlarge" + } + }, "ML_M6I_LARGE": { "target": "smithy.api#Unit", "traits": { @@ -48998,6 +49518,79 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#ListUltraServersByReservedCapacity": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListUltraServersByReservedCapacityRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListUltraServersByReservedCapacityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all UltraServers that are part of a specified reserved capacity.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "UltraServers", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListUltraServersByReservedCapacityRequest": { + "type": "structure", + "members": { + "ReservedCapacityArn": { + "target": "com.amazonaws.sagemaker#ReservedCapacityArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the reserved capacity to list UltraServers for.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of UltraServers to return in the response. The default value is 10.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListUltraServersByReservedCapacityResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. Use it in the next request to retrieve the next set of UltraServers.

" + } + }, + "UltraServers": { + "target": "com.amazonaws.sagemaker#UltraServers", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of UltraServers that are part of the specified reserved capacity.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#ListUserProfiles": { "type": "operation", "input": { @@ -49555,6 +50148,15 @@ } } }, + "com.amazonaws.sagemaker#MemoryInGiBAmount": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 10000000 + } + } + }, "com.amazonaws.sagemaker#MemoryInMb": { "type": "integer", "traits": { @@ -57304,14 +57906,48 @@ } } }, + "com.amazonaws.sagemaker#PlacementSpecification": { + "type": "structure", + "members": { + "UltraServerId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The unique identifier of the UltraServer where instances should be placed.

" + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TrainingInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of ML compute instances required to be placed together on the same UltraServer. Minimum value of 1.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies how instances should be placed on a specific UltraServer.

" + } + }, + "com.amazonaws.sagemaker#PlacementSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#PlacementSpecification" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.sagemaker#PlatformIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 0, - "max": 15 + "max": 20 }, - "smithy.api#pattern": "^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2|notebook-al2-v3)$" + "smithy.api#pattern": "^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2|notebook-al2-v3|notebook-al2023-v1)$" } }, "com.amazonaws.sagemaker#PolicyString": { @@ -58315,6 +58951,12 @@ "traits": { "smithy.api#enumValue": "ml.r7i.48xlarge" } + }, + "ML_P5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.4xlarge" + } } } }, @@ -58447,7 +59089,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:processing-job/" + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:processing-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" } }, "com.amazonaws.sagemaker#ProcessingJobName": { @@ -60754,6 +61396,12 @@ "traits": { "smithy.api#enumValue": "ml.p6e-gb200.36xlarge" } + }, + "ML_P5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.4xlarge" + } } } }, @@ -63385,12 +64033,42 @@ "traits": { "smithy.api#enumValue": "ml.p4de.24xlarge" } + }, + "ML_P6E_GB200_36XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p6e-gb200.36xlarge" + } + }, + "ML_P5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.4xlarge" + } } } }, "com.amazonaws.sagemaker#ReservedCapacityOffering": { "type": "structure", "members": { + "ReservedCapacityType": { + "target": "com.amazonaws.sagemaker#ReservedCapacityType", + "traits": { + "smithy.api#documentation": "

The type of reserved capacity offering.

" + } + }, + "UltraServerType": { + "target": "com.amazonaws.sagemaker#UltraServerType", + "traits": { + "smithy.api#documentation": "

The type of UltraServer included in this reserved capacity offering, such as ml.u-p6e-gb200x72.

" + } + }, + "UltraServerCount": { + "target": "com.amazonaws.sagemaker#UltraServerCount", + "traits": { + "smithy.api#documentation": "

The number of UltraServers included in this reserved capacity offering.

" + } + }, "InstanceType": { "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceType", "traits": { @@ -63512,6 +64190,24 @@ "smithy.api#required": {} } }, + "ReservedCapacityType": { + "target": "com.amazonaws.sagemaker#ReservedCapacityType", + "traits": { + "smithy.api#documentation": "

The type of reserved capacity.

" + } + }, + "UltraServerType": { + "target": "com.amazonaws.sagemaker#UltraServerType", + "traits": { + "smithy.api#documentation": "

The type of UltraServer included in this reserved capacity, such as ml.u-p6e-gb200x72.

" + } + }, + "UltraServerCount": { + "target": "com.amazonaws.sagemaker#UltraServerCount", + "traits": { + "smithy.api#documentation": "

The number of UltraServers included in this reserved capacity.

" + } + }, "InstanceType": { "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceType", "traits": { @@ -63571,6 +64267,23 @@ "smithy.api#documentation": "

Details of a reserved capacity for the training plan.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

" } }, + "com.amazonaws.sagemaker#ReservedCapacityType": { + "type": "enum", + "members": { + "ULTRASERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UltraServer" + } + }, + "INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance" + } + } + } + }, "com.amazonaws.sagemaker#ResolvedAttributes": { "type": "structure", "members": { @@ -63749,6 +64462,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN); of the training plan to use for this resource configuration.

" } + }, + "InstancePlacementConfig": { + "target": "com.amazonaws.sagemaker#InstancePlacementConfig", + "traits": { + "smithy.api#documentation": "

Configuration for how training job instances are placed and allocated within UltraServers. Only applicable for UltraServer capacity.

" + } } }, "traits": { @@ -64481,7 +65200,9 @@ "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>/.

" + "smithy.api#clientOptional": {}, + "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>/.

", + "smithy.api#required": {} } } }, @@ -64501,7 +65222,9 @@ "S3Uri": { "target": "com.amazonaws.sagemaker#S3SchemaUri", "traits": { - "smithy.api#documentation": "

The Amazon S3 URI of the S3 file system configuration.

" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon S3 URI of the S3 file system configuration.

", + "smithy.api#required": {} } } }, @@ -65231,6 +65954,9 @@ { "target": "com.amazonaws.sagemaker#DescribeProject" }, + { + "target": "com.amazonaws.sagemaker#DescribeReservedCapacity" + }, { "target": "com.amazonaws.sagemaker#DescribeSpace" }, @@ -65537,6 +66263,9 @@ { "target": "com.amazonaws.sagemaker#ListTrials" }, + { + "target": "com.amazonaws.sagemaker#ListUltraServersByReservedCapacity" + }, { "target": "com.amazonaws.sagemaker#ListUserProfiles" }, @@ -66665,17 +67394,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -66689,28 +67407,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -66724,17 +67420,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -67450,6 +68135,18 @@ "smithy.api#documentation": "

The number of instances you want to reserve in the training plan offerings. This allows you to specify the quantity of compute resources needed for your SageMaker training jobs or SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your requirements.

" } }, + "UltraServerType": { + "target": "com.amazonaws.sagemaker#UltraServerType", + "traits": { + "smithy.api#documentation": "

The type of UltraServer to search for, such as ml.u-p6e-gb200x72.

" + } + }, + "UltraServerCount": { + "target": "com.amazonaws.sagemaker#UltraServerCount", + "traits": { + "smithy.api#documentation": "

The number of UltraServers to search for.

" + } + }, "StartTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { @@ -68952,6 +69649,14 @@ "smithy.api#documentation": "

The storage settings for a space.

" } }, + "com.amazonaws.sagemaker#SpareInstanceCountPerUltraServer": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.sagemaker#SpawnRate": { "type": "integer", "traits": { @@ -73041,6 +73746,18 @@ "traits": { "smithy.api#enumValue": "ml.r7i.48xlarge" } + }, + "ML_P6E_GB200_36XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p6e-gb200.36xlarge" + } + }, + "ML_P5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.4xlarge" + } } } }, @@ -73278,7 +73995,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/" + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" } }, "com.amazonaws.sagemaker#TrainingJobDefinition": { @@ -73925,6 +74642,12 @@ "smithy.api#documentation": "

The number of instances currently in use from this training plan.

" } }, + "TotalUltraServerCount": { + "target": "com.amazonaws.sagemaker#UltraServerCount", + "traits": { + "smithy.api#documentation": "

The total number of UltraServers allocated to this training plan.

" + } + }, "TargetResources": { "target": "com.amazonaws.sagemaker#SageMakerResourceNames", "traits": { @@ -75916,6 +76639,22 @@ "smithy.api#documentation": "

A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.

" } }, + "com.amazonaws.sagemaker#TrustedIdentityPropagationSettings": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The status of Trusted Identity Propagation (TIP) at the SageMaker domain level.

When disabled, standard IAM role-based access is used.

When enabled:

  • User identities from IAM Identity Center are propagated through the application to TIP enabled Amazon Web Services services.

  • New applications or existing applications that are automatically patched, will use the domain level configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.

" + } + }, "com.amazonaws.sagemaker#TtlDuration": { "type": "structure", "members": { @@ -76110,6 +76849,207 @@ } } }, + "com.amazonaws.sagemaker#UltraServer": { + "type": "structure", + "members": { + "UltraServerId": { + "target": "com.amazonaws.sagemaker#NonEmptyString256", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier for the UltraServer.

", + "smithy.api#required": {} + } + }, + "UltraServerType": { + "target": "com.amazonaws.sagemaker#UltraServerType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of UltraServer, such as ml.u-p6e-gb200x72.

", + "smithy.api#required": {} + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.sagemaker#AvailabilityZone", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Availability Zone where the UltraServer is provisioned.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon EC2 instance type used in the UltraServer.

", + "smithy.api#required": {} + } + }, + "TotalInstanceCount": { + "target": "com.amazonaws.sagemaker#TotalInstanceCount", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The total number of instances in this UltraServer.

", + "smithy.api#required": {} + } + }, + "ConfiguredSpareInstanceCount": { + "target": "com.amazonaws.sagemaker#ConfiguredSpareInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of spare instances configured for this UltraServer to provide enhanced resiliency.

" + } + }, + "AvailableInstanceCount": { + "target": "com.amazonaws.sagemaker#AvailableInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances currently available for use in this UltraServer.

" + } + }, + "InUseInstanceCount": { + "target": "com.amazonaws.sagemaker#InUseInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances currently in use in this UltraServer.

" + } + }, + "AvailableSpareInstanceCount": { + "target": "com.amazonaws.sagemaker#AvailableSpareInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of available spare instances in the UltraServer.

" + } + }, + "UnhealthyInstanceCount": { + "target": "com.amazonaws.sagemaker#UnhealthyInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of instances in this UltraServer that are currently in an unhealthy state.

" + } + }, + "HealthStatus": { + "target": "com.amazonaws.sagemaker#UltraServerHealthStatus", + "traits": { + "smithy.api#documentation": "

The overall health status of the UltraServer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a high-performance compute server used for distributed training in SageMaker AI. An UltraServer consists of multiple instances within a shared NVLink interconnect domain.

" + } + }, + "com.amazonaws.sagemaker#UltraServerCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#UltraServerHealthStatus": { + "type": "enum", + "members": { + "OK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OK" + } + }, + "IMPAIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Impaired" + } + }, + "INSUFFICIENT_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Insufficient-Data" + } + } + } + }, + "com.amazonaws.sagemaker#UltraServerInfo": { + "type": "structure", + "members": { + "Id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the UltraServer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the UltraServer object.

" + } + }, + "com.amazonaws.sagemaker#UltraServerSummary": { + "type": "structure", + "members": { + "UltraServerType": { + "target": "com.amazonaws.sagemaker#UltraServerType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of UltraServer, such as ml.u-p6e-gb200x72.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ReservedCapacityInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon EC2 instance type used in the UltraServer.

", + "smithy.api#required": {} + } + }, + "UltraServerCount": { + "target": "com.amazonaws.sagemaker#UltraServerCount", + "traits": { + "smithy.api#documentation": "

The number of UltraServers of this type.

" + } + }, + "AvailableSpareInstanceCount": { + "target": "com.amazonaws.sagemaker#AvailableSpareInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of available spare instances in the UltraServers.

" + } + }, + "UnhealthyInstanceCount": { + "target": "com.amazonaws.sagemaker#UnhealthyInstanceCount", + "traits": { + "smithy.api#documentation": "

The total number of instances across all UltraServers of this type that are currently in an unhealthy state.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of UltraServer resources and their current status.

" + } + }, + "com.amazonaws.sagemaker#UltraServerType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^ml.[a-z0-9\\-.]+$" + } + }, + "com.amazonaws.sagemaker#UltraServers": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#UltraServer" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#UnhealthyInstanceCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.sagemaker#UnifiedStudioDomainId": { "type": "string", "traits": { @@ -76438,6 +77378,12 @@ "smithy.api#documentation": "

The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

" } }, + "TieredStorageConfig": { + "target": "com.amazonaws.sagemaker#ClusterTieredStorageConfig", + "traits": { + "smithy.api#documentation": "

Updates the configuration for managed tier checkpointing on the HyperPod cluster. For example, you can enable or disable the feature and modify the percentage of cluster memory allocated for checkpoint storage.

" + } + }, "NodeRecovery": { "target": "com.amazonaws.sagemaker#ClusterNodeRecovery", "traits": { @@ -76449,6 +77395,18 @@ "traits": { "smithy.api#documentation": "

Specify the names of the instance groups to delete. Use a single , as the separator between multiple names.

" } + }, + "ClusterRole": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes for cluster autoscaling operations. Cannot be updated while autoscaling is enabled.

" + } + }, + "AutoScaling": { + "target": "com.amazonaws.sagemaker#ClusterAutoScalingConfig", + "traits": { + "smithy.api#documentation": "

Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.

" + } } }, "traits": { @@ -76628,7 +77586,7 @@ "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.

" + "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

If 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. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.

" } } }, @@ -78474,6 +79432,12 @@ "smithy.api#documentation": "

The Amazon ML compute instance type.

" } }, + "IpAddressType": { + "target": "com.amazonaws.sagemaker#IPAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. The notebook instance must be stopped before updating this setting. When you specify dualstack, the subnet must support IPv6 addressing.

" + } + }, "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { @@ -79872,6 +80836,15 @@ } } }, + "com.amazonaws.sagemaker#VCpuAmount": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 10000000 + } + } + }, "com.amazonaws.sagemaker#ValidationFraction": { "type": "float", "traits": { diff --git a/codegen/sdk/aws-models/savingsplans.json b/codegen/sdk/aws-models/savingsplans.json index 502a8d55bf8..a13c420f917 100644 --- a/codegen/sdk/aws-models/savingsplans.json +++ b/codegen/sdk/aws-models/savingsplans.json @@ -632,17 +632,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -656,17 +645,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -680,17 +658,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -704,17 +671,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/scheduler.json b/codegen/sdk/aws-models/scheduler.json index 1e2b446b2d9..a6387bb798f 100644 --- a/codegen/sdk/aws-models/scheduler.json +++ b/codegen/sdk/aws-models/scheduler.json @@ -543,17 +543,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -567,17 +556,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -591,17 +569,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -615,17 +582,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/schemas.json b/codegen/sdk/aws-models/schemas.json index 3499a8542f1..15b03a89fc6 100644 --- a/codegen/sdk/aws-models/schemas.json +++ b/codegen/sdk/aws-models/schemas.json @@ -3580,6 +3580,9 @@ "name": "schemas" }, "aws.protocols#restJson1": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], "smithy.api#documentation": "

Amazon EventBridge Schema Registry

", "smithy.api#title": "Schemas", "smithy.rules#endpointRuleSet": { @@ -4262,17 +4265,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4286,17 +4278,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4310,17 +4291,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4334,17 +4304,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/secrets-manager.json b/codegen/sdk/aws-models/secrets-manager.json index 831a88fc178..0200050d117 100644 --- a/codegen/sdk/aws-models/secrets-manager.json +++ b/codegen/sdk/aws-models/secrets-manager.json @@ -4615,17 +4615,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4639,28 +4628,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4674,17 +4641,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/security-ir.json b/codegen/sdk/aws-models/security-ir.json index f31aa1eabef..1a379e2e009 100644 --- a/codegen/sdk/aws-models/security-ir.json +++ b/codegen/sdk/aws-models/security-ir.json @@ -29,6 +29,7 @@ "message": { "target": "smithy.api#String", "traits": { + "smithy.api#documentation": "

The ID of the resource which lead to the access denial.

", "smithy.api#required": {} } } @@ -70,6 +71,12 @@ "smithy.api#enumValue": "ap-east-1" } }, + "AP_EAST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-east-2" + } + }, "AP_NORTHEAST_1": { "target": "smithy.api#Unit", "traits": { @@ -268,7 +275,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 3, + "min": 2, "max": 50 }, "smithy.api#pattern": "^[a-zA-Z0-9 -.():]+$" @@ -287,7 +294,7 @@ "name": "BatchGetMemberAccountDetails", "documentation": "Grants permission to get member account details in batch" }, - "smithy.api#documentation": "

Grants permission to view an existing membership.

", + "smithy.api#documentation": "

Provides information on whether the supplied account IDs are associated with a membership.

AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.

", "smithy.api#examples": [ { "title": "Invoke BatchGetMemberAccountDetails", @@ -336,7 +343,7 @@ "accountIds": { "target": "com.amazonaws.securityir#AWSAccountIds", "traits": { - "smithy.api#documentation": "

Optional element to query the membership relationship status to a provided list of account IDs.

", + "smithy.api#documentation": "

Optional element to query the membership relationship status to a provided list of account IDs.

AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_BatchGetMemberAccountDetails.html#securityir-BatchGetMemberAccountDetails-request-accountIds" }, @@ -368,7 +375,7 @@ "errors": { "target": "com.amazonaws.securityir#GetMembershipAccountDetailErrors", "traits": { - "smithy.api#documentation": "

The response element providing errors messages for requests to GetMembershipAccountDetails.

", + "smithy.api#documentation": "

The response element providing error messages for requests to GetMembershipAccountDetails.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_BatchGetMemberAccountDetails.html#securityir-BatchGetMemberAccountDetails-response-errors" }, @@ -396,7 +403,7 @@ "name": "CancelMembership", "documentation": "Grants permission to cancel a membership" }, - "smithy.api#documentation": "

Grants permissions to cancel an existing membership.

", + "smithy.api#documentation": "

Cancels an existing membership.

", "smithy.api#examples": [ { "title": "Invoke CancelMembership", @@ -791,7 +798,7 @@ "name": "CloseCase", "documentation": "Grants permission to close a case" }, - "smithy.api#documentation": "

Grants permission to close an existing case.

", + "smithy.api#documentation": "

Closes an existing case.

", "smithy.api#examples": [ { "title": "Invoke CloseCase", @@ -839,7 +846,7 @@ "caseStatus": { "target": "com.amazonaws.securityir#CaseStatus", "traits": { - "smithy.api#documentation": "

A response element providing responses for requests to CloseCase. This element responds with the case status following the action.

", + "smithy.api#documentation": "

A response element providing responses for requests to CloseCase. This element responds Closed if successful.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CloseCase.html#securityir-CloseCase-response-caseStatus" } @@ -848,7 +855,7 @@ "closedDate": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

A response element providing responses for requests to CloseCase. This element responds with the case closure date following the action.

", + "smithy.api#documentation": "

A response element providing responses for requests to CloseCase. This element responds with the ISO-8601 formatted timestamp of the moment when the case was closed.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CloseCase.html#securityir-CloseCase-response-closedDate" } @@ -914,20 +921,21 @@ "message": { "target": "smithy.api#String", "traits": { + "smithy.api#documentation": "

The exception message.

", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Element providing the ID of the resource affected.", + "smithy.api#documentation": "

The ID of the conflicting resource.

", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Element providing the type of the resource affected.", + "smithy.api#documentation": "

The type of the conflicting resource.

", "smithy.api#required": {} } } @@ -964,7 +972,7 @@ "name": "CreateCase", "documentation": "Grants permission to create a case" }, - "smithy.api#documentation": "

Grants permission to create a new case.

", + "smithy.api#documentation": "

Creates a new case.

", "smithy.api#examples": [ { "title": "Invoke CreateCase", @@ -1032,7 +1040,7 @@ "name": "CreateCaseComment", "documentation": "Grants permission to create a case comment" }, - "smithy.api#documentation": "

Grants permission to add a comment to an existing case.

", + "smithy.api#documentation": "

Adds a comment to an existing case.

", "smithy.api#examples": [ { "title": "Invoke CreateCaseComment", @@ -1074,7 +1082,7 @@ "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

An optional element used in combination with CreateCaseComment.

", + "smithy.api#documentation": "

The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCaseComment.html#securityir-CreateCaseComment-request-clientToken" }, @@ -1125,7 +1133,7 @@ "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Required element used in combination with CreateCase.

", + "smithy.api#documentation": "

The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-request-clientToken" }, @@ -1139,7 +1147,7 @@ "resolverType": { "target": "com.amazonaws.securityir#ResolverType", "traits": { - "smithy.api#documentation": "

Required element used in combination with CreateCase to identify the resolver type. Available resolvers include self-supported | aws-supported.

", + "smithy.api#documentation": "

Required element used in combination with CreateCase to identify the resolver type.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-request-resolverType" }, @@ -1159,7 +1167,7 @@ "description": { "target": "com.amazonaws.securityir#CaseDescription", "traits": { - "smithy.api#documentation": "

Required element used in combination with CreateCase to provide a description for the new case.

", + "smithy.api#documentation": "

Required element used in combination with CreateCase

to provide a description for the new case.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-request-description" }, @@ -1189,7 +1197,7 @@ "impactedAccounts": { "target": "com.amazonaws.securityir#ImpactedAccounts", "traits": { - "smithy.api#documentation": "

Required element used in combination with CreateCase to provide a list of impacted accounts.

", + "smithy.api#documentation": "

Required element used in combination with CreateCase to provide a list of impacted accounts.

AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateCase.html#securityir-CreateCase-request-impactedAccounts" }, @@ -1296,7 +1304,7 @@ "organizations:DescribeOrganization" ] }, - "smithy.api#documentation": "

Grants permissions to create a new membership.

", + "smithy.api#documentation": "

Creates a new membership.

", "smithy.api#examples": [ { "title": "Invoke CreateMembership", @@ -1344,7 +1352,7 @@ "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

An optional element used in combination with CreateMembership.

", + "smithy.api#documentation": "

The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateMembership.html#securityir-CreateMembership-request-clientToken" }, @@ -1358,7 +1366,7 @@ "membershipName": { "target": "com.amazonaws.securityir#MembershipName", "traits": { - "smithy.api#documentation": "

Required element use in combination with CreateMembership to create a name for the membership.

", + "smithy.api#documentation": "

Required element used in combination with CreateMembership to create a name for the membership.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateMembership.html#securityir-CreateMembership-request-membershipName" }, @@ -1368,7 +1376,7 @@ "incidentResponseTeam": { "target": "com.amazonaws.securityir#IncidentResponseTeam", "traits": { - "smithy.api#documentation": "

Required element use in combination with CreateMembership to add customer incident response team members and trusted partners to the membership.

", + "smithy.api#documentation": "

Required element used in combination with CreateMembership to add customer incident response team members and trusted partners to the membership.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateMembership.html#securityir-CreateMembership-request-incidentResponseTeam" }, @@ -1392,6 +1400,16 @@ "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateMembership.html#securityir-CreateMembership-request-tags" } } + }, + "coverEntireOrganization": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": true, + "smithy.api#documentation": "

The coverEntireOrganization parameter is a boolean flag that determines whether the membership should be applied to the entire Amazon Web Services Organization. When set to true, the membership will be created for all accounts within the organization. When set to false, the membership will only be created for specified accounts.

This parameter is optional. If not specified, the default value is false.

  • If set to true: The membership will automatically include all existing and future accounts in the Amazon Web Services Organization.

  • If set to false: The membership will only apply to explicitly specified accounts.

", + "smithy.api#externalDocumentation": { + "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_CreateMembership.html#securityir-CreateMembership-request-coverEntireOrganization" + } + } } }, "traits": { @@ -1485,7 +1503,7 @@ "name": "GetCase", "documentation": "Grants permission to get a case" }, - "smithy.api#documentation": "

Grant permission to view a designated case.

", + "smithy.api#documentation": "

Returns the attributes of a case.

", "smithy.api#examples": [ { "title": "Invoke GetCase", @@ -1562,7 +1580,7 @@ "name": "GetCaseAttachmentDownloadUrl", "documentation": "Grants permission to get a case attachment download URL" }, - "smithy.api#documentation": "

Grants permission to obtain an Amazon S3 presigned URL to download an attachment.

", + "smithy.api#documentation": "

Returns a Pre-Signed URL for uploading attachments into a case.

", "smithy.api#examples": [ { "title": "Invoke GetCaseAttachmentDownloadUrl", @@ -1647,7 +1665,7 @@ "name": "GetCaseAttachmentUploadUrl", "documentation": "Grants permission to get a case attachment upload URL" }, - "smithy.api#documentation": "

Grants permission to upload an attachment to a case.

", + "smithy.api#documentation": "

Uploads an attachment to a case.

", "smithy.api#examples": [ { "title": "Invoke GetCaseAttachmentUploadUrl", @@ -1678,7 +1696,7 @@ "caseId": { "target": "com.amazonaws.securityir#CaseId", "traits": { - "smithy.api#documentation": "

Required element for GetCaseAttachmentUploadUrl to identify the case ID for uploading an attachment to.

", + "smithy.api#documentation": "

Required element for GetCaseAttachmentUploadUrl to identify the case ID for uploading an attachment.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCaseAttachmentUploadUrl.html#securityir-GetCaseAttachmentUploadUrl-request-uri-caseId" }, @@ -1699,7 +1717,7 @@ "contentLength": { "target": "com.amazonaws.securityir#ContentLength", "traits": { - "smithy.api#documentation": "

Required element for GetCaseAttachmentUploadUrl to identify the size od the file attachment.

", + "smithy.api#documentation": "

Required element for GetCaseAttachmentUploadUrl to identify the size of the file attachment.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCaseAttachmentUploadUrl.html#securityir-GetCaseAttachmentUploadUrl-request-fileName" }, @@ -1710,7 +1728,7 @@ "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Optional element for customer provided token.

", + "smithy.api#documentation": "

The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCaseAttachmentUploadUrl.html#securityir-GetCaseAttachmentUploadUrl-request-clientToken" }, @@ -1732,7 +1750,7 @@ "attachmentPresignedUrl": { "target": "com.amazonaws.securityir#Url", "traits": { - "smithy.api#documentation": "

Response element providing the Amazon S3 presigned UTL to upload the attachment.

", + "smithy.api#documentation": "

Response element providing the Amazon S3 presigned URL to upload the attachment.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCaseAttachmentUploadUrl.html#securityir-GetCaseAttachmentUploadUrl-response-attachmentPresignedUrl" }, @@ -1850,7 +1868,7 @@ "pendingAction": { "target": "com.amazonaws.securityir#PendingAction", "traits": { - "smithy.api#documentation": "

Response element for GetCase that provides identifies the case is waiting on customer input.

", + "smithy.api#documentation": "

Response element for GetCase that identifies the case is waiting on customer input.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-pendingAction" } @@ -1904,7 +1922,7 @@ "resolverType": { "target": "com.amazonaws.securityir#ResolverType", "traits": { - "smithy.api#documentation": "

Response element for GetCase that provides the current resolver types. Options include self-supported | AWS-supported.

", + "smithy.api#documentation": "

Response element for GetCase that provides the current resolver types.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetCase.html#securityir-GetCase-response-resolverType" } @@ -1955,7 +1973,7 @@ "name": "GetMembership", "documentation": "Grants permission to get a membership" }, - "smithy.api#documentation": "

Grants permission to get details of a designated service membership.

", + "smithy.api#documentation": "

Returns the attributes of a membership.

", "smithy.api#examples": [ { "title": "Invoke GetMembership", @@ -2157,7 +2175,7 @@ "accountId": { "target": "com.amazonaws.securityir#AWSAccountId", "traits": { - "smithy.api#documentation": "

Response element for GetMembership that provides the configured account for managing the membership.

", + "smithy.api#documentation": "

Response element for GetMembership that provides the account configured to manage the membership.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-response-accountId" } @@ -2166,7 +2184,7 @@ "region": { "target": "com.amazonaws.securityir#AwsRegion", "traits": { - "smithy.api#documentation": "

Response element for GetMembership that provides the configured region for managing the membership.

", + "smithy.api#documentation": "

Response element for GetMembership that provides the region configured to manage the membership.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-response-region" } @@ -2252,6 +2270,15 @@ "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-response-optInFeatures" } } + }, + "membershipAccountsConfigurations": { + "target": "com.amazonaws.securityir#MembershipAccountsConfigurations", + "traits": { + "smithy.api#documentation": "

The membershipAccountsConfigurations field contains the configuration details for member accounts within the Amazon Web Services Organizations membership structure.

This field returns a structure containing information about:

  • Account configurations for member accounts

  • Membership settings and preferences

  • Account-level permissions and roles

", + "smithy.api#externalDocumentation": { + "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_GetMembership.html#securityir-GetMembership-response-membershipAccountsConfigurations" + } + } } }, "traits": { @@ -2377,13 +2404,14 @@ "message": { "target": "smithy.api#String", "traits": { + "smithy.api#documentation": "

The exception message.

", "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Element providing advice to clients on when the call can be safely retried.", + "smithy.api#documentation": "

The number of seconds after which to retry the request.

", "smithy.api#httpHeader": "Retry-After" } } @@ -2401,6 +2429,7 @@ "message": { "target": "smithy.api#String", "traits": { + "smithy.api#documentation": "

The exception message.

", "smithy.api#required": {} } } @@ -2435,7 +2464,7 @@ "name": "ListCaseEdits", "documentation": "Grants permission to list case edits" }, - "smithy.api#documentation": "

Grants permissions to view the aidt log for edits made to a designated case.

", + "smithy.api#documentation": "

Views the case history for edits made to a designated case.

", "smithy.api#examples": [ { "title": "Invoke ListCaseEdits", @@ -2479,7 +2508,7 @@ "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Optional element for a customer provided token.

", + "smithy.api#documentation": "

An optional string that, if supplied, must be copied from the output of a previous call to ListCaseEdits. When provided in this manner, the API fetches the next page of results.

", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCaseEdits.html#securityir-ListCaseEdits-request-nextToken" }, @@ -2525,7 +2554,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Optional element.

", + "smithy.api#documentation": "

An optional string that, if supplied on subsequent calls to ListCaseEdits, allows the API to fetch the next page of results.

", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCaseEdits.html#securityir-ListCaseEdits-response-nextToken" } @@ -2534,7 +2563,7 @@ "items": { "target": "com.amazonaws.securityir#CaseEditItems", "traits": { - "smithy.api#documentation": "

Response element for ListCaseEdits that includes the action, eventtimestamp, message, and principal for the response.

", + "smithy.api#documentation": "

Response element for ListCaseEdits that includes the action, event timestamp, message, and principal for the response.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCaseEdits.html#securityir-ListCaseEdits-response-items" } @@ -2567,7 +2596,7 @@ "name": "ListCases", "documentation": "Grants permission to list cases" }, - "smithy.api#documentation": "

Grants permission to list all cases the requester has access to.

", + "smithy.api#documentation": "

Lists all cases the requester has access to.

", "smithy.api#examples": [ { "title": "Invoke ListCases", @@ -2718,7 +2747,7 @@ "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Optional element.

", + "smithy.api#documentation": "

An optional string that, if supplied, must be copied from the output of a previous call to ListCases. When provided in this manner, the API fetches the next page of results.

", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCases.html#securityir-ListCases-request-nextToken" }, @@ -2753,7 +2782,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Optional element.

", + "smithy.api#documentation": "

An optional string that, if supplied on subsequent calls to ListCases, allows the API to fetch the next page of results.

", "smithy.api#externalDocumentation": { "API Response": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListCaseEdits.html#securityir-ListCaseEdits-response-nextToken" } @@ -2795,7 +2824,7 @@ "name": "ListComments", "documentation": "Grants permission to list case comments" }, - "smithy.api#documentation": "

Grants permissions to list and view comments for a designated case.

", + "smithy.api#documentation": "

Returns comments for a designated case.

", "smithy.api#examples": [ { "title": "Invoke ListComments", @@ -2897,7 +2926,7 @@ "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Optional element.

", + "smithy.api#documentation": "

An optional string that, if supplied, must be copied from the output of a previous call to ListComments. When provided in this manner, the API fetches the next page of results.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListComments.html#securityir-ListComments-request-nextToken" }, @@ -2943,7 +2972,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Optional request elements.

", + "smithy.api#documentation": "

An optional string that, if supplied on subsequent calls to ListComments, allows the API to fetch the next page of results.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListComments.html#securityir-ListComments-response-nextToken" } @@ -3048,7 +3077,7 @@ "name": "ListMemberships", "documentation": "Grants permission to list memberships" }, - "smithy.api#documentation": "

Grants permission to query the memberships a principal has access to.

", + "smithy.api#documentation": "

Returns the memberships that the calling principal can access.

", "smithy.api#examples": [ { "title": "Invoke ListMemberships", @@ -3092,7 +3121,7 @@ "target": "smithy.api#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Optional element.

", + "smithy.api#documentation": "

An optional string that, if supplied, must be copied from the output of a previous call to ListMemberships. When provided in this manner, the API fetches the next page of results.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListMemberships.html#securityir-ListMemberships-request-nextToken" }, @@ -3127,7 +3156,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Optional element.

", + "smithy.api#documentation": "

An optional string that, if supplied on subsequent calls to ListMemberships, allows the API to fetch the next page of results.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_ListMemberships.html#securityir-ListMemberships-response-nextToken" } @@ -3175,7 +3204,7 @@ "name": "ListTagsForResource", "documentation": "Grants permission to list the tags attached to the specified resource" }, - "smithy.api#documentation": "

Grants permission to view currently configured tags on a resource.

", + "smithy.api#documentation": "

Returns currently configured tags on a resource.

", "smithy.api#examples": [ { "title": "Invoke ListTagsForResource", @@ -3308,6 +3337,12 @@ "traits": { "smithy.api#enumValue": "Disassociated" } + }, + "UNASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unassociated" + } } } }, @@ -3319,7 +3354,67 @@ "traits": { "smithy.api#enumValue": "Organization" } + }, + "UNRELATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unrelated" + } + } + } + }, + "com.amazonaws.securityir#MembershipAccountsConfigurations": { + "type": "structure", + "members": { + "coverEntireOrganization": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

The coverEntireOrganization field is a boolean value that determines whether the membership configuration applies to all accounts within an Amazon Web Services Organization.

When set to true, the configuration will be applied across all accounts in the organization. When set to false, the configuration will only apply to specifically designated accounts under the AWS Organizational Units specificied.

" + } + }, + "organizationalUnits": { + "target": "com.amazonaws.securityir#OrganizationalUnits", + "traits": { + "smithy.api#documentation": "

A list of organizational unit IDs that follow the pattern ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}. These IDs represent the organizational units within an Amazon Web Services Organizations structure that are covered by the membership.

Each organizational unit ID in the list must:

  • Begin with the prefix 'ou-'

  • Contain between 4 and 32 alphanumeric characters in the first segment

  • Contain between 8 and 32 alphanumeric characters in the second segment

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The MembershipAccountsConfigurations structure defines the configuration settings for managing membership accounts withinAmazon Web Services.

This structure contains settings that determine how member accounts are configured and managed within your organization, including:

  • Account configuration preferences

  • Membership validation rules

  • Account access settings

You can use this structure to define and maintain standardized configurations across multiple member accounts in your organization.

" + } + }, + "com.amazonaws.securityir#MembershipAccountsConfigurationsUpdate": { + "type": "structure", + "members": { + "coverEntireOrganization": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

The coverEntireOrganization field is a boolean value that determines whether the membership configuration should be applied across the entire Amazon Web Services Organization.

When set to true, the configuration will be applied to all accounts within the organization. When set to false, the configuration will only apply to specifically designated accounts.

" + } + }, + "organizationalUnitsToAdd": { + "target": "com.amazonaws.securityir#OrganizationalUnits", + "traits": { + "smithy.api#documentation": "

A list of organizational unit IDs to add to the membership configuration. Each organizational unit ID must match the pattern ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}.

The list must contain between 1 and 5 organizational unit IDs.

", + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "organizationalUnitsToRemove": { + "target": "com.amazonaws.securityir#OrganizationalUnits", + "traits": { + "smithy.api#documentation": "

A list of organizational unit IDs to remove from the membership configuration. Each organizational unit ID must match the pattern ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}.

The list must contain between 1 and 5 organizational unit IDs per invocation of the API request.

", + "smithy.api#length": { + "min": 1, + "max": 5 + } + } } + }, + "traits": { + "smithy.api#documentation": "

The MembershipAccountsConfigurationsUpdatestructure represents the configuration updates for member accounts within an Amazon Web Services organization.

This structure is used to modify existing account configurations and settings for members in the organization. When applying updates, ensure all required fields are properly specified to maintain account consistency.

Key considerations when using this structure:

  • All configuration changes are validated before being applied

  • Updates are processed asynchronously in the background

  • Configuration changes may take several minutes to propagate across all affected accounts

" } }, "com.amazonaws.securityir#MembershipArn": { @@ -3421,6 +3516,21 @@ "smithy.api#uniqueItems": {} } }, + "com.amazonaws.securityir#OrganizationalUnitId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$" + } + }, + "com.amazonaws.securityir#OrganizationalUnits": { + "type": "list", + "member": { + "target": "com.amazonaws.securityir#OrganizationalUnitId" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.securityir#PendingAction": { "type": "enum", "members": { @@ -3477,6 +3587,7 @@ "message": { "target": "smithy.api#String", "traits": { + "smithy.api#documentation": "

The exception message.

", "smithy.api#required": {} } } @@ -3575,7 +3686,7 @@ ], "aws.protocols#restJson1": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "

This guide provides documents the action and response elements for customer use of the service.

", + "smithy.api#documentation": "

This guide documents the action and response elements for use of the service.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3816,102 +3927,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://security-ir-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://security-ir.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://security-ir-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://security-ir.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://security-ir-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://security-ir.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://security-ir-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://security-ir.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { @@ -3929,6 +3944,7 @@ "message": { "target": "smithy.api#String", "traits": { + "smithy.api#documentation": "

The exception message.

", "smithy.api#required": {} } } @@ -3977,34 +3993,35 @@ "message": { "target": "smithy.api#String", "traits": { + "smithy.api#documentation": "

The exception message.

", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Element that provides the ID of the resource affected.", + "smithy.api#documentation": "

The ID of the requested resource which lead to the service quota exception.

", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Element that provides the type of the resource affected.", + "smithy.api#documentation": "

The type of the requested resource which lead to the service quota exception.

", "smithy.api#required": {} } }, "serviceCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Element that provides the originating service who made the call.", + "smithy.api#documentation": "

The service code of the quota.

", "smithy.api#required": {} } }, "quotaCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Element that provides the quota that was exceeded.", + "smithy.api#documentation": "

The code of the quota.

", "smithy.api#required": {} } } @@ -4073,7 +4090,7 @@ "name": "TagResource", "documentation": "Grants permission to add tags to the specified resource" }, - "smithy.api#documentation": "

Grants permission to add a tag(s) to a designated resource.

", + "smithy.api#documentation": "

Adds a tag(s) to a designated resource.

", "smithy.api#examples": [ { "title": "Invoke TagResource", @@ -4199,25 +4216,26 @@ "message": { "target": "smithy.api#String", "traits": { + "smithy.api#documentation": "

The exception message.

", "smithy.api#required": {} } }, "serviceCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Element providing the service code of the originating service." + "smithy.api#documentation": "

The service code of the exception.

" } }, "quotaCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Element providing the quota of the originating service." + "smithy.api#documentation": "

The quota code of the exception.

" } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Element providing advice to clients on when the call can be safely retried.", + "smithy.api#documentation": "

The number of seconds after which to retry the request.

", "smithy.api#httpHeader": "Retry-After" } } @@ -4259,7 +4277,7 @@ "name": "UntagResource", "documentation": "Grants permission to remove tags from the specified resource" }, - "smithy.api#documentation": "

Grants permission to remove a tag(s) from a designate resource.

", + "smithy.api#documentation": "

Removes a tag(s) from a designate resource.

", "smithy.api#examples": [ { "title": "Invoke UntagResource", @@ -4350,7 +4368,7 @@ "name": "UpdateCase", "documentation": "Grants permission to update a case" }, - "smithy.api#documentation": "

Grants permission to update an existing case.

", + "smithy.api#documentation": "

Updates an existing case.

", "smithy.api#examples": [ { "title": "Invoke UpdateCase", @@ -4436,7 +4454,7 @@ "name": "UpdateCaseComment", "documentation": "Grants permission to update a case comment" }, - "smithy.api#documentation": "

Grants permission to update an existing case comment.

", + "smithy.api#documentation": "

Updates an existing case comment.

", "smithy.api#examples": [ { "title": "Invoke UpdateCaseComment", @@ -4663,7 +4681,7 @@ "impactedAccountsToAdd": { "target": "com.amazonaws.securityir#ImpactedAccounts", "traits": { - "smithy.api#documentation": "

Optional element for UpdateCase to provide content to add accounts impacted.

", + "smithy.api#documentation": "

Optional element for UpdateCase to provide content to add accounts impacted.

AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-impactedAccountsToAdd" } @@ -4672,7 +4690,7 @@ "impactedAccountsToDelete": { "target": "com.amazonaws.securityir#ImpactedAccounts", "traits": { - "smithy.api#documentation": "

Optional element for UpdateCase to provide content to add accounts impacted.

", + "smithy.api#documentation": "

Optional element for UpdateCase to provide content to add accounts impacted.

AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateCase.html#securityir-UpdateCase-request-impactedAccountsToDelete" } @@ -4703,7 +4721,7 @@ "name": "UpdateCaseStatus", "documentation": "Grants permission to update a case status" }, - "smithy.api#documentation": "

Grants permission to update the status for a designated cases. Options include Submitted | Detection and Analysis | Eradication, Containment and Recovery | Post-Incident Activities | Closed.

", + "smithy.api#documentation": "

Updates the state transitions for a designated cases.

Self-managed: the following states are available for self-managed cases.

  • Submitted → Detection and Analysis

  • Detection and Analysis → Containment, Eradication, and Recovery

  • Detection and Analysis → Post-incident Activities

  • Containment, Eradication, and Recovery → Detection and Analysis

  • Containment, Eradication, and Recovery → Post-incident Activities

  • Post-incident Activities → Containment, Eradication, and Recovery

  • Post-incident Activities → Detection and Analysis

  • Any → Closed

AWS supported: You must use the CloseCase API to close.

", "smithy.api#examples": [ { "title": "Invoke UpdateCaseStatus", @@ -4784,11 +4802,12 @@ "aws.iam#iamAction": { "name": "UpdateMembership", "requiredActions": [ - "iam:CreateServiceLinkedRole" + "iam:CreateServiceLinkedRole", + "organizations:DescribeOrganizationalUnit" ], "documentation": "Grants permission to update memberships" }, - "smithy.api#documentation": "

Grants access to UpdateMembership to change membership configuration.

", + "smithy.api#documentation": "

Updates membership configuration.

", "smithy.api#examples": [ { "title": "Invoke UpdateMembership", @@ -4868,6 +4887,24 @@ "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateMembership.html#securityir-UpdateMembership-request-optInFeatures" } } + }, + "membershipAccountsConfigurationsUpdate": { + "target": "com.amazonaws.securityir#MembershipAccountsConfigurationsUpdate", + "traits": { + "smithy.api#documentation": "

The membershipAccountsConfigurationsUpdate field in the UpdateMembershipRequest structure allows you to update the configuration settings for accounts within a membership.

This field is optional and contains a structure of type MembershipAccountsConfigurationsUpdate that specifies the updated account configurations for the membership.

", + "smithy.api#externalDocumentation": { + "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateMembership.html#securityir-UpdateMembership-request-membershipAccountsConfigurationsUpdate" + } + } + }, + "undoMembershipCancellation": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

The undoMembershipCancellation parameter is a boolean flag that indicates whether to reverse a previously requested membership cancellation. When set to true, this will revoke the cancellation request and maintain the membership status.

This parameter is optional and can be used in scenarios where you need to restore a membership that was marked for cancellation but hasn't been fully terminated yet.

  • If set to true, the cancellation request will be revoked

  • If set to false the service will throw a ValidationException.

", + "smithy.api#externalDocumentation": { + "API Reference": "https://docs.aws.amazon.com/security-ir/latest/APIReference/API_UpdateMembership.html#securityir-UpdateMembership-request-undoMembershipCancellation" + } + } } }, "traits": { @@ -4894,7 +4931,7 @@ "name": "UpdateResolverType", "documentation": "Grants permission to update case resolver type" }, - "smithy.api#documentation": "

Grants permission to update the resolver type for a case.

This is a one-way action and cannot be reversed.

Options include self-supported > AWS-supported.

", + "smithy.api#documentation": "

Updates the resolver type for a case.

This is a one-way action and cannot be reversed.

", "smithy.api#examples": [ { "title": "Invoke UpdateResolverType", @@ -5006,20 +5043,21 @@ "message": { "target": "smithy.api#String", "traits": { + "smithy.api#documentation": "

The exception message.

", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.securityir#ValidationExceptionReason", "traits": { - "smithy.api#documentation": "Element that provides the reason the request failed validation.", + "smithy.api#documentation": "

The reason for the exception.

", "smithy.api#required": {} } }, "fieldList": { "target": "com.amazonaws.securityir#ValidationExceptionFieldList", "traits": { - "smithy.api#documentation": "Element that provides the list of field(s) that caused the error, if applicable." + "smithy.api#documentation": "

The fields which lead to the exception.

" } } }, diff --git a/codegen/sdk/aws-models/securityhub.json b/codegen/sdk/aws-models/securityhub.json index 037d00a0a3c..143fbae382b 100644 --- a/codegen/sdk/aws-models/securityhub.json +++ b/codegen/sdk/aws-models/securityhub.json @@ -37489,17 +37489,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -37513,17 +37502,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -37537,17 +37515,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -37561,17 +37528,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -39700,6 +39656,12 @@ "smithy.api#enumValue": "NOT_FOUND" } }, + "RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_NOT_FOUND" + } + }, "LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { diff --git a/codegen/sdk/aws-models/securitylake.json b/codegen/sdk/aws-models/securitylake.json index 5265736769f..7dc25f300be 100644 --- a/codegen/sdk/aws-models/securitylake.json +++ b/codegen/sdk/aws-models/securitylake.json @@ -3729,17 +3729,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3753,17 +3742,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3777,17 +3755,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3801,17 +3768,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/serverlessapplicationrepository.json b/codegen/sdk/aws-models/serverlessapplicationrepository.json index 7f54947f842..c40ce37b389 100644 --- a/codegen/sdk/aws-models/serverlessapplicationrepository.json +++ b/codegen/sdk/aws-models/serverlessapplicationrepository.json @@ -1989,6 +1989,9 @@ "name": "serverlessrepo" }, "aws.protocols#restJson1": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], "smithy.api#documentation": "

The AWS Serverless Application Repository makes it easy for developers and enterprises to quickly find\n and deploy serverless applications in the AWS Cloud. For more information about serverless applications,\n see Serverless Computing and Applications on the AWS website.

The AWS Serverless Application Repository is deeply integrated with the AWS Lambda console, so that developers of \n all levels can get started with serverless computing without needing to learn anything new. You can use category \n keywords to browse for applications such as web and mobile backends, data processing applications, or chatbots. \n You can also search for applications by name, publisher, or event source. To use an application, you simply choose it, \n configure any required fields, and deploy it with a few clicks.

You can also easily publish applications, sharing them publicly with the community at large, or privately\n within your team or across your organization. To publish a serverless application (or app), you can use the\n AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS SDKs to upload the code. Along with the\n code, you upload a simple manifest file, also known as the AWS Serverless Application Model (AWS SAM) template.\n For more information about AWS SAM, see AWS Serverless Application Model (AWS SAM) on the AWS Labs\n GitHub repository.

The AWS Serverless Application Repository Developer Guide contains more information about the two developer\n experiences available:

    \n
  • \n

    Consuming Applications – Browse for applications and view information about them, including\n source code and readme files. Also install, configure, and deploy applications of your choosing.

    \n

    Publishing Applications – Configure and upload applications to make them available to other\n developers, and publish new versions of applications.

    \n
  • \n
", "smithy.api#title": "AWSServerlessApplicationRepository", "smithy.rules#endpointRuleSet": { @@ -2748,17 +2751,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2772,17 +2764,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2796,17 +2777,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2820,17 +2790,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/service-catalog-appregistry.json b/codegen/sdk/aws-models/service-catalog-appregistry.json index 746be551b06..bc315b9241d 100644 --- a/codegen/sdk/aws-models/service-catalog-appregistry.json +++ b/codegen/sdk/aws-models/service-catalog-appregistry.json @@ -956,17 +956,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -980,17 +969,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1004,17 +982,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1028,17 +995,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/service-catalog.json b/codegen/sdk/aws-models/service-catalog.json index a8544b7f3e4..f83d78e3558 100644 --- a/codegen/sdk/aws-models/service-catalog.json +++ b/codegen/sdk/aws-models/service-catalog.json @@ -1142,17 +1142,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1166,17 +1155,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1190,17 +1168,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1214,17 +1181,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/service-quotas.json b/codegen/sdk/aws-models/service-quotas.json index 0c8dde89a22..44dbc749671 100644 --- a/codegen/sdk/aws-models/service-quotas.json +++ b/codegen/sdk/aws-models/service-quotas.json @@ -3228,17 +3228,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3252,17 +3241,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3276,17 +3254,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3300,17 +3267,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/servicediscovery.json b/codegen/sdk/aws-models/servicediscovery.json index 6e5f392f14e..66a8c2b308a 100644 --- a/codegen/sdk/aws-models/servicediscovery.json +++ b/codegen/sdk/aws-models/servicediscovery.json @@ -29,6 +29,15 @@ ] }, "shapes": { + "com.amazonaws.servicediscovery#AWSAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + } + } + }, "com.amazonaws.servicediscovery#AmazonResourceName": { "type": "string", "traits": { @@ -105,7 +114,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a\n DiscoverInstances request but can't be discovered using DNS.

\n

For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map\n quotas in the Cloud Map Developer Guide.

", + "smithy.api#documentation": "

Creates an HTTP namespace. Service instances registered using an HTTP namespace can be\n discovered using a DiscoverInstances request but can't be discovered using\n DNS.

\n

For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the\n Cloud Map Developer Guide.

", "smithy.api#examples": [ { "title": "CreateHttpNamespace example", @@ -135,7 +144,7 @@ "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows failed CreateHttpNamespace\n requests to be retried without the risk of running the operation twice. CreatorRequestId can be any\n unique string (for example, a date/time stamp).

", + "smithy.api#documentation": "

A unique string that identifies the request and that allows failed\n CreateHttpNamespace requests to be retried without the risk of running the\n operation twice. CreatorRequestId can be any unique string (for example, a date/time\n stamp).

", "smithy.api#idempotencyToken": {} } }, @@ -148,7 +157,7 @@ "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { - "smithy.api#documentation": "

The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.

" + "smithy.api#documentation": "

The tags to add to the namespace. Each tag consists of a key and an optional value that you\n define. Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.

" } } }, @@ -196,7 +205,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The\n namespace defines your service naming scheme. For example, if you name your namespace example.com\n and name your service backend, the resulting DNS name for the service is\n backend.example.com. Service instances that are registered using a private DNS namespace can be\n discovered using either a DiscoverInstances request or using DNS. For the current quota on the\n number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the\n Cloud Map Developer Guide.

", + "smithy.api#documentation": "

Creates a private namespace based on DNS, which is visible only inside a specified Amazon\n VPC. The namespace defines your service naming scheme. For example, if you name your namespace\n example.com and name your service backend, the resulting DNS name for\n the service is backend.example.com. Service instances that are registered using a\n private DNS namespace can be discovered using either a DiscoverInstances request or\n using DNS. For the current quota on the number of namespaces that you can create using the same\n Amazon Web Services account, see Cloud Map quotas in the\n Cloud Map Developer Guide.

", "smithy.api#examples": [ { "title": "Example: Create private DNS namespace", @@ -219,14 +228,14 @@ "Name": { "target": "com.amazonaws.servicediscovery#NamespaceNamePrivate", "traits": { - "smithy.api#documentation": "

The name that you want to assign to this namespace. When you create a private DNS namespace, Cloud Map\n automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.

", + "smithy.api#documentation": "

The name that you want to assign to this namespace. When you create a private DNS namespace,\n Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the\n namespace.

", "smithy.api#required": {} } }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace\n requests to be retried without the risk of running the operation twice. CreatorRequestId can be any\n unique string (for example, a date/timestamp).

", + "smithy.api#documentation": "

A unique string that identifies the request and that allows failed\n CreatePrivateDnsNamespace requests to be retried without the risk of running the\n operation twice. CreatorRequestId can be any unique string (for example, a\n date/timestamp).

", "smithy.api#idempotencyToken": {} } }, @@ -246,13 +255,13 @@ "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { - "smithy.api#documentation": "

The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.

" + "smithy.api#documentation": "

The tags to add to the namespace. Each tag consists of a key and an optional value that you\n define. Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.

" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PrivateDnsNamespaceProperties", "traits": { - "smithy.api#documentation": "

Properties for the private DNS\n namespace.

" + "smithy.api#documentation": "

Properties for the\n private DNS namespace.

" } } }, @@ -300,7 +309,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your\n service naming scheme. For example, if you name your namespace example.com and name your service\n backend, the resulting DNS name for the service is backend.example.com. You can\n discover instances that were registered with a public DNS namespace by using either a\n DiscoverInstances request or using DNS. For the current quota on the number of namespaces that you\n can create using the same Amazon Web Services account, see Cloud Map quotas in the\n Cloud Map Developer Guide.

\n \n

The CreatePublicDnsNamespace API operation is not supported in the Amazon Web Services GovCloud (US)\n Regions.

\n
", + "smithy.api#documentation": "

Creates a public namespace based on DNS, which is visible on the internet. The namespace\n defines your service naming scheme. For example, if you name your namespace\n example.com and name your service backend, the resulting DNS name for\n the service is backend.example.com. You can discover instances that were registered\n with a public DNS namespace by using either a DiscoverInstances request or using\n DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the\n Cloud Map Developer Guide.

\n \n

The CreatePublicDnsNamespace API operation is not supported in the Amazon Web Services GovCloud (US) Regions.

\n
", "smithy.api#examples": [ { "title": "CreatePublicDnsNamespace example", @@ -323,14 +332,14 @@ "Name": { "target": "com.amazonaws.servicediscovery#NamespaceNamePublic", "traits": { - "smithy.api#documentation": "

The name that you want to assign to this namespace.

\n \n

Do not include sensitive information in the name. The name is publicly available using DNS queries.

\n
", + "smithy.api#documentation": "

The name that you want to assign to this namespace.

\n \n

Do not include sensitive information in the name. The name is publicly available using DNS\n queries.

\n
", "smithy.api#required": {} } }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows failed CreatePublicDnsNamespace\n requests to be retried without the risk of running the operation twice. CreatorRequestId can be any\n unique string (for example, a date/timestamp).

", + "smithy.api#documentation": "

A unique string that identifies the request and that allows failed\n CreatePublicDnsNamespace requests to be retried without the risk of running the\n operation twice. CreatorRequestId can be any unique string (for example, a\n date/timestamp).

", "smithy.api#idempotencyToken": {} } }, @@ -343,13 +352,13 @@ "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { - "smithy.api#documentation": "

The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.

" + "smithy.api#documentation": "

The tags to add to the namespace. Each tag consists of a key and an optional value that you\n define. Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.

" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PublicDnsNamespaceProperties", "traits": { - "smithy.api#documentation": "

Properties for the public DNS\n namespace.

" + "smithy.api#documentation": "

Properties for the\n public DNS namespace.

" } } }, @@ -363,7 +372,7 @@ "OperationId": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { - "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully. To get the status of the\n operation, see GetOperation.

" + "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully. To get the\n status of the operation, see GetOperation.

" } } }, @@ -397,7 +406,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a service. This action defines the configuration for the following entities:

\n
    \n
  • \n

    For public and private DNS namespaces, one of the following combinations of DNS records in\n Amazon Route 53:

    \n
      \n
    • \n

      \n A\n

      \n
    • \n
    • \n

      \n AAAA\n

      \n
    • \n
    • \n

      \n A and AAAA\n

      \n
    • \n
    • \n

      \n SRV\n

      \n
    • \n
    • \n

      \n CNAME\n

      \n
    • \n
    \n
  • \n
  • \n

    Optionally, a health check

    \n
  • \n
\n

After you create the service, you can submit a RegisterInstance request, and Cloud Map uses the\n values in the configuration to create the specified entities.

\n

For the current quota on the number of instances that you can register using the same namespace and using\n the same service, see Cloud Map\n quotas in the Cloud Map Developer Guide.

", + "smithy.api#documentation": "

Creates a service. This action defines the configuration for the following entities:

\n
    \n
  • \n

    For public and private DNS namespaces, one of the following combinations of DNS records in\n Amazon Route 53:

    \n
      \n
    • \n

      \n A\n

      \n
    • \n
    • \n

      \n AAAA\n

      \n
    • \n
    • \n

      \n A and AAAA\n

      \n
    • \n
    • \n

      \n SRV\n

      \n
    • \n
    • \n

      \n CNAME\n

      \n
    • \n
    \n
  • \n
  • \n

    Optionally, a health check

    \n
  • \n
\n

After you create the service, you can submit a RegisterInstance request, and\n Cloud Map uses the values in the configuration to create the specified entities.

\n

For the current quota on the number of instances that you can register using the same\n namespace and using the same service, see Cloud Map quotas in the\n Cloud Map Developer Guide.

", "smithy.api#examples": [ { "title": "Example: Create service", @@ -422,6 +431,7 @@ "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita", "CreateDate": 1.587081768334E9, "CreatorRequestId": "567c1193-6b00-4308-bd57-ad38a8822d25", + "CreatedByAccount": "123456789012", "DnsConfig": { "DnsRecords": [ { @@ -433,8 +443,54 @@ "RoutingPolicy": "MULTIVALUE" }, "Id": "srv-p5zdwlg5uvvzjita", + "InstanceCount": 0, "Name": "myservice", - "NamespaceId": "ns-ylexjili4cdxy3xm" + "NamespaceId": "ns-ylexjili4cdxy3xm", + "ResourceOwner": "123456789012", + "Type": "DNS_HTTP" + } + } + }, + { + "title": "Create service using namespace ARN", + "documentation": "Namespace sharee creates a service using a namespace ARN instead of namespace ID, useful when working with shared namespaces.", + "input": { + "Name": "example-service", + "NamespaceId": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678", + "Description": "Example service using namespace ARN", + "DnsConfig": { + "DnsRecords": [ + { + "Type": "A", + "TTL": 300 + } + ], + "RoutingPolicy": "MULTIVALUE" + } + }, + "output": { + "Service": { + "Id": "srv-abcd1234xmpl5678", + "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", + "ResourceOwner": "123456789012", + "Name": "example-service", + "NamespaceId": "ns-abcd1234xmpl5678", + "Description": "Example service using namespace ARN", + "InstanceCount": 0, + "DnsConfig": { + "NamespaceId": "ns-abcd1234xmpl5678", + "RoutingPolicy": "MULTIVALUE", + "DnsRecords": [ + { + "Type": "A", + "TTL": 300 + } + ] + }, + "Type": "DNS_HTTP", + "CreateDate": 1.7051616E9, + "CreatorRequestId": "abcd1234-xmpl-5678-9012-abcd1234xmpl", + "CreatedByAccount": "111122223333" } } } @@ -447,20 +503,20 @@ "Name": { "target": "com.amazonaws.servicediscovery#ServiceName", "traits": { - "smithy.api#documentation": "

The name that you want to assign to the service.

\n \n

Do not include sensitive information in the name if the namespace is discoverable by public DNS\n queries.

\n
\n

If you want Cloud Map to create an SRV record when you register an instance and you're using\n a system that requires a specific SRV format, such as HAProxy, specify the following for Name:

\n
    \n
  • \n

    Start the name with an underscore (_), such as _exampleservice.

    \n
  • \n
  • \n

    End the name with ._protocol, such as ._tcp.

    \n
  • \n
\n

When you register an instance, Cloud Map creates an SRV record and assigns a name to the\n record by concatenating the service name and the namespace name (for example,

\n

\n _exampleservice._tcp.example.com).

\n \n

For services that are accessible by DNS queries, you can't create multiple services with names that differ\n only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be\n distinguished. However, if you use a namespace that's only accessible by API calls, then you can create\n services that with names that differ only by case.

\n
", + "smithy.api#documentation": "

The name that you want to assign to the service.

\n \n

Do not include sensitive information in the name if the namespace is discoverable by public\n DNS queries.

\n
\n

If you want Cloud Map to create an SRV record when you register an instance\n and you're using a system that requires a specific SRV format, such as HAProxy, specify the following for\n Name:

\n
    \n
  • \n

    Start the name with an underscore (_), such as _exampleservice.

    \n
  • \n
  • \n

    End the name with ._protocol, such as ._tcp.

    \n
  • \n
\n

When you register an instance, Cloud Map creates an SRV record and assigns a\n name to the record by concatenating the service name and the namespace name (for example,

\n

\n _exampleservice._tcp.example.com).

\n \n

For services that are accessible by DNS queries, you can't create multiple services with\n names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the\n same DNS name and can't be distinguished. However, if you use a namespace that's only accessible\n by API calls, then you can create services that with names that differ only by case.

\n
", "smithy.api#required": {} } }, "NamespaceId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but\n it can be specified either here or in the DnsConfig object.

" + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the namespace that you want to use to create the service. For\n namespaces shared with your Amazon Web Services account, specify the namespace ARN. For more information\n about shared namespaces, see Cross-account Cloud Map namespace sharing in the\n Cloud Map Developer Guide.

" } }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows failed CreateService requests to\n be retried without the risk of running the operation twice. CreatorRequestId can be any unique\n string (for example, a date/timestamp).

", + "smithy.api#documentation": "

A unique string that identifies the request and that allows failed\n CreateService requests to be retried without the risk of running the operation\n twice. CreatorRequestId can be any unique string (for example, a\n date/timestamp).

", "smithy.api#idempotencyToken": {} } }, @@ -473,31 +529,31 @@ "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create\n when you register an instance.

" + "smithy.api#documentation": "

A complex type that contains information about the Amazon Route 53 records that you want\n Cloud Map to create when you register an instance.

" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. A complex type that contains settings for an\n optional Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check\n with all the Route 53 DNS records that you specify in DnsConfig.

\n \n

If you specify a health check configuration, you can specify either HealthCheckCustomConfig\n or HealthCheckConfig but not both.

\n
\n

For information about the charges for health checks, see Cloud Map Pricing.

" + "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. A complex type that contains\n settings for an optional Route 53 health check. If you specify settings for a health check,\n Cloud Map associates the health check with all the Route 53 DNS records that you specify in\n DnsConfig.

\n \n

If you specify a health check configuration, you can specify either\n HealthCheckCustomConfig or HealthCheckConfig but not both.

\n
\n

For information about the charges for health checks, see Cloud Map Pricing.

" } }, "HealthCheckCustomConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig", "traits": { - "smithy.api#documentation": "

A complex type that contains information about an optional custom health check.

\n \n

If you specify a health check configuration, you can specify either HealthCheckCustomConfig\n or HealthCheckConfig but not both.

\n
\n

You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing\n service.

" + "smithy.api#documentation": "

A complex type that contains information about an optional custom health check.

\n \n

If you specify a health check configuration, you can specify either\n HealthCheckCustomConfig or HealthCheckConfig but not both.

\n
\n

You can't add, update, or delete a HealthCheckCustomConfig configuration from\n an existing service.

" } }, "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { - "smithy.api#documentation": "

The tags to add to the service. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.

" + "smithy.api#documentation": "

The tags to add to the service. Each tag consists of a key and an optional value that you\n define. Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.

" } }, "Type": { "target": "com.amazonaws.servicediscovery#ServiceTypeOption", "traits": { - "smithy.api#documentation": "

If present, specifies that the service instances are only discoverable using the\n DiscoverInstances API operation. No DNS records is registered for the service instances. The only\n valid value is HTTP.

" + "smithy.api#documentation": "

If present, specifies that the service instances are only discoverable using the\n DiscoverInstances API operation. No DNS records is registered for the service\n instances. The only valid value is HTTP.

" } } }, @@ -527,7 +583,7 @@ } }, "traits": { - "smithy.api#documentation": "

The health check for the instance that's specified by ServiceId and InstanceId\n isn't a custom health check.

", + "smithy.api#documentation": "

The health check for the instance that's specified by ServiceId and\n InstanceId isn't a custom health check.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -572,7 +628,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a namespace from the current account. If the namespace still contains one or more services, the\n request fails.

", + "smithy.api#documentation": "

Deletes a namespace from the current account. If the namespace still contains one or more\n services, the request fails.

", "smithy.api#examples": [ { "title": "Example: Delete namespace", @@ -581,7 +637,17 @@ "Id": "ns-ylexjili4cdxy3xm" }, "output": { - "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k98y6drk" + "OperationId": "abcd1234-xmpl-5678-9012-abcd1234xmplabcd" + } + }, + { + "title": "Delete namespace using namespace ARN", + "documentation": "Deletes a namespace using a namespace ARN instead of namespace ID, useful when working with shared namespaces.", + "input": { + "Id": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678" + }, + "output": { + "OperationId": "abcd1234-xmpl-5678-9012-abcd1234xmplabcd" } } ] @@ -591,9 +657,9 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the namespace that you want to delete.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the namespace that you want to delete.

", "smithy.api#required": {} } } @@ -636,7 +702,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a specified service and all associated service attributes. If the service still contains one or more registered instances, the request\n fails.

", + "smithy.api#documentation": "

Deletes a specified service and all associated service attributes. If the service still\n contains one or more registered instances, the request fails.

", "smithy.api#examples": [ { "title": "Example: Delete service", @@ -645,6 +711,14 @@ "Id": "srv-p5zdwlg5uvvzjita" }, "output": {} + }, + { + "title": "Delete service using service ARN", + "documentation": "Deletes a service using a service ARN instead of service ID, useful when working with shared namespaces.", + "input": { + "Id": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678" + }, + "output": {} } ] } @@ -678,6 +752,17 @@ "ServiceId": "srv-e4anhexample0004" }, "output": {} + }, + { + "title": "Delete service attributes using service ARN", + "documentation": "Deletes service attributes using a service ARN instead of service ID, useful for cross-account scenarios or when working with shared namespaces.", + "input": { + "ServiceId": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", + "Attributes": [ + "Port" + ] + }, + "output": {} } ] } @@ -686,9 +771,9 @@ "type": "structure", "members": { "ServiceId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the service from which the attributes will be deleted.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the service from which the attributes will be deleted. For services\n created in a namespace shared with your Amazon Web Services account, specify the service ARN. For more\n information about shared namespaces, see Cross-account Cloud Map namespace sharing in the\n Cloud Map Developer Guide.

", "smithy.api#required": {} } }, @@ -715,9 +800,9 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the service that you want to delete.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the service that you want to delete. If the namespace associated with\n the service is shared with your Amazon Web Services account, specify the service ARN. For more information\n about shared namespaces, see Cross-account Cloud Map namespace\n sharing.

", "smithy.api#required": {} } } @@ -759,7 +844,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified\n instance.

", + "smithy.api#documentation": "

Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the\n specified instance.

", "smithy.api#examples": [ { "title": "Example: Deregister a service instance", @@ -771,6 +856,17 @@ "output": { "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k98rnaiq" } + }, + { + "title": "Deregister instance using service ARN", + "documentation": "Deregisters an instance using a service ARN instead of service ID, useful when working with shared namespaces.", + "input": { + "InstanceId": "i-abcd1234xmpl5678", + "ServiceId": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678" + }, + "output": { + "OperationId": "abcd1234-xmpl-5678-9012-abcd1234xmpl" + } } ] } @@ -779,9 +875,9 @@ "type": "structure", "members": { "ServiceId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the service that the instance is associated with.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the service that the instance is associated with. If the namespace\n associated with the service is shared with your account, specify the service ARN. For more\n information about shared namespaces, see Cross-account Cloud Map namespace sharing in the\n Cloud Map Developer Guide.

", "smithy.api#required": {} } }, @@ -834,11 +930,44 @@ } ], "traits": { - "smithy.api#documentation": "

Discovers registered instances for a specified namespace and service. You can use\n DiscoverInstances to discover instances for any type of namespace. DiscoverInstances\n returns a randomized list of instances allowing customers to distribute traffic evenly across instances. For\n public and private DNS namespaces, you can also use DNS queries to discover instances.

", + "smithy.api#documentation": "

Discovers registered instances for a specified namespace and service. You can use\n DiscoverInstances to discover instances for any type of namespace.\n DiscoverInstances returns a randomized list of instances allowing customers to\n distribute traffic evenly across instances. For public and private DNS namespaces, you can also\n use DNS queries to discover instances.

", "smithy.api#endpoint": { "hostPrefix": "data-" }, "smithy.api#examples": [ + { + "title": "Discover instances using owner account", + "documentation": "Discovers instances in a shared namespace by specifying the OwnerAccount parameter, useful when working with shared namespaces.", + "input": { + "NamespaceName": "example-shared-namespace", + "ServiceName": "shared-namespace-service", + "OwnerAccount": "123456789012" + }, + "output": { + "Instances": [ + { + "InstanceId": "i-abcd1234xmpl5678", + "NamespaceName": "example-shared-namespace", + "ServiceName": "shared-service", + "HealthStatus": "HEALTHY", + "Attributes": { + "AWS_INSTANCE_IPV4": "192.0.2.44", + "AWS_INSTANCE_PORT": "80" + } + }, + { + "InstanceId": "i-efgh5678xmpl9012", + "NamespaceName": "example-shared-namespace", + "ServiceName": "shared-service", + "HealthStatus": "HEALTHY", + "Attributes": { + "AWS_INSTANCE_IPV4": "192.0.2.45", + "AWS_INSTANCE_PORT": "80" + } + } + ] + } + }, { "title": "Example: Discover registered instances", "documentation": "Example: Discover registered instances", @@ -872,7 +1001,7 @@ "NamespaceName": { "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { - "smithy.api#documentation": "

The HttpName name of the namespace. It's found in the HttpProperties member of\n the Properties member of the namespace. In most cases, Name and HttpName\n match. However, if you reuse Name for namespace creation, a generated hash is added to\n HttpName to distinguish the two.

", + "smithy.api#documentation": "

The HttpName name of the namespace. The HttpName is\n found in the HttpProperties member of the Properties member of the\n namespace. In most cases, Name and HttpName match. However, if you\n reuse Name for namespace creation, a generated hash is added to\n HttpName to distinguish the two.

", "smithy.api#required": {} } }, @@ -886,25 +1015,31 @@ "MaxResults": { "target": "com.amazonaws.servicediscovery#DiscoverMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of instances that you want Cloud Map to return in the response to a\n DiscoverInstances request. If you don't specify a value for MaxResults, Cloud Map\n returns up to 100 instances.

" + "smithy.api#documentation": "

The maximum number of instances that you want Cloud Map to return in the response to a\n DiscoverInstances request. If you don't specify a value for\n MaxResults, Cloud Map returns up to 100 instances.

" } }, "QueryParameters": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "

Filters to scope the results based on custom attributes for the instance (for example, {version=v1,\n az=1a}). Only instances that match all the specified key-value pairs are returned.

" + "smithy.api#documentation": "

Filters to scope the results based on custom attributes for the instance (for example,\n {version=v1, az=1a}). Only instances that match all the specified key-value pairs\n are returned.

" } }, "OptionalParameters": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "

Opportunistic filters to scope the results based on custom attributes. If there are instances that match\n both the filters specified in both the QueryParameters parameter and this parameter, all of these\n instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are\n specified in the QueryParameters parameter are returned.

" + "smithy.api#documentation": "

Opportunistic filters to scope the results based on custom attributes. If there are\n instances that match both the filters specified in both the QueryParameters\n parameter and this parameter, all of these instances are returned. Otherwise, the filters are\n ignored, and only instances that match the filters that are specified in the\n QueryParameters parameter are returned.

" } }, "HealthStatus": { "target": "com.amazonaws.servicediscovery#HealthStatusFilter", "traits": { - "smithy.api#documentation": "

The health status of the instances that you want to discover. This parameter is ignored for services that\n don't have a health check configured, and\n all\n instances are returned.

\n
\n
HEALTHY
\n
\n

Returns healthy instances.

\n
\n
UNHEALTHY
\n
\n

Returns unhealthy instances.

\n
\n
ALL
\n
\n

Returns all instances.

\n
\n
HEALTHY_OR_ELSE_ALL
\n
\n

Returns healthy instances, unless none are reporting a healthy state. In that case, return all\n instances. This is also called failing open.

\n
\n
" + "smithy.api#documentation": "

The health status of the instances that you want to discover. This parameter is ignored for\n services that don't have a health check configured, and\n all\n instances are returned.

\n
\n
HEALTHY
\n
\n

Returns healthy instances.

\n
\n
UNHEALTHY
\n
\n

Returns unhealthy instances.

\n
\n
ALL
\n
\n

Returns all instances.

\n
\n
HEALTHY_OR_ELSE_ALL
\n
\n

Returns healthy instances, unless none are reporting a healthy state. In that case,\n return all instances. This is also called failing open.

\n
\n
" + } + }, + "OwnerAccount": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the namespace associated with the instance, as specified in the namespace ResourceOwner field. For\n instances associated with namespaces that are shared with your account, you must specify an OwnerAccount.

" } } }, @@ -918,13 +1053,13 @@ "Instances": { "target": "com.amazonaws.servicediscovery#HttpInstanceSummaryList", "traits": { - "smithy.api#documentation": "

A complex type that contains one HttpInstanceSummary for each registered instance.

" + "smithy.api#documentation": "

A complex type that contains one HttpInstanceSummary for each registered\n instance.

" } }, "InstancesRevision": { "target": "com.amazonaws.servicediscovery#Revision", "traits": { - "smithy.api#documentation": "

The increasing revision associated to the response Instances list. If a new instance is registered or\n deregistered, the InstancesRevision updates. The health status updates don't update\n InstancesRevision.

" + "smithy.api#documentation": "

The increasing revision associated to the response Instances list. If a new instance is\n registered or deregistered, the InstancesRevision updates. The health status updates\n don't update InstancesRevision.

" } } }, @@ -960,6 +1095,18 @@ "hostPrefix": "data-" }, "smithy.api#examples": [ + { + "title": "Discover instances revision using owner account", + "documentation": "Discovers the instances revision in a shared namespace by specifying the OwnerAccount parameter, useful when working with shared namespaces.", + "input": { + "NamespaceName": "example-shared-namespace", + "ServiceName": "shared-service", + "OwnerAccount": "123456789012" + }, + "output": { + "InstancesRevision": 1001 + } + }, { "title": "To discover the revision for a registered instance", "documentation": "The following example discovers the revision ID for a registered instance.", @@ -980,7 +1127,7 @@ "NamespaceName": { "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { - "smithy.api#documentation": "

The HttpName name of the namespace. It's found in the HttpProperties member of\n the Properties member of the namespace.

", + "smithy.api#documentation": "

The HttpName name of the namespace. The HttpName is\n found in the HttpProperties member of the Properties member of the\n namespace.

", "smithy.api#required": {} } }, @@ -990,6 +1137,12 @@ "smithy.api#documentation": "

The name of the service that you specified when you registered the instance.

", "smithy.api#required": {} } + }, + "OwnerAccount": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the namespace associated with the instance, as specified in the namespace ResourceOwner field. For\n instances associated with namespaces that are shared with your account, you must specify an OwnerAccount. For more information about\n shared namespaces, see Cross-account Cloud Map namespace sharing in the\n Cloud Map Developer Guide.

" + } } }, "traits": { @@ -1002,7 +1155,7 @@ "InstancesRevision": { "target": "com.amazonaws.servicediscovery#Revision", "traits": { - "smithy.api#documentation": "

The increasing revision associated to the response Instances list. If a new instance is registered or\n deregistered, the InstancesRevision updates. The health status updates don't update\n InstancesRevision.

" + "smithy.api#documentation": "

The increasing revision associated to the response Instances list. If a new instance is\n registered or deregistered, the InstancesRevision updates. The health status updates\n don't update InstancesRevision.

" } } }, @@ -1028,25 +1181,25 @@ "smithy.api#deprecated": { "message": "Top level attribute in request should be used to reference namespace-id" }, - "smithy.api#documentation": "

\n Use\n NamespaceId in Service\n instead.\n

\n

The ID of the namespace to use for DNS configuration.

" + "smithy.api#documentation": "

\n Use\n NamespaceId in Service instead.\n

\n

The ID of the namespace to use for DNS configuration.

" } }, "RoutingPolicy": { "target": "com.amazonaws.servicediscovery#RoutingPolicy", "traits": { - "smithy.api#documentation": "

The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you\n register an instance and specify this service.

\n \n

If you want to use this service to register instances that create alias records, specify\n WEIGHTED for the routing policy.

\n
\n

You can specify the following values:

\n
\n
MULTIVALUE
\n
\n

If you define a health check for the service and the health check is healthy, Route 53 returns the\n applicable value for up to eight instances.

\n

For example, suppose that the service includes configurations for one A record and a health\n check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up\n to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with\n the IP addresses for all of the healthy instances.

\n

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and\n returns the values for up to eight instances.

\n

For more information about the multivalue routing policy, see Multivalue Answer\n Routing in the Route 53 Developer Guide.

\n
\n
WEIGHTED
\n
\n

Route 53 returns the applicable value from one randomly selected instance from among the instances that you\n registered using the same service. Currently, all records have the same weight, so you can't route more or\n less traffic to any instances.

\n

For example, suppose that the service includes configurations for one A record and a health\n check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for\n one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds\n to DNS queries as if all of the instances were healthy.

\n

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and\n returns the applicable value for one randomly selected instance.

\n

For more information about the weighted routing policy, see Weighted Routing in\n the Route 53 Developer Guide.

\n
\n
" + "smithy.api#documentation": "

The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates\n when you register an instance and specify this service.

\n \n

If you want to use this service to register instances that create alias records, specify\n WEIGHTED for the routing policy.

\n
\n

You can specify the following values:

\n
\n
MULTIVALUE
\n
\n

If you define a health check for the service and the health check is healthy, Route 53\n returns the applicable value for up to eight instances.

\n

For example, suppose that the service includes configurations for one A\n record and a health check. You use the service to register 10 instances. Route 53 responds to DNS\n queries with IP addresses for up to eight healthy instances. If fewer than eight instances are\n healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy\n instances.

\n

If you don't define a health check for the service, Route 53 assumes that all instances are\n healthy and returns the values for up to eight instances.

\n

For more information about the multivalue routing policy, see Multivalue\n Answer Routing in the Route 53 Developer Guide.

\n
\n
WEIGHTED
\n
\n

Route 53 returns the applicable value from one randomly selected instance from among the\n instances that you registered using the same service. Currently, all records have the same\n weight, so you can't route more or less traffic to any instances.

\n

For example, suppose that the service includes configurations for one A\n record and a health check. You use the service to register 10 instances. Route 53 responds to DNS\n queries with the IP address for one randomly selected instance from among the healthy\n instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the\n instances were healthy.

\n

If you don't define a health check for the service, Route 53 assumes that all instances are\n healthy and returns the applicable value for one randomly selected instance.

\n

For more information about the weighted routing policy, see Weighted\n Routing in the Route 53 Developer Guide.

\n
\n
" } }, "DnsRecords": { "target": "com.amazonaws.servicediscovery#DnsRecordList", "traits": { - "smithy.api#documentation": "

An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map\n to create when you register an instance.

\n \n

The record type of a service specified in a DnsRecord object can't be updated. To change a record type, you need to delete the service and recreate it with a new\n DnsConfig.

\n
", + "smithy.api#documentation": "

An array that contains one DnsRecord object for each Route 53 DNS record that you\n want Cloud Map to create when you register an instance.

\n \n

The record type of a service specified in a DnsRecord object can't be updated.\n To change a record type, you need to delete the service and recreate it with a new\n DnsConfig.

\n
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the Amazon Route 53 DNS records that you want Cloud Map to create\n when you register an instance.

" + "smithy.api#documentation": "

A complex type that contains information about the Amazon Route 53 DNS records that you want\n Cloud Map to create when you register an instance.

" } }, "com.amazonaws.servicediscovery#DnsConfigChange": { @@ -1055,13 +1208,13 @@ "DnsRecords": { "target": "com.amazonaws.servicediscovery#DnsRecordList", "traits": { - "smithy.api#documentation": "

An array that contains one DnsRecord object for each Route 53 record that you want Cloud Map to\n create when you register an instance.

", + "smithy.api#documentation": "

An array that contains one DnsRecord object for each Route 53 record that you want\n Cloud Map to create when you register an instance.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about changes to the Route 53 DNS records that Cloud Map creates\n when you register an instance.

" + "smithy.api#documentation": "

A complex type that contains information about changes to the Route 53 DNS records that\n Cloud Map creates when you register an instance.

" } }, "com.amazonaws.servicediscovery#DnsProperties": { @@ -1081,7 +1234,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a\n namespace.

" + "smithy.api#documentation": "

A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when\n you create a namespace.

" } }, "com.amazonaws.servicediscovery#DnsRecord": { @@ -1090,20 +1243,20 @@ "Type": { "target": "com.amazonaws.servicediscovery#RecordType", "traits": { - "smithy.api#documentation": "

The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries.\n You can specify values for Type in the following combinations:

\n
    \n
  • \n

    \n \n A\n \n

    \n
  • \n
  • \n

    \n \n AAAA\n \n

    \n
  • \n
  • \n

    \n \n A\n and \n AAAA\n \n

    \n
  • \n
  • \n

    \n \n SRV\n \n

    \n
  • \n
  • \n

    \n \n CNAME\n \n

    \n
  • \n
\n

If you want Cloud Map to create a Route 53 alias record when you register an instance, specify A\n or AAAA for Type.

\n

You specify other settings, such as the IP address for A and AAAA records, when\n you register an instance. For more information, see RegisterInstance.

\n

The following values are supported:

\n
\n
A
\n
\n

Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

\n
\n
AAAA
\n
\n

Route 53 returns the IP address of the resource in IPv6 format, such as\n 2001:0db8:85a3:0000:0000:abcd:0001:2345.

\n
\n
CNAME
\n
\n

Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

\n
    \n
  • \n

    You specify the domain name that you want to route traffic to when you register an instance. For more\n information, see Attributes in the topic RegisterInstance.

    \n
  • \n
  • \n

    You must specify WEIGHTED for the value of RoutingPolicy.

    \n
  • \n
  • \n

    You can't specify both CNAME for Type and settings for\n HealthCheckConfig. If you do, the request will fail with an InvalidInput\n error.

    \n
  • \n
\n
\n
SRV
\n
\n

Route 53 returns the value for an SRV record. The value for an SRV record uses\n the following values:

\n

\n priority weight port service-hostname\n

\n

Note the following about the values:

\n
    \n
  • \n

    The values of priority and weight are both set to 1 and can't\n be changed.

    \n
  • \n
  • \n

    The value of port comes from the value that you specify for the\n AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.

    \n
  • \n
  • \n

    The value of service-hostname is a concatenation of the following values:

    \n
      \n
    • \n

      The value that you specify for InstanceId when you register an instance.

      \n
    • \n
    • \n

      The name of the service.

      \n
    • \n
    • \n

      The name of the namespace.

      \n
    • \n
    \n

    For example, if the value of InstanceId is test, the name of the service is\n backend, and the name of the namespace is example.com, the value of\n service-hostname is the following:

    \n

    \n test.backend.example.com\n

    \n
  • \n
\n

If you specify settings for an SRV record, note the following:

\n
    \n
  • \n

    If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in\n the RegisterInstance request, Cloud Map automatically creates A and/or\n AAAA records that have the same name as the value of service-hostname in the\n SRV record. You can ignore these records.

    \n
  • \n
  • \n

    If you're using a system that requires a specific SRV format, such as HAProxy, see the\n Name element\n in the documentation about CreateService for information about how to specify the correct name\n format.

    \n
  • \n
\n
\n
", + "smithy.api#documentation": "

The type of the resource, which indicates the type of value that Route 53 returns in response\n to DNS queries. You can specify values for Type in the following\n combinations:

\n
    \n
  • \n

    \n \n A\n \n

    \n
  • \n
  • \n

    \n \n AAAA\n \n

    \n
  • \n
  • \n

    \n \n A\n and \n AAAA\n \n

    \n
  • \n
  • \n

    \n \n SRV\n \n

    \n
  • \n
  • \n

    \n \n CNAME\n \n

    \n
  • \n
\n

If you want Cloud Map to create a Route 53 alias record when you register an instance, specify\n A or AAAA for Type.

\n

You specify other settings, such as the IP address for A and AAAA\n records, when you register an instance. For more information, see RegisterInstance.

\n

The following values are supported:

\n
\n
A
\n
\n

Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

\n
\n
AAAA
\n
\n

Route 53 returns the IP address of the resource in IPv6 format, such as\n 2001:0db8:85a3:0000:0000:abcd:0001:2345.

\n
\n
CNAME
\n
\n

Route 53 returns the domain name of the resource, such as www.example.com. Note the\n following:

\n
    \n
  • \n

    You specify the domain name that you want to route traffic to when you register an\n instance. For more information, see Attributes in the topic RegisterInstance.

    \n
  • \n
  • \n

    You must specify WEIGHTED for the value of\n RoutingPolicy.

    \n
  • \n
  • \n

    You can't specify both CNAME for Type and settings for\n HealthCheckConfig. If you do, the request will fail with an\n InvalidInput error.

    \n
  • \n
\n
\n
SRV
\n
\n

Route 53 returns the value for an SRV record. The value for an SRV\n record uses the following values:

\n

\n priority weight port service-hostname\n

\n

Note the following about the values:

\n
    \n
  • \n

    The values of priority and weight are both set to\n 1 and can't be changed.

    \n
  • \n
  • \n

    The value of port comes from the value that you specify for the\n AWS_INSTANCE_PORT attribute when you submit a RegisterInstance\n request.

    \n
  • \n
  • \n

    The value of service-hostname is a concatenation of the following\n values:

    \n
      \n
    • \n

      The value that you specify for InstanceId when you register an\n instance.

      \n
    • \n
    • \n

      The name of the service.

      \n
    • \n
    • \n

      The name of the namespace.

      \n
    • \n
    \n

    For example, if the value of InstanceId is test, the name of\n the service is backend, and the name of the namespace is\n example.com, the value of service-hostname is the\n following:

    \n

    \n test.backend.example.com\n

    \n
  • \n
\n

If you specify settings for an SRV record, note the following:

\n
    \n
  • \n

    If you specify values for AWS_INSTANCE_IPV4,\n AWS_INSTANCE_IPV6, or both in the RegisterInstance request,\n Cloud Map automatically creates A and/or AAAA records that have\n the same name as the value of service-hostname in the SRV record.\n You can ignore these records.

    \n
  • \n
  • \n

    If you're using a system that requires a specific SRV format, such as\n HAProxy, see the Name element in the documentation about CreateService for information\n about how to specify the correct name format.

    \n
  • \n
\n
\n
", "smithy.api#required": {} } }, "TTL": { "target": "com.amazonaws.servicediscovery#RecordTTL", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

\n \n

Alias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an alias record\n routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request,\n the TTL value is ignored. Always specify a TTL for the service; you can use a service to register\n instances that create either alias or non-alias records.

\n
", + "smithy.api#documentation": "

The amount of time, in seconds, that you want DNS resolvers to cache the settings for this\n record.

\n \n

Alias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an\n alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute\n when you submit a RegisterInstance request, the\n TTL value is ignored. Always specify a TTL for the service; you can use a service\n to register instances that create either alias or non-alias records.

\n
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create\n when you register an instance.

" + "smithy.api#documentation": "

A complex type that contains information about the Route 53 DNS records that you want\n Cloud Map to create when you register an instance.

" } }, "com.amazonaws.servicediscovery#DnsRecordList": { @@ -1119,7 +1272,7 @@ "target": "com.amazonaws.servicediscovery#ErrorMessage" }, "DuplicateOperationId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#OperationId", "traits": { "smithy.api#documentation": "

The ID of the operation that's already in progress.

" } @@ -1220,6 +1373,7 @@ "ServiceId": "srv-e4anhexample0004" }, "output": { + "ResourceOwner": "123456789012", "Instance": { "Id": "i-abcd1234", "Attributes": { @@ -1228,7 +1382,30 @@ "color": "green", "region": "us-west-2", "stage": "beta" - } + }, + "CreatedByAccount": "123456789012" + } + } + }, + { + "title": "Get instance details using service ARN for shared namespace", + "documentation": "This example gets information about an instance using a service ARN instead of service ID. This is useful for listing instances associated with shared namespaces.", + "input": { + "InstanceId": "i-abcd1234", + "ServiceId": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004" + }, + "output": { + "ResourceOwner": "123456789012", + "Instance": { + "Id": "i-abcd1234", + "Attributes": { + "AWS_INSTANCE_IPV4": "192.0.2.44", + "AWS_INSTANCE_PORT": "80", + "color": "green", + "region": "us-west-2", + "stage": "beta" + }, + "CreatedByAccount": "111122223333" } } } @@ -1239,9 +1416,9 @@ "type": "structure", "members": { "ServiceId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the service that the instance is associated with.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the service that the instance is associated with. For services\n created in a shared namespace, specify the service ARN. For more information about shared\n namespaces, see Cross-account Cloud Map namespace sharing in the\n Cloud Map Developer Guide.

", "smithy.api#required": {} } }, @@ -1260,6 +1437,12 @@ "com.amazonaws.servicediscovery#GetInstanceResponse": { "type": "structure", "members": { + "ResourceOwner": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that created the namespace that contains the service that the\n instance is associated with. If this isn't your account ID, it's the ID of the account that\n shared the namespace with your account.

" + } + }, "Instance": { "target": "com.amazonaws.servicediscovery#Instance", "traits": { @@ -1291,7 +1474,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the current health status (Healthy, Unhealthy, or Unknown) of\n one or more instances that are associated with a specified service.

\n \n

There's a brief delay between when you register an instance and when the health status for the instance is\n available.

\n
", + "smithy.api#documentation": "

Gets the current health status (Healthy, Unhealthy, or\n Unknown) of one or more instances that are associated with a specified\n service.

\n \n

There's a brief delay between when you register an instance and when the health status for\n the instance is available.

\n
", "smithy.api#examples": [ { "title": "GetInstancesHealthStatus example", @@ -1305,6 +1488,19 @@ "i-abcd1235": "UNHEALTHY" } } + }, + { + "title": "Get instances health status using service ARN for shared namespace", + "documentation": "This example gets the current health status of instances using a service ARN instead of service ID. This is useful for checking health status of instances associated with shared namespaces.", + "input": { + "ServiceId": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004" + }, + "output": { + "Status": { + "i-abcd1234": "HEALTHY", + "i-abcd1235": "UNHEALTHY" + } + } } ], "smithy.api#paginated": { @@ -1318,28 +1514,28 @@ "type": "structure", "members": { "ServiceId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the service that the instance is associated with.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the service that the instance is associated with. For services\n created in a shared namespace, specify the service ARN. For more information about shared\n namespaces, see Cross-account Cloud Map namespace sharing in the\n Cloud Map Developer Guide.

", "smithy.api#required": {} } }, "Instances": { "target": "com.amazonaws.servicediscovery#InstanceIdList", "traits": { - "smithy.api#documentation": "

An array that contains the IDs of all the instances that you want to get the health status for.

\n

If you omit Instances, Cloud Map returns the health status for all the instances that are\n associated with the specified service.

\n \n

To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.

\n
" + "smithy.api#documentation": "

An array that contains the IDs of all the instances that you want to get the health status\n for.

\n

If you omit Instances, Cloud Map returns the health status for all the\n instances that are associated with the specified service.

\n \n

To get the IDs for the instances that you've registered by using a specified service,\n submit a ListInstances request.

\n
" } }, "MaxResults": { "target": "com.amazonaws.servicediscovery#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of instances that you want Cloud Map to return in the response to a\n GetInstancesHealthStatus request. If you don't specify a value for MaxResults,\n Cloud Map returns up to 100 instances.

" + "smithy.api#documentation": "

The maximum number of instances that you want Cloud Map to return in the response to a\n GetInstancesHealthStatus request. If you don't specify a value for\n MaxResults, Cloud Map returns up to 100 instances.

" } }, "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

For the first GetInstancesHealthStatus request, omit this value.

\n

If more than MaxResults instances match the specified criteria, you can submit another\n GetInstancesHealthStatus request to get the next group of results. Specify the value of\n NextToken from the previous response in the next request.

" + "smithy.api#documentation": "

For the first GetInstancesHealthStatus request, omit this value.

\n

If more than MaxResults instances match the specified criteria, you can submit\n another GetInstancesHealthStatus request to get the next group of results. Specify\n the value of NextToken from the previous response in the next request.

" } } }, @@ -1353,13 +1549,13 @@ "Status": { "target": "com.amazonaws.servicediscovery#InstanceHealthStatusMap", "traits": { - "smithy.api#documentation": "

A complex type that contains the IDs and the health status of the instances that you specified in the\n GetInstancesHealthStatus request.

" + "smithy.api#documentation": "

A complex type that contains the IDs and the health status of the instances that you\n specified in the GetInstancesHealthStatus request.

" } }, "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

If more than MaxResults instances match the specified criteria, you can submit another\n GetInstancesHealthStatus request to get the next group of results. Specify the value of\n NextToken from the previous response in the next request.

" + "smithy.api#documentation": "

If more than MaxResults instances match the specified criteria, you can submit\n another GetInstancesHealthStatus request to get the next group of results. Specify\n the value of NextToken from the previous response in the next request.

" } } }, @@ -1391,9 +1587,9 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the namespace that you want to get information about.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the namespace that you want to get information about. For namespaces\n shared with your Amazon Web Services account, specify the namespace ARN. For more information about shared\n namespaces, see Cross-account Cloud Map namespace sharing in the\n Cloud Map Developer Guide\n

", "smithy.api#required": {} } } @@ -1461,11 +1657,17 @@ "type": "structure", "members": { "OperationId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#OperationId", "traits": { "smithy.api#documentation": "

The ID of the operation that you want to get more information about.

", "smithy.api#required": {} } + }, + "OwnerAccount": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the namespace associated with the operation, as specified in the namespace ResourceOwner field. For\n operations associated with namespaces that are shared with your account, you must specify an OwnerAccount.

" + } } }, "traits": { @@ -1503,7 +1705,41 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the settings for a specified service.

" + "smithy.api#documentation": "

Gets the settings for a specified service.

", + "smithy.api#examples": [ + { + "title": "Get service using service ARN", + "documentation": "Gets service settings using a service ARN instead of service ID, useful when working with shared namespaces. Shows a service created by a sharee (111122223333) in a namespace owned by another account (123456789012).", + "input": { + "Id": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678" + }, + "output": { + "Service": { + "Id": "srv-abcd1234xmpl5678", + "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", + "ResourceOwner": "123456789012", + "Name": "example-service", + "NamespaceId": "ns-abcd1234xmpl5678", + "Description": "Example service", + "InstanceCount": 2, + "DnsConfig": { + "NamespaceId": "ns-abcd1234xmpl5678", + "RoutingPolicy": "MULTIVALUE", + "DnsRecords": [ + { + "Type": "A", + "TTL": 300 + } + ] + }, + "Type": "DNS_HTTP", + "CreateDate": 1.7051616E9, + "CreatorRequestId": "abcd1234-xmpl-5678-9012-abcd1234xmpl", + "CreatedByAccount": "111122223333" + } + } + } + ] } }, "com.amazonaws.servicediscovery#GetServiceAttributes": { @@ -1525,6 +1761,22 @@ "traits": { "smithy.api#documentation": "

Returns the attributes associated with a specified service.

", "smithy.api#examples": [ + { + "title": "Get service attributes using service ARN", + "documentation": "Gets service attributes using a service ARN instead of service ID, useful when working with shared namespaces. Shows attributes for a service created by a sharee in a namespace owned by another account.", + "input": { + "ServiceId": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678" + }, + "output": { + "ServiceAttributes": { + "ServiceArn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", + "Attributes": { + "Port": "80" + }, + "ResourceOwner": "123456789012" + } + } + }, { "title": "GetServiceAttributes Example", "documentation": "This example gets the attributes for a specified service.", @@ -1533,10 +1785,11 @@ }, "output": { "ServiceAttributes": { + "ServiceArn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004", "Attributes": { "port": "80" }, - "ServiceArn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004" + "ResourceOwner": "123456789012" } } } @@ -1547,9 +1800,9 @@ "type": "structure", "members": { "ServiceId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the service that you want to get attributes for.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the service that you want to get attributes for. For services created\n in a namespace shared with your Amazon Web Services account, specify the service ARN. For more information\n about shared namespaces, see Cross-account Cloud Map namespace sharing in the\n Cloud Map Developer Guide.

", "smithy.api#required": {} } } @@ -1564,7 +1817,7 @@ "ServiceAttributes": { "target": "com.amazonaws.servicediscovery#ServiceAttributes", "traits": { - "smithy.api#documentation": "

A complex type that contains the service ARN and a list of attribute key-value pairs associated with the service.

" + "smithy.api#documentation": "

A complex type that contains the service ARN and a list of attribute key-value pairs\n associated with the service.

" } } }, @@ -1576,9 +1829,9 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the service that you want to get settings for.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the service that you want to get settings for. For services created\n by consumers in a shared namespace, specify the service ARN. For more information about shared\n namespaces, see Cross-account Cloud Map namespace sharing in the\n Cloud Map Developer Guide.

", "smithy.api#required": {} } } @@ -1607,25 +1860,25 @@ "Type": { "target": "com.amazonaws.servicediscovery#HealthCheckType", "traits": { - "smithy.api#documentation": "

The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint\n is healthy.

\n \n

You can't change the value of Type after you create a health check.

\n
\n

You can create the following types of health checks:

\n
    \n
  • \n

    \n HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53\n submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

    \n
  • \n
  • \n

    \n HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53\n submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

    \n \n

    If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or\n later.

    \n
    \n
  • \n
  • \n

    \n TCP: Route 53 tries to establish a TCP connection.

    \n

    If you specify TCP for Type, don't specify a value for\n ResourcePath.

    \n
  • \n
\n

For more information, see How Route 53 Determines\n Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

", + "smithy.api#documentation": "

The type of health check that you want to create, which indicates how Route 53 determines\n whether an endpoint is healthy.

\n \n

You can't change the value of Type after you create a health check.

\n
\n

You can create the following types of health checks:

\n
    \n
  • \n

    \n HTTP: Route 53 tries to establish a TCP connection. If\n successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater\n and less than 400.

    \n
  • \n
  • \n

    \n HTTPS: Route 53 tries to establish a TCP connection. If\n successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater\n and less than 400.

    \n \n

    If you specify HTTPS for the value of Type, the endpoint must support TLS\n v1.0 or later.

    \n
    \n
  • \n
  • \n

    \n TCP: Route 53 tries to establish a TCP connection.

    \n

    If you specify TCP for Type, don't specify a value for\n ResourcePath.

    \n
  • \n
\n

For more information, see How Route 53\n Determines Whether an Endpoint Is Healthy in the\n Route 53 Developer Guide.

", "smithy.api#required": {} } }, "ResourcePath": { "target": "com.amazonaws.servicediscovery#ResourcePath", "traits": { - "smithy.api#documentation": "

The path that you want Route 53 to request when performing health checks. The path can be any value that your\n endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is\n /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you\n don't specify a value for ResourcePath, the default value is /.

\n

If you specify TCP for Type, you must not specify a value\n for ResourcePath.

" + "smithy.api#documentation": "

The path that you want Route 53 to request when performing health checks. The path can be any\n value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint\n is healthy. An example file is /docs/route53-health-check.html. Route 53 automatically\n adds the DNS name for the service. If you don't specify a value for ResourcePath,\n the default value is /.

\n

If you specify TCP for Type, you must not\n specify a value for ResourcePath.

" } }, "FailureThreshold": { "target": "com.amazonaws.servicediscovery#FailureThreshold", "traits": { - "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current\n status of the endpoint from unhealthy to healthy or the other way around. For more information, see How\n Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

" + "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Route 53 to\n change the current status of the endpoint from unhealthy to healthy or the other way around. For\n more information, see How Route 53\n Determines Whether an Endpoint Is Healthy in the\n Route 53 Developer Guide.

" } } }, "traits": { - "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. A complex type that contains settings for an\n optional health check. If you specify settings for a health check, Cloud Map associates the health check with\n the records that you specify in DnsConfig.

\n \n

If you specify a health check configuration, you can specify either HealthCheckCustomConfig\n or HealthCheckConfig but not both.

\n
\n

Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information\n about pricing for health checks, see Amazon Route 53\n Pricing.

\n

Note the following about configuring health checks.

\n
\n
A and AAAA records
\n
\n

If DnsConfig includes configurations for both A and AAAA records,\n Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the\n endpoint tthat's specified by the IPv4 address is unhealthy, Route 53 considers both the A and\n AAAA records to be unhealthy.

\n
\n
CNAME records
\n
\n

You can't specify settings for HealthCheckConfig when the DNSConfig includes\n CNAME for the value of Type. If you do, the CreateService request\n will fail with an InvalidInput error.

\n
\n
Request interval
\n
\n

A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request to an endpoint\n every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However,\n health checkers don't coordinate with one another. Therefore, you might sometimes see several requests in one\n second that's followed by a few seconds with no health checks at all.

\n
\n
Health checking regions
\n
\n

Health checkers perform checks from all Route 53 health-checking Regions. For a list of the current\n Regions, see Regions.

\n
\n
Alias records
\n
\n

When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, Cloud Map\n creates a Route 53 alias record. Note the following:

\n
    \n
  • \n

    Route 53 automatically sets EvaluateTargetHealth to true for alias records. When\n EvaluateTargetHealth is true, the alias record inherits the health of the referenced Amazon Web Services\n resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.

    \n
  • \n
  • \n

    If you include HealthCheckConfig and then use the service to register an instance that\n creates an alias record, Route 53 doesn't create the health check.

    \n
  • \n
\n
\n
Charges for health checks
\n
\n

Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about\n pricing for health checks, see Amazon Route 53\n Pricing.

\n
\n
" + "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. A complex type that contains\n settings for an optional health check. If you specify settings for a health check, Cloud Map\n associates the health check with the records that you specify in DnsConfig.

\n \n

If you specify a health check configuration, you can specify either\n HealthCheckCustomConfig or HealthCheckConfig but not both.

\n
\n

Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For\n information about pricing for health checks, see Amazon Route 53 Pricing.

\n

Note the following about configuring health checks.

\n
\n
A and AAAA records
\n
\n

If DnsConfig includes configurations for both A and\n AAAA records, Cloud Map creates a health check that uses the IPv4 address to\n check the health of the resource. If the endpoint tthat's specified by the IPv4 address is\n unhealthy, Route 53 considers both the A and AAAA records to be\n unhealthy.

\n
\n
CNAME records
\n
\n

You can't specify settings for HealthCheckConfig when the\n DNSConfig includes CNAME for the value of Type. If you\n do, the CreateService request will fail with an InvalidInput\n error.

\n
\n
Request interval
\n
\n

A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request\n to an endpoint every 30 seconds. On average, your endpoint receives a health check request\n about every two seconds. However, health checkers don't coordinate with one another.\n Therefore, you might sometimes see several requests in one second that's followed by a few\n seconds with no health checks at all.

\n
\n
Health checking regions
\n
\n

Health checkers perform checks from all Route 53 health-checking Regions. For a list of the\n current Regions, see Regions.

\n
\n
Alias records
\n
\n

When you register an instance, if you include the AWS_ALIAS_DNS_NAME\n attribute, Cloud Map creates a Route 53 alias record. Note the following:

\n
    \n
  • \n

    Route 53 automatically sets EvaluateTargetHealth to true for alias records.\n When EvaluateTargetHealth is true, the alias record inherits the health of the\n referenced Amazon Web Services resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.

    \n
  • \n
  • \n

    If you include HealthCheckConfig and then use the service to register an\n instance that creates an alias record, Route 53 doesn't create the health check.

    \n
  • \n
\n
\n
Charges for health checks
\n
\n

Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For\n information about pricing for health checks, see Amazon Route 53 Pricing.

\n
\n
" } }, "com.amazonaws.servicediscovery#HealthCheckCustomConfig": { @@ -1637,12 +1890,12 @@ "smithy.api#deprecated": { "message": "Configurable FailureThreshold of HealthCheckCustomConfig is deprecated. It will always have value 1." }, - "smithy.api#documentation": "\n

This parameter is no longer supported and is always set to 1. Cloud Map waits for approximately 30 seconds\n after receiving an UpdateInstanceCustomHealthStatus request before changing the status of the\n service instance.

\n
\n

The number of 30-second intervals that you want Cloud Map to wait after receiving an\n UpdateInstanceCustomHealthStatus request before it changes the health status of a service\n instance.

\n

Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value\n before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits 30 seconds after the\n first request to make the change.

" + "smithy.api#documentation": "\n

This parameter is no longer supported and is always set to 1. Cloud Map waits for\n approximately 30 seconds after receiving an UpdateInstanceCustomHealthStatus\n request before changing the status of the service instance.

\n
\n

The number of 30-second intervals that you want Cloud Map to wait after receiving an\n UpdateInstanceCustomHealthStatus request before it changes the health status of a\n service instance.

\n

Sending a second or subsequent UpdateInstanceCustomHealthStatus request with\n the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits\n 30 seconds after the first request to make the change.

" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about an optional custom health check. A custom health check,\n which requires that you use a third-party health checker to evaluate the health of your resources, is useful in\n the following circumstances:

\n
    \n
  • \n

    You can't use a health check that's defined by HealthCheckConfig because the resource isn't\n available over the internet. For example, you can use a custom health check when the instance is in an Amazon\n VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)

    \n
  • \n
  • \n

    You want to use a third-party health checker regardless of where your resources are located.

    \n
  • \n
\n \n

If you specify a health check configuration, you can specify either HealthCheckCustomConfig\n or HealthCheckConfig but not both.

\n
\n

To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus\n request. Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in\n the most recent UpdateInstanceCustomHealthStatus request.

\n

Here's how custom health checks work:

\n
    \n
  1. \n

    You create a service.

    \n
  2. \n
  3. \n

    You register an instance.

    \n
  4. \n
  5. \n

    You configure a third-party health checker to monitor the resource that's associated with the new\n instance.

    \n \n

    Cloud Map doesn't check the health of the resource directly.

    \n
    \n
  6. \n
  7. \n

    The third-party health-checker determines that the resource is unhealthy and notifies your\n application.

    \n
  8. \n
  9. \n

    Your application submits an UpdateInstanceCustomHealthStatus request.

    \n
  10. \n
  11. \n

    Cloud Map waits for 30 seconds.

    \n
  12. \n
  13. \n

    If another UpdateInstanceCustomHealthStatus request doesn't arrive during that time to\n change the status back to healthy, Cloud Map stops routing traffic to the resource.

    \n
  14. \n
" + "smithy.api#documentation": "

A complex type that contains information about an optional custom health check. A custom\n health check, which requires that you use a third-party health checker to evaluate the health of\n your resources, is useful in the following circumstances:

\n
    \n
  • \n

    You can't use a health check that's defined by HealthCheckConfig because the\n resource isn't available over the internet. For example, you can use a custom health check when\n the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health\n checker must also be in the VPC.)

    \n
  • \n
  • \n

    You want to use a third-party health checker regardless of where your resources are\n located.

    \n
  • \n
\n \n

If you specify a health check configuration, you can specify either\n HealthCheckCustomConfig or HealthCheckConfig but not both.

\n
\n

To change the status of a custom health check, submit an\n UpdateInstanceCustomHealthStatus request. Cloud Map doesn't monitor the status of the\n resource, it just keeps a record of the status specified in the most recent\n UpdateInstanceCustomHealthStatus request.

\n

Here's how custom health checks work:

\n
    \n
  1. \n

    You create a service.

    \n
  2. \n
  3. \n

    You register an instance.

    \n
  4. \n
  5. \n

    You configure a third-party health checker to monitor the resource that's associated with\n the new instance.

    \n \n

    Cloud Map doesn't check the health of the resource directly.

    \n
    \n
  6. \n
  7. \n

    The third-party health-checker determines that the resource is unhealthy and notifies your\n application.

    \n
  8. \n
  9. \n

    Your application submits an UpdateInstanceCustomHealthStatus request.

    \n
  10. \n
  11. \n

    Cloud Map waits for 30 seconds.

    \n
  12. \n
  13. \n

    If another UpdateInstanceCustomHealthStatus request doesn't arrive during\n that time to change the status back to healthy, Cloud Map stops routing traffic to the\n resource.

    \n
  14. \n
" } }, "com.amazonaws.servicediscovery#HealthCheckType": { @@ -1732,7 +1985,7 @@ "NamespaceName": { "target": "com.amazonaws.servicediscovery#NamespaceNameHttp", "traits": { - "smithy.api#documentation": "

\n \n \n \n

\n

The HttpName name of the namespace. It's found in the HttpProperties member of\n the Properties member of the namespace.

" + "smithy.api#documentation": "

The HttpName name of the namespace. It's found in the\n HttpProperties member of the Properties member of the\n namespace.

" } }, "ServiceName": { @@ -1744,18 +1997,18 @@ "HealthStatus": { "target": "com.amazonaws.servicediscovery#HealthStatus", "traits": { - "smithy.api#documentation": "

If you configured health checking in the service, the current health status of the service instance.

" + "smithy.api#documentation": "

If you configured health checking in the service, the current health status of the service\n instance.

" } }, "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "

If you included any attributes when you registered the instance, the values of those attributes.

" + "smithy.api#documentation": "

If you included any attributes when you registered the instance, the values of those\n attributes.

" } } }, "traits": { - "smithy.api#documentation": "

In a response to a DiscoverInstances request, HttpInstanceSummary contains information about one instance\n that matches the values that you specified in the request.

" + "smithy.api#documentation": "

In a response to a DiscoverInstances request,\n HttpInstanceSummary contains information about one instance that matches the values\n that you specified in the request.

" } }, "com.amazonaws.servicediscovery#HttpInstanceSummaryList": { @@ -1770,13 +2023,13 @@ "Description": { "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { - "smithy.api#documentation": "

An updated description for the HTTP\n namespace.

", + "smithy.api#documentation": "

An updated\n description for the HTTP namespace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Updated properties for the HTTP\n namespace.

" + "smithy.api#documentation": "

Updated properties\n for the HTTP namespace.

" } }, "com.amazonaws.servicediscovery#HttpProperties": { @@ -1799,25 +2052,31 @@ "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

An identifier that you want to associate with the instance. Note the following:

\n
    \n
  • \n

    If the service that's specified by ServiceId includes settings for an SRV\n record, the value of InstanceId is automatically included as part of the value for the\n SRV record. For more information, see DnsRecord > Type.

    \n
  • \n
  • \n

    You can use this value to update an existing instance.

    \n
  • \n
  • \n

    To register a new instance, you must specify a value that's unique among instances that you register by\n using the same service.

    \n
  • \n
  • \n

    If you specify an existing InstanceId and ServiceId, Cloud Map updates the\n existing DNS records. If there's also an existing health check, Cloud Map deletes the old health check and\n creates a new one.

    \n \n

    The health check isn't deleted immediately, so it will still appear for a while if you submit a\n ListHealthChecks request, for example.

    \n
    \n
  • \n
", + "smithy.api#documentation": "

An identifier that you want to associate with the instance. Note the following:

\n
    \n
  • \n

    If the service that's specified by ServiceId includes settings for an\n SRV record, the value of InstanceId is automatically included as\n part of the value for the SRV record. For more information, see DnsRecord >\n Type.

    \n
  • \n
  • \n

    You can use this value to update an existing instance.

    \n
  • \n
  • \n

    To register a new instance, you must specify a value that's unique among instances that\n you register by using the same service.

    \n
  • \n
  • \n

    If you specify an existing InstanceId and ServiceId, Cloud Map\n updates the existing DNS records. If there's also an existing health check, Cloud Map deletes\n the old health check and creates a new one.

    \n \n

    The health check isn't deleted immediately, so it will still appear for a while if you\n submit a ListHealthChecks request, for example.

    \n
    \n
  • \n
", "smithy.api#required": {} } }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows failed RegisterInstance requests\n to be retried without the risk of executing the operation twice. You must use a unique\n CreatorRequestId string every time you submit a RegisterInstance request if you're\n registering additional instances for the same namespace and service. CreatorRequestId can be any\n unique string (for example, a date/time stamp).

" + "smithy.api#documentation": "

A unique string that identifies the request and that allows failed\n RegisterInstance requests to be retried without the risk of executing the operation\n twice. You must use a unique CreatorRequestId string every time you submit a\n RegisterInstance request if you're registering additional instances for the same\n namespace and service. CreatorRequestId can be any unique string (for example, a\n date/time stamp).

" } }, "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "

A string map that contains the following information for the service that you specify in\n ServiceId:

\n
    \n
  • \n

    The attributes that apply to the records that are defined in the service.

    \n
  • \n
  • \n

    For each attribute, the applicable value.

    \n
  • \n
\n \n

Do not include sensitive information in the attributes if the namespace is discoverable by public DNS\n queries.

\n
\n

Supported attribute keys include the following:

\n
\n
AWS_ALIAS_DNS_NAME
\n
\n

If you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer,\n specify the DNS name that's associated with the load balancer. For information about how to get the DNS name,\n see AliasTarget->DNSName in the Route 53 API Reference.

\n

Note the following:

\n
    \n
  • \n

    The configuration for the service that's specified by ServiceId must include settings for\n an A record, an AAAA record, or both.

    \n
  • \n
  • \n

    In the service that's specified by ServiceId, the value of RoutingPolicy\n must be WEIGHTED.

    \n
  • \n
  • \n

    If the service that's specified by ServiceId includes HealthCheckConfig\n settings, Cloud Map creates the health check, but it won't associate the health check with the alias\n record.

    \n
  • \n
  • \n

    Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services resources\n other than ELB load balancers.

    \n
  • \n
  • \n

    If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the\n AWS_INSTANCE attributes.

    \n
  • \n
\n
\n
AWS_EC2_INSTANCE_ID
\n
\n

\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. The\n AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

\n
\n
AWS_INIT_HEALTH_STATUS
\n
\n

If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

\n
\n
AWS_INSTANCE_CNAME
\n
\n

If the service configuration includes a CNAME record, the domain name that you want Route 53\n to return in response to DNS queries (for example, example.com).

\n

This value is required if the service specified by ServiceId includes settings for an\n CNAME record.

\n
\n
AWS_INSTANCE_IPV4
\n
\n

If the service configuration includes an A record, the IPv4 address that you want Route 53 to\n return in response to DNS queries (for example, 192.0.2.44).

\n

This value is required if the service specified by ServiceId includes settings for an\n A record. If the service includes settings for an SRV record, you must specify a\n value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_IPV6
\n
\n

If the service configuration includes an AAAA record, the IPv6 address that you want Route 53\n to return in response to DNS queries (for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345).

\n

This value is required if the service specified by ServiceId includes settings for an\n AAAA record. If the service includes settings for an SRV record, you must specify\n a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_PORT
\n
\n

If the service includes an SRV record, the value that you want Route 53 to return for the\n port.

\n

If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to\n send requests to.

\n

This value is required if you specified settings for an SRV record or a Route 53 health check\n when you created the service.

\n
\n
" + "smithy.api#documentation": "

A string map that contains the following information for the service that you specify in\n ServiceId:

\n
    \n
  • \n

    The attributes that apply to the records that are defined in the service.

    \n
  • \n
  • \n

    For each attribute, the applicable value.

    \n
  • \n
\n \n

Do not include sensitive information in the attributes if the namespace is discoverable by\n public DNS queries.

\n
\n

Supported attribute keys include the following:

\n
\n
AWS_ALIAS_DNS_NAME
\n
\n

If you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing\n load balancer, specify the DNS name that's associated with the load balancer. For information\n about how to get the DNS name, see AliasTarget->DNSName in the Route 53 API Reference.

\n

Note the following:

\n
    \n
  • \n

    The configuration for the service that's specified by ServiceId must\n include settings for an A record, an AAAA record, or both.

    \n
  • \n
  • \n

    In the service that's specified by ServiceId, the value of\n RoutingPolicy must be WEIGHTED.

    \n
  • \n
  • \n

    If the service that's specified by ServiceId includes\n HealthCheckConfig settings, Cloud Map creates the health check, but it won't\n associate the health check with the alias record.

    \n
  • \n
  • \n

    Auto naming currently doesn't support creating alias records that route traffic to\n Amazon Web Services resources other than ELB load balancers.

    \n
  • \n
  • \n

    If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for\n any of the AWS_INSTANCE attributes.

    \n
  • \n
\n
\n
AWS_EC2_INSTANCE_ID
\n
\n

\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. The\n AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

\n
\n
AWS_INIT_HEALTH_STATUS
\n
\n

If the service configuration includes HealthCheckCustomConfig, you can\n optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom\n health check, HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

\n
\n
AWS_INSTANCE_CNAME
\n
\n

If the service configuration includes a CNAME record, the domain name that\n you want Route 53 to return in response to DNS queries (for example,\n example.com).

\n

This value is required if the service specified by ServiceId includes\n settings for an CNAME record.

\n
\n
AWS_INSTANCE_IPV4
\n
\n

If the service configuration includes an A record, the IPv4 address that you\n want Route 53 to return in response to DNS queries (for example, 192.0.2.44).

\n

This value is required if the service specified by ServiceId includes\n settings for an A record. If the service includes settings for an\n SRV record, you must specify a value for AWS_INSTANCE_IPV4,\n AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_IPV6
\n
\n

If the service configuration includes an AAAA record, the IPv6 address that\n you want Route 53 to return in response to DNS queries (for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345).

\n

This value is required if the service specified by ServiceId includes\n settings for an AAAA record. If the service includes settings for an\n SRV record, you must specify a value for AWS_INSTANCE_IPV4,\n AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_PORT
\n
\n

If the service includes an SRV record, the value that you want Route 53 to\n return for the port.

\n

If the service includes HealthCheckConfig, the port on the endpoint that you\n want Route 53 to send requests to.

\n

This value is required if you specified settings for an SRV record or a\n Route 53 health check when you created the service.

\n
\n
" + } + }, + "CreatedByAccount": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that registered the instance. If this isn't your account ID,\n it's the ID of the account that shared the namespace with your account or the ID of another\n account with which the namespace has been shared. For more information about shared namespaces,\n see Cross-account\n Cloud Map namespace sharing in the Cloud Map Developer Guide.

" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about an instance that Cloud Map creates when you submit a\n RegisterInstance request.

" + "smithy.api#documentation": "

A complex type that contains information about an instance that Cloud Map creates when you\n submit a RegisterInstance request.

" } }, "com.amazonaws.servicediscovery#InstanceHealthStatusMap": { @@ -1861,7 +2120,7 @@ } }, "traits": { - "smithy.api#documentation": "

No instance exists with the specified ID, or the instance was recently registered, and information about\n the instance hasn't propagated yet.

", + "smithy.api#documentation": "

No instance exists with the specified ID, or the instance was recently registered, and\n information about the instance hasn't propagated yet.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1878,12 +2137,18 @@ "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "

A string map that contains the following information:

\n
    \n
  • \n

    The attributes that are associated with the instance.

    \n
  • \n
  • \n

    For each attribute, the applicable value.

    \n
  • \n
\n

Supported attribute keys include the following:

\n
\n
AWS_ALIAS_DNS_NAME
\n
\n

For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with\n the load balancer.

\n
\n
AWS_EC2_INSTANCE_ID (HTTP namespaces only)
\n
\n

The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is\n specified, then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4\n address.

\n
\n
AWS_INIT_HEALTH_STATUS
\n
\n

If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

\n
\n
AWS_INSTANCE_CNAME
\n
\n

For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for\n example, example.com).

\n
\n
AWS_INSTANCE_IPV4
\n
\n

For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for\n example, 192.0.2.44).

\n
\n
AWS_INSTANCE_IPV6
\n
\n

For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for\n example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).

\n
\n
AWS_INSTANCE_PORT
\n
\n

For an SRV record, the value that Route 53 returns for the port. In addition, if the service\n includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.

\n
\n
" + "smithy.api#documentation": "

A string map that contains the following information:

\n
    \n
  • \n

    The attributes that are associated with the instance.

    \n
  • \n
  • \n

    For each attribute, the applicable value.

    \n
  • \n
\n

Supported attribute keys include the following:

\n
\n
AWS_ALIAS_DNS_NAME
\n
\n

For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's\n associated with the load balancer.

\n
\n
AWS_EC2_INSTANCE_ID (HTTP namespaces only)
\n
\n

The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID\n attribute is specified, then the AWS_INSTANCE_IPV4 attribute contains the primary\n private IPv4 address.

\n
\n
AWS_INIT_HEALTH_STATUS
\n
\n

If the service configuration includes HealthCheckCustomConfig, you can\n optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom\n health check, HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

\n
\n
AWS_INSTANCE_CNAME
\n
\n

For a CNAME record, the domain name that Route 53 returns in response to DNS\n queries (for example, example.com).

\n
\n
AWS_INSTANCE_IPV4
\n
\n

For an A record, the IPv4 address that Route 53 returns in response to DNS\n queries (for example, 192.0.2.44).

\n
\n
AWS_INSTANCE_IPV6
\n
\n

For an AAAA record, the IPv6 address that Route 53 returns in response to DNS\n queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).

\n
\n
AWS_INSTANCE_PORT
\n
\n

For an SRV record, the value that Route 53 returns for the port. In addition,\n if the service includes HealthCheckConfig, the port on the endpoint that Route 53\n sends requests to.

\n
\n
" + } + }, + "CreatedByAccount": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that registered the instance. If this isn't your account ID,\n it's the ID of the account that shared the namespace with your account or the ID of another\n account with which the namespace has been shared. For more information about shared namespaces,\n see Cross-account\n Cloud Map namespace sharing in the Cloud Map Developer Guide.

" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the instances that you registered by using a specified\n service.

" + "smithy.api#documentation": "

A complex type that contains information about the instances that you registered by using a\n specified service.

" } }, "com.amazonaws.servicediscovery#InstanceSummaryList": { @@ -1903,7 +2168,7 @@ } }, "traits": { - "smithy.api#documentation": "

One or more specified values aren't valid. For example, a required value might be missing, a numeric value\n might be outside the allowed range, or a string value might exceed length constraints.

", + "smithy.api#documentation": "

One or more specified values aren't valid. For example, a required value might be missing, a\n numeric value might be outside the allowed range, or a string value might exceed length\n constraints.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1925,7 +2190,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists summary information about the instances that you registered by using a specified service.

", + "smithy.api#documentation": "

Lists summary information about the instances that you registered by using a specified\n service.

", "smithy.api#examples": [ { "title": "Example: List service instances", @@ -1944,6 +2209,25 @@ } ] } + }, + { + "title": "List instances using service ARN for shared namespace", + "documentation": "This example lists instances using a service ARN instead of service ID. This is useful for listing instances associated with shared namespaces.", + "input": { + "ServiceId": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004" + }, + "output": { + "Instances": [ + { + "Id": "i-abcd1234", + "Attributes": { + "AWS_INSTANCE_IPV4": "192.0.2.44", + "AWS_INSTANCE_PORT": "80" + } + } + ], + "ResourceOwner": "123456789012" + } } ], "smithy.api#paginated": { @@ -1957,22 +2241,22 @@ "type": "structure", "members": { "ServiceId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the service that you want to list instances for.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the service that you want to list instances for. For services created\n in a shared namespace, specify the service ARN. For more information about shared namespaces,\n see Cross-account\n Cloud Map namespace sharing in the Cloud Map Developer Guide.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

For the first ListInstances request, omit this value.

\n

If more than MaxResults instances match the specified criteria, you can submit another\n ListInstances request to get the next group of results. Specify the value of\n NextToken from the previous response in the next request.

" + "smithy.api#documentation": "

For the first ListInstances request, omit this value.

\n

If more than MaxResults instances match the specified criteria, you can submit\n another ListInstances request to get the next group of results. Specify the value of\n NextToken from the previous response in the next request.

" } }, "MaxResults": { "target": "com.amazonaws.servicediscovery#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of instances that you want Cloud Map to return in the response to a\n ListInstances request. If you don't specify a value for MaxResults, Cloud Map\n returns up to 100 instances.

" + "smithy.api#documentation": "

The maximum number of instances that you want Cloud Map to return in the response to a\n ListInstances request. If you don't specify a value for MaxResults,\n Cloud Map returns up to 100 instances.

" } } }, @@ -1983,16 +2267,22 @@ "com.amazonaws.servicediscovery#ListInstancesResponse": { "type": "structure", "members": { + "ResourceOwner": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that created the namespace that contains the specified service.\n If this isn't your account ID, it's the ID of the account that shared the namespace with your\n account.

" + } + }, "Instances": { "target": "com.amazonaws.servicediscovery#InstanceSummaryList", "traits": { - "smithy.api#documentation": "

Summary information about the instances that are associated with the specified service.

" + "smithy.api#documentation": "

Summary information about the instances that are associated with the specified\n service.

" } }, "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

If more than MaxResults instances match the specified criteria, you can submit another\n ListInstances request to get the next group of results. Specify the value of\n NextToken from the previous response in the next request.

" + "smithy.api#documentation": "

If more than MaxResults instances match the specified criteria, you can submit\n another ListInstances request to get the next group of results. Specify the value of\n NextToken from the previous response in the next request.

" } } }, @@ -2014,7 +2304,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists summary information about the namespaces that were created by the current Amazon Web Services account.

", + "smithy.api#documentation": "

Lists summary information about the namespaces that were created by the current Amazon Web Services account and shared with the current Amazon Web Services account.

", "smithy.api#examples": [ { "title": "Example: List namespaces", @@ -2022,48 +2312,103 @@ "output": { "Namespaces": [ { - "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-a3ccy2e7e3a7rile", - "CreateDate": 1.585354387357E9, "Id": "ns-a3ccy2e7e3a7rile", + "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-a3ccy2e7e3a7rile", + "ResourceOwner": "123456789012", "Name": "local", + "Type": "DNS_PRIVATE", "Properties": { "DnsProperties": { - "HostedZoneId": "Z06752353VBUDTC32S84S" + "HostedZoneId": "Z06752353VBUDTC32S84S", + "SOA": { + "TTL": 60 + } }, "HttpProperties": { "HttpName": "local" } }, - "Type": "DNS_PRIVATE" + "CreateDate": 1.7051616E9, + "ServiceCount": 2 }, { - "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-pocfyjtrsmwtvcxx", - "CreateDate": 1.586468974698E9, - "Description": "My second namespace", "Id": "ns-pocfyjtrsmwtvcxx", + "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-pocfyjtrsmwtvcxx", + "ResourceOwner": "123456789012", "Name": "My-second-namespace", + "Type": "HTTP", + "Description": "My second namespace", "Properties": { - "DnsProperties": {}, + "DnsProperties": { + "SOA": { + "TTL": 60 + } + }, "HttpProperties": { "HttpName": "My-second-namespace" } }, - "Type": "HTTP" + "CreateDate": 1.7051616E9, + "ServiceCount": 1 }, { - "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-ylexjili4cdxy3xm", - "CreateDate": 1.587055896798E9, "Id": "ns-ylexjili4cdxy3xm", + "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-ylexjili4cdxy3xm", + "ResourceOwner": "123456789012", "Name": "example.com", + "Type": "DNS_PRIVATE", "Properties": { "DnsProperties": { - "HostedZoneId": "Z09983722P0QME1B3KC8I" + "HostedZoneId": "Z09983722P0QME1B3KC8I", + "SOA": { + "TTL": 60 + } }, "HttpProperties": { "HttpName": "example.com" } }, - "Type": "DNS_PRIVATE" + "CreateDate": 1.7051616E9, + "ServiceCount": 3 + } + ] + } + }, + { + "title": "List namespaces filtered by resource owner", + "documentation": "This example shows how to list namespaces that are shared with you from other AWS accounts using the RESOURCE_OWNER filter.", + "input": { + "Filters": [ + { + "Name": "RESOURCE_OWNER", + "Values": [ + "OTHER_ACCOUNTS" + ] + } + ] + }, + "output": { + "Namespaces": [ + { + "Id": "ns-abcd1234xmpl5678", + "Arn": "arn:aws:servicediscovery:us-west-2:111122223333:namespace/ns-abcd1234xmpl5678", + "ResourceOwner": "111122223333", + "Name": "example-namespace", + "Type": "DNS_PRIVATE", + "Description": "Example private DNS namespace", + "Properties": { + "DnsProperties": { + "HostedZoneId": "Z1D633PJN98FT9", + "SOA": { + "TTL": 60 + } + }, + "HttpProperties": { + "HttpName": "example-namespace" + } + }, + "CreateDate": 1.7051616E9, + "ServiceCount": 2 } ] } @@ -2082,13 +2427,13 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

For the first ListNamespaces request, omit this value.

\n

If the response contains NextToken, submit another ListNamespaces request to get\n the next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria.\n It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria\n but that subsequent groups of MaxResults namespaces do contain namespaces that match the\n criteria.

\n
" + "smithy.api#documentation": "

For the first ListNamespaces request, omit this value.

\n

If the response contains NextToken, submit another ListNamespaces\n request to get the next group of results. Specify the value of NextToken from the\n previous response in the next request.

\n \n

Cloud Map gets MaxResults namespaces and then filters them based on the\n specified criteria. It's possible that no namespaces in the first MaxResults\n namespaces matched the specified criteria but that subsequent groups of MaxResults\n namespaces do contain namespaces that match the criteria.

\n
" } }, "MaxResults": { "target": "com.amazonaws.servicediscovery#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of namespaces that you want Cloud Map to return in the response to a\n ListNamespaces request. If you don't specify a value for MaxResults, Cloud Map\n returns up to 100 namespaces.

" + "smithy.api#documentation": "

The maximum number of namespaces that you want Cloud Map to return in the response to a\n ListNamespaces request. If you don't specify a value for MaxResults,\n Cloud Map returns up to 100 namespaces.

" } }, "Filters": { @@ -2108,13 +2453,13 @@ "Namespaces": { "target": "com.amazonaws.servicediscovery#NamespaceSummariesList", "traits": { - "smithy.api#documentation": "

An array that contains one NamespaceSummary object for each namespace that matches the\n specified filter criteria.

" + "smithy.api#documentation": "

An array that contains one NamespaceSummary object for each namespace that\n matches the specified filter criteria.

" } }, "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

If the response contains NextToken, submit another ListNamespaces request to get\n the next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria.\n It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria\n but that subsequent groups of MaxResults namespaces do contain namespaces that match the\n criteria.

\n
" + "smithy.api#documentation": "

If the response contains NextToken, submit another ListNamespaces\n request to get the next group of results. Specify the value of NextToken from the\n previous response in the next request.

\n \n

Cloud Map gets MaxResults namespaces and then filters them based on the\n specified criteria. It's possible that no namespaces in the first MaxResults\n namespaces matched the specified criteria but that subsequent groups of MaxResults\n namespaces do contain namespaces that match the criteria.

\n
" } } }, @@ -2184,19 +2529,19 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

For the first ListOperations request, omit this value.

\n

If the response contains NextToken, submit another ListOperations request to get\n the next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

Cloud Map gets MaxResults operations and then filters them based on the specified criteria.\n It's possible that no operations in the first MaxResults operations matched the specified criteria\n but that subsequent groups of MaxResults operations do contain operations that match the\n criteria.

\n
" + "smithy.api#documentation": "

For the first ListOperations request, omit this value.

\n

If the response contains NextToken, submit another ListOperations\n request to get the next group of results. Specify the value of NextToken from the\n previous response in the next request.

\n \n

Cloud Map gets MaxResults operations and then filters them based on the\n specified criteria. It's possible that no operations in the first MaxResults\n operations matched the specified criteria but that subsequent groups of MaxResults\n operations do contain operations that match the criteria.

\n
" } }, "MaxResults": { "target": "com.amazonaws.servicediscovery#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of items that you want Cloud Map to return in the response to a\n ListOperations request. If you don't specify a value for MaxResults, Cloud Map\n returns up to 100 operations.

" + "smithy.api#documentation": "

The maximum number of items that you want Cloud Map to return in the response to a\n ListOperations request. If you don't specify a value for MaxResults,\n Cloud Map returns up to 100 operations.

" } }, "Filters": { "target": "com.amazonaws.servicediscovery#OperationFilters", "traits": { - "smithy.api#documentation": "

A complex type that contains specifications for the operations that you want to list, for example,\n operations that you started between a specified start date and end date.

\n

If you specify more than one filter, an operation must match all filters to be returned by\n ListOperations.

" + "smithy.api#documentation": "

A complex type that contains specifications for the operations that you want to list, for\n example, operations that you started between a specified start date and end date.

\n

If you specify more than one filter, an operation must match all filters to be returned by\n ListOperations.

" } } }, @@ -2216,7 +2561,7 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

If the response contains NextToken, submit another ListOperations request to get\n the next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

Cloud Map gets MaxResults operations and then filters them based on the specified criteria.\n It's possible that no operations in the first MaxResults operations matched the specified criteria\n but that subsequent groups of MaxResults operations do contain operations that match the\n criteria.

\n
" + "smithy.api#documentation": "

If the response contains NextToken, submit another ListOperations\n request to get the next group of results. Specify the value of NextToken from the\n previous response in the next request.

\n \n

Cloud Map gets MaxResults operations and then filters them based on the\n specified criteria. It's possible that no operations in the first MaxResults\n operations matched the specified criteria but that subsequent groups of MaxResults\n operations do contain operations that match the criteria.

\n
" } } }, @@ -2246,8 +2591,11 @@ "output": { "Services": [ { + "Id": "srv-p5zdwlg5uvvzjita", "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita", - "CreateDate": 1.587081768334E9, + "ResourceOwner": "123456789012", + "Name": "myservice", + "Type": "DNS", "DnsConfig": { "DnsRecords": [ { @@ -2257,8 +2605,8 @@ ], "RoutingPolicy": "MULTIVALUE" }, - "Id": "srv-p5zdwlg5uvvzjita", - "Name": "myservice" + "CreateDate": 1.587081768334E9, + "CreatedByAccount": "123456789012" } ] } @@ -2277,19 +2625,19 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

For the first ListServices request, omit this value.

\n

If the response contains NextToken, submit another ListServices request to get\n the next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

Cloud Map gets MaxResults services and then filters them based on the specified criteria.\n It's possible that no services in the first MaxResults services matched the specified criteria but\n that subsequent groups of MaxResults services do contain services that match the criteria.

\n
" + "smithy.api#documentation": "

For the first ListServices request, omit this value.

\n

If the response contains NextToken, submit another ListServices\n request to get the next group of results. Specify the value of NextToken from the\n previous response in the next request.

\n \n

Cloud Map gets MaxResults services and then filters them based on the\n specified criteria. It's possible that no services in the first MaxResults services\n matched the specified criteria but that subsequent groups of MaxResults services do\n contain services that match the criteria.

\n
" } }, "MaxResults": { "target": "com.amazonaws.servicediscovery#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of services that you want Cloud Map to return in the response to a\n ListServices request. If you don't specify a value for MaxResults, Cloud Map returns\n up to 100 services.

" + "smithy.api#documentation": "

The maximum number of services that you want Cloud Map to return in the response to a\n ListServices request. If you don't specify a value for MaxResults,\n Cloud Map returns up to 100 services.

" } }, "Filters": { "target": "com.amazonaws.servicediscovery#ServiceFilters", "traits": { - "smithy.api#documentation": "

A complex type that contains specifications for the namespaces that you want to list services for.

\n

If you specify more than one filter, an operation must match all filters to be returned by\n ListServices.

" + "smithy.api#documentation": "

A complex type that contains specifications for the namespaces that you want to list\n services for.

\n

If you specify more than one filter, an operation must match all filters to be returned by\n ListServices.

" } } }, @@ -2303,13 +2651,13 @@ "Services": { "target": "com.amazonaws.servicediscovery#ServiceSummariesList", "traits": { - "smithy.api#documentation": "

An array that contains one ServiceSummary object for each service that matches the specified\n filter criteria.

" + "smithy.api#documentation": "

An array that contains one ServiceSummary object for each service that matches\n the specified filter criteria.

" } }, "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

If the response contains NextToken, submit another ListServices request to get\n the next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

Cloud Map gets MaxResults services and then filters them based on the specified criteria.\n It's possible that no services in the first MaxResults services matched the specified criteria but\n that subsequent groups of MaxResults services do contain services that match the criteria.

\n
" + "smithy.api#documentation": "

If the response contains NextToken, submit another ListServices\n request to get the next group of results. Specify the value of NextToken from the\n previous response in the next request.

\n \n

Cloud Map gets MaxResults services and then filters them based on the\n specified criteria. It's possible that no services in the first MaxResults services\n matched the specified criteria but that subsequent groups of MaxResults services do\n contain services that match the criteria.

\n
" } } }, @@ -2414,6 +2762,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.

" } }, + "ResourceOwner": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's\n the ID of the account that shared the namespace with your account. For more information about\n shared namespaces, see Cross-account Cloud Map namespace sharing in the\n Cloud Map Developer Guide.

" + } + }, "Name": { "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { @@ -2423,7 +2777,7 @@ "Type": { "target": "com.amazonaws.servicediscovery#NamespaceType", "traits": { - "smithy.api#documentation": "

The type of the namespace. The methods for discovering instances depends on the value that you\n specify:

\n
\n
HTTP
\n
\n

Instances can be discovered only programmatically, using the Cloud Map DiscoverInstances\n API.

\n
\n
DNS_PUBLIC
\n
\n

Instances can be discovered using public DNS queries and using the DiscoverInstances\n API.

\n
\n
DNS_PRIVATE
\n
\n

Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances\n API.

\n
\n
" + "smithy.api#documentation": "

The type of the namespace. The methods for discovering instances depends on the value that\n you specify:

\n
\n
HTTP
\n
\n

Instances can be discovered only programmatically, using the Cloud Map\n DiscoverInstances API.

\n
\n
DNS_PUBLIC
\n
\n

Instances can be discovered using public DNS queries and using the\n DiscoverInstances API.

\n
\n
DNS_PRIVATE
\n
\n

Instances can be discovered using DNS queries in VPCs and using the\n DiscoverInstances API.

\n
\n
" } }, "Description": { @@ -2441,19 +2795,19 @@ "Properties": { "target": "com.amazonaws.servicediscovery#NamespaceProperties", "traits": { - "smithy.api#documentation": "

A complex type that contains information that's specific to the type of the namespace.

" + "smithy.api#documentation": "

A complex type that contains information that's specific to the type of the\n namespace.

" } }, "CreateDate": { "target": "com.amazonaws.servicediscovery#Timestamp", "traits": { - "smithy.api#documentation": "

The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The\n value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

" + "smithy.api#documentation": "

The date that the namespace was created, in Unix date/time format and Coordinated Universal\n Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows failed requests to be retried without the risk\n of running an operation twice.

" + "smithy.api#documentation": "

A unique string that identifies the request and that allows failed requests to be retried\n without the risk of running an operation twice.

" } } }, @@ -2492,26 +2846,26 @@ "Name": { "target": "com.amazonaws.servicediscovery#NamespaceFilterName", "traits": { - "smithy.api#documentation": "

Specify the namespaces that you want to get using one of the following.

\n
    \n
  • \n

    \n TYPE: Gets the namespaces of the specified type.

    \n
  • \n
  • \n

    \n NAME: Gets the namespaces with the specified name.

    \n
  • \n
  • \n

    \n HTTP_NAME: Gets the namespaces with the specified HTTP name.

    \n
  • \n
", + "smithy.api#documentation": "

Specify the namespaces that you want to get using one of the following.

\n
    \n
  • \n

    \n TYPE: Gets the namespaces of the specified type.

    \n
  • \n
  • \n

    \n NAME: Gets the namespaces with the specified name.

    \n
  • \n
  • \n

    \n HTTP_NAME: Gets the namespaces with the specified HTTP name.

    \n
  • \n
  • \n

    \n RESOURCE_OWNER: Gets the namespaces created by your Amazon Web Services account or by other\n accounts. This can be used to filter for shared namespaces. For more information about shared\n namespaces, see Cross-account Cloud Map namespace sharing in the\n Cloud Map Developer Guide.

    \n
  • \n
", "smithy.api#required": {} } }, "Values": { "target": "com.amazonaws.servicediscovery#FilterValues", "traits": { - "smithy.api#documentation": "

Specify the values that are applicable to the value that you specify for Name.

\n
    \n
  • \n

    \n TYPE: Specify HTTP, DNS_PUBLIC, or\n DNS_PRIVATE.

    \n
  • \n
  • \n

    \n NAME: Specify the name of the namespace, which is found in\n Namespace.Name.

    \n
  • \n
  • \n

    \n HTTP_NAME: Specify the HTTP name of the namespace, which is found in\n Namespace.Properties.HttpProperties.HttpName.

    \n
  • \n
", + "smithy.api#documentation": "

Specify the values that are applicable to the value that you specify for\n Name.

\n
    \n
  • \n

    \n TYPE: Specify HTTP, DNS_PUBLIC, or\n DNS_PRIVATE.

    \n
  • \n
  • \n

    \n NAME: Specify the name of the namespace, which is found in\n Namespace.Name.

    \n
  • \n
  • \n

    \n HTTP_NAME: Specify the HTTP name of the namespace, which is found in\n Namespace.Properties.HttpProperties.HttpName.

    \n
  • \n
  • \n

    \n RESOURCE_OWNER: Specify one of SELF or\n OTHER_ACCOUNTS. SELF can be used to filter namespaces created by you\n and OTHER_ACCOUNTS can be used to filter namespaces shared with you that were\n created by other accounts.

    \n
  • \n
", "smithy.api#required": {} } }, "Condition": { "target": "com.amazonaws.servicediscovery#FilterCondition", "traits": { - "smithy.api#documentation": "

Specify the operator that you want to use to determine whether a namespace matches the specified value.\n Valid values for Condition are one of the following.

\n
    \n
  • \n

    \n EQ: When you specify EQ for Condition, you can specify only one\n value. EQ is supported for TYPE, NAME, and HTTP_NAME.\n EQ is the default condition and can be omitted.

    \n
  • \n
  • \n

    \n BEGINS_WITH: When you specify BEGINS_WITH for Condition, you can\n specify only one value. BEGINS_WITH is supported for TYPE, NAME, and\n HTTP_NAME.

    \n
  • \n
" + "smithy.api#documentation": "

Specify the operator that you want to use to determine whether a namespace matches the\n specified value. Valid values for Condition are one of the following.

\n
    \n
  • \n

    \n EQ: When you specify EQ for Condition, you can\n specify only one value. EQ is supported for TYPE, NAME,\n RESOURCE_OWNER and HTTP_NAME. EQ is the default\n condition and can be omitted.

    \n
  • \n
  • \n

    \n BEGINS_WITH: When you specify BEGINS_WITH for\n Condition, you can specify only one value. BEGINS_WITH is supported\n for TYPE, NAME, and HTTP_NAME.

    \n
  • \n
" } } }, "traits": { - "smithy.api#documentation": "

A complex type that identifies the namespaces that you want to list. You can choose to list public or\n private namespaces.

" + "smithy.api#documentation": "

A complex type that identifies the namespaces that you want to list. You can choose to list\n public or private namespaces.

" } }, "com.amazonaws.servicediscovery#NamespaceFilterName": { @@ -2534,6 +2888,12 @@ "traits": { "smithy.api#enumValue": "HTTP_NAME" } + }, + "RESOURCE_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_OWNER" + } } } }, @@ -2563,7 +2923,7 @@ "min": 0, "max": 1024 }, - "smithy.api#pattern": "^[!-~]{1,1024}$" + "smithy.api#pattern": "^(?!arn:)[!-~]{1,1024}$" } }, "com.amazonaws.servicediscovery#NamespaceNamePrivate": { @@ -2573,7 +2933,7 @@ "min": 0, "max": 253 }, - "smithy.api#pattern": "^[!-~]{1,253}$" + "smithy.api#pattern": "^(?!arn:)[!-~]{1,253}$" } }, "com.amazonaws.servicediscovery#NamespaceNamePublic": { @@ -2605,7 +2965,7 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#DnsProperties", "traits": { - "smithy.api#documentation": "

A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a\n namespace.

" + "smithy.api#documentation": "

A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when\n you create a namespace.

" } }, "HttpProperties": { @@ -2640,10 +3000,16 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.

" } }, + "ResourceOwner": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's\n the ID of the account that shared the namespace with your account. For more information about\n shared namespaces, see Cross-account Cloud Map namespace sharing in the\n Cloud Map Developer Guide.

" + } + }, "Name": { "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { - "smithy.api#documentation": "

The name of the namespace. When you create a namespace, Cloud Map automatically creates a Route 53 hosted\n zone that has the same name as the namespace.

" + "smithy.api#documentation": "

The name of the namespace. When you create a namespace, Cloud Map automatically creates a\n Route 53 hosted zone that has the same name as the namespace.

" } }, "Type": { @@ -2722,6 +3088,12 @@ "smithy.api#documentation": "

The ID of the operation that you want to get information about.

" } }, + "OwnerAccount": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the namespace associated with the operation.

" + } + }, "Type": { "target": "com.amazonaws.servicediscovery#OperationType", "traits": { @@ -2737,25 +3109,25 @@ "ErrorMessage": { "target": "com.amazonaws.servicediscovery#Message", "traits": { - "smithy.api#documentation": "

If the value of Status is FAIL, the reason that the operation failed.

" + "smithy.api#documentation": "

If the value of Status is FAIL, the reason that the operation\n failed.

" } }, "ErrorCode": { "target": "com.amazonaws.servicediscovery#Code", "traits": { - "smithy.api#documentation": "

The code associated with ErrorMessage. Values for ErrorCode include the\n following:

\n
    \n
  • \n

    \n ACCESS_DENIED\n

    \n
  • \n
  • \n

    \n CANNOT_CREATE_HOSTED_ZONE\n

    \n
  • \n
  • \n

    \n EXPIRED_TOKEN\n

    \n
  • \n
  • \n

    \n HOSTED_ZONE_NOT_FOUND\n

    \n
  • \n
  • \n

    \n INTERNAL_FAILURE\n

    \n
  • \n
  • \n

    \n INVALID_CHANGE_BATCH\n

    \n
  • \n
  • \n

    \n THROTTLED_REQUEST\n

    \n
  • \n
" + "smithy.api#documentation": "

The code associated with ErrorMessage. Values for ErrorCode\n include the following:

\n
    \n
  • \n

    \n ACCESS_DENIED\n

    \n
  • \n
  • \n

    \n CANNOT_CREATE_HOSTED_ZONE\n

    \n
  • \n
  • \n

    \n EXPIRED_TOKEN\n

    \n
  • \n
  • \n

    \n HOSTED_ZONE_NOT_FOUND\n

    \n
  • \n
  • \n

    \n INTERNAL_FAILURE\n

    \n
  • \n
  • \n

    \n INVALID_CHANGE_BATCH\n

    \n
  • \n
  • \n

    \n THROTTLED_REQUEST\n

    \n
  • \n
" } }, "CreateDate": { "target": "com.amazonaws.servicediscovery#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time\n (UTC). The value of CreateDate is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + "smithy.api#documentation": "

The date and time that the request was submitted, in Unix date/time format and Coordinated\n Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "UpdateDate": { "target": "com.amazonaws.servicediscovery#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the value of Status changed to the current value, in Unix date/time\n format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + "smithy.api#documentation": "

The date and time that the value of Status changed to the current value, in\n Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate\n is accurate to milliseconds. For example, the value 1516925490.087 represents\n Friday, January 26, 2018 12:11:30.087 AM.

" } }, "Targets": { @@ -2775,21 +3147,21 @@ "Name": { "target": "com.amazonaws.servicediscovery#OperationFilterName", "traits": { - "smithy.api#documentation": "

Specify the operations that you want to get:

\n
    \n
  • \n

    \n NAMESPACE_ID: Gets operations related to specified namespaces.

    \n
  • \n
  • \n

    \n SERVICE_ID: Gets operations related to specified services.

    \n
  • \n
  • \n

    \n STATUS: Gets operations based on the status of the operations:\n SUBMITTED, PENDING, SUCCEED, or FAIL.

    \n
  • \n
  • \n

    \n TYPE: Gets specified types of operation.

    \n
  • \n
  • \n

    \n UPDATE_DATE: Gets operations that changed status during a specified\n date/time range.

    \n
  • \n
", + "smithy.api#documentation": "

Specify the operations that you want to get:

\n
    \n
  • \n

    \n NAMESPACE_ID: Gets operations related to specified\n namespaces.

    \n
  • \n
  • \n

    \n SERVICE_ID: Gets operations related to specified\n services.

    \n
  • \n
  • \n

    \n STATUS: Gets operations based on the status of the\n operations: SUBMITTED, PENDING, SUCCEED, or\n FAIL.

    \n
  • \n
  • \n

    \n TYPE: Gets specified types of operation.

    \n
  • \n
  • \n

    \n UPDATE_DATE: Gets operations that changed status during a\n specified date/time range.

    \n
  • \n
", "smithy.api#required": {} } }, "Values": { "target": "com.amazonaws.servicediscovery#FilterValues", "traits": { - "smithy.api#documentation": "

Specify values that are applicable to the value that you specify for Name:

\n
    \n
  • \n

    \n NAMESPACE_ID: Specify one namespace ID.

    \n
  • \n
  • \n

    \n SERVICE_ID: Specify one service ID.

    \n
  • \n
  • \n

    \n STATUS: Specify one or more statuses: SUBMITTED,\n PENDING, SUCCEED, or FAIL.

    \n
  • \n
  • \n

    \n TYPE: Specify one or more of the following types:\n CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE,\n REGISTER_INSTANCE, or DEREGISTER_INSTANCE.

    \n
  • \n
  • \n

    \n UPDATE_DATE: Specify a start date and an end date in Unix date/time\n format and Coordinated Universal Time (UTC). The start date must be the first value.

    \n
  • \n
", + "smithy.api#documentation": "

Specify values that are applicable to the value that you specify for Name:

\n
    \n
  • \n

    \n NAMESPACE_ID: Specify one namespace ID.

    \n
  • \n
  • \n

    \n SERVICE_ID: Specify one service ID.

    \n
  • \n
  • \n

    \n STATUS: Specify one or more statuses:\n SUBMITTED, PENDING, SUCCEED, or\n FAIL.

    \n
  • \n
  • \n

    \n TYPE: Specify one or more of the following types:\n CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE,\n REGISTER_INSTANCE, or DEREGISTER_INSTANCE.

    \n
  • \n
  • \n

    \n UPDATE_DATE: Specify a start date and an end date in Unix\n date/time format and Coordinated Universal Time (UTC). The start date must be the first\n value.

    \n
  • \n
", "smithy.api#required": {} } }, "Condition": { "target": "com.amazonaws.servicediscovery#FilterCondition", "traits": { - "smithy.api#documentation": "

The operator that you want to use to determine whether an operation matches the specified value. Valid\n values for condition include:

\n
    \n
  • \n

    \n EQ: When you specify EQ for the condition, you can specify only one value.\n EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and\n TYPE. EQ is the default condition and can be omitted.

    \n
  • \n
  • \n

    \n IN: When you specify IN for the condition, you can specify a list of one or\n more values. IN is supported for STATUS and TYPE. An operation must\n match one of the specified values to be returned in the response.

    \n
  • \n
  • \n

    \n BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated\n Universal Time (UTC). The start date must be the first value. BETWEEN is supported for\n UPDATE_DATE.

    \n
  • \n
" + "smithy.api#documentation": "

The operator that you want to use to determine whether an operation matches the specified\n value. Valid values for condition include:

\n
    \n
  • \n

    \n EQ: When you specify EQ for the condition, you can specify only\n one value. EQ is supported for NAMESPACE_ID, SERVICE_ID,\n STATUS, and TYPE. EQ is the default condition and can\n be omitted.

    \n
  • \n
  • \n

    \n IN: When you specify IN for the condition, you can specify a\n list of one or more values. IN is supported for STATUS and\n TYPE. An operation must match one of the specified values to be returned in the\n response.

    \n
  • \n
  • \n

    \n BETWEEN: Specify a start date and an end date in Unix date/time format and\n Coordinated Universal Time (UTC). The start date must be the first value. BETWEEN\n is supported for UPDATE_DATE.

    \n
  • \n
" } } }, @@ -2904,12 +3276,12 @@ "Status": { "target": "com.amazonaws.servicediscovery#OperationStatus", "traits": { - "smithy.api#documentation": "

The status of the operation. Values include the following:

\n
    \n
  • \n

    \n SUBMITTED: This is the initial state immediately after you submit a\n request.

    \n
  • \n
  • \n

    \n PENDING: Cloud Map is performing the operation.

    \n
  • \n
  • \n

    \n SUCCESS: The operation succeeded.

    \n
  • \n
  • \n

    \n FAIL: The operation failed. For the failure reason, see\n ErrorMessage.

    \n
  • \n
" + "smithy.api#documentation": "

The status of the operation. Values include the following:

\n
    \n
  • \n

    \n SUBMITTED: This is the initial state immediately after\n you submit a request.

    \n
  • \n
  • \n

    \n PENDING: Cloud Map is performing the operation.

    \n
  • \n
  • \n

    \n SUCCESS: The operation succeeded.

    \n
  • \n
  • \n

    \n FAIL: The operation failed. For the failure reason, see\n ErrorMessage.

    \n
  • \n
" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about an operation that matches the criteria that you specified in\n a ListOperations\n request.

" + "smithy.api#documentation": "

A complex type that contains information about an operation that matches the criteria that\n you specified in a ListOperations request.

" } }, "com.amazonaws.servicediscovery#OperationSummaryList": { @@ -3000,18 +3372,18 @@ "Description": { "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { - "smithy.api#documentation": "

An updated description for the\n private DNS namespace.

" + "smithy.api#documentation": "

An updated\n description for the private DNS namespace.

" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PrivateDnsNamespacePropertiesChange", "traits": { - "smithy.api#documentation": "

Properties to be updated in the\n private DNS namespace.

" + "smithy.api#documentation": "

Properties to be\n updated in the private DNS namespace.

" } } }, "traits": { - "smithy.api#documentation": "

Updated properties for the private\n DNS namespace.

" + "smithy.api#documentation": "

Updated properties\n for the private DNS namespace.

" } }, "com.amazonaws.servicediscovery#PrivateDnsNamespaceProperties": { @@ -3020,13 +3392,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutable", "traits": { - "smithy.api#documentation": "

DNS properties for the private DNS\n namespace.

", + "smithy.api#documentation": "

DNS properties for\n the private DNS namespace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

DNS properties for the private DNS\n namespace.

" + "smithy.api#documentation": "

DNS properties for\n the private DNS namespace.

" } }, "com.amazonaws.servicediscovery#PrivateDnsNamespacePropertiesChange": { @@ -3035,13 +3407,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutableChange", "traits": { - "smithy.api#documentation": "

Updated DNS properties for the\n private DNS namespace.

", + "smithy.api#documentation": "

Updated DNS\n properties for the private DNS namespace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Updated properties for the private\n DNS namespace.

" + "smithy.api#documentation": "

Updated properties\n for the private DNS namespace.

" } }, "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutable": { @@ -3050,13 +3422,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOA", "traits": { - "smithy.api#documentation": "

Fields for the Start of Authority\n (SOA) record for the hosted zone for the private DNS namespace.

", + "smithy.api#documentation": "

Fields for the Start\n of Authority (SOA) record for the hosted zone for the private DNS\n namespace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

DNS properties for the private DNS\n namespace.

" + "smithy.api#documentation": "

DNS properties for\n the private DNS namespace.

" } }, "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutableChange": { @@ -3065,13 +3437,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOAChange", "traits": { - "smithy.api#documentation": "

Updated fields for the Start of\n Authority (SOA) record for the hosted zone for the private DNS namespace.

", + "smithy.api#documentation": "

Updated fields for\n the Start of Authority (SOA) record for the hosted zone for the private DNS\n namespace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Updated DNS properties for the\n private DNS namespace.

" + "smithy.api#documentation": "

Updated DNS\n properties for the private DNS namespace.

" } }, "com.amazonaws.servicediscovery#PublicDnsNamespaceChange": { @@ -3080,18 +3452,18 @@ "Description": { "target": "com.amazonaws.servicediscovery#ResourceDescription", "traits": { - "smithy.api#documentation": "

An updated description for the\n public DNS namespace.

" + "smithy.api#documentation": "

An updated\n description for the public DNS namespace.

" } }, "Properties": { "target": "com.amazonaws.servicediscovery#PublicDnsNamespacePropertiesChange", "traits": { - "smithy.api#documentation": "

Properties to be updated in the\n public DNS namespace.

" + "smithy.api#documentation": "

Properties to be\n updated in the public DNS namespace.

" } } }, "traits": { - "smithy.api#documentation": "

Updated properties for the public\n DNS namespace.

" + "smithy.api#documentation": "

Updated properties\n for the public DNS namespace.

" } }, "com.amazonaws.servicediscovery#PublicDnsNamespaceProperties": { @@ -3100,13 +3472,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PublicDnsPropertiesMutable", "traits": { - "smithy.api#documentation": "

DNS properties for the public DNS\n namespace.

", + "smithy.api#documentation": "

DNS properties for\n the public DNS namespace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

DNS properties for the public DNS\n namespace.

" + "smithy.api#documentation": "

DNS properties for\n the public DNS namespace.

" } }, "com.amazonaws.servicediscovery#PublicDnsNamespacePropertiesChange": { @@ -3115,13 +3487,13 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#PublicDnsPropertiesMutableChange", "traits": { - "smithy.api#documentation": "

Updated DNS properties for the\n hosted zone for the public DNS namespace.

", + "smithy.api#documentation": "

Updated DNS\n properties for the hosted zone for the public DNS namespace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Updated properties for the public\n DNS namespace.

" + "smithy.api#documentation": "

Updated properties\n for the public DNS namespace.

" } }, "com.amazonaws.servicediscovery#PublicDnsPropertiesMutable": { @@ -3130,13 +3502,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOA", "traits": { - "smithy.api#documentation": "

Start of Authority (SOA) record for\n the hosted zone for the public DNS namespace.

", + "smithy.api#documentation": "

Start of Authority\n (SOA) record for the hosted zone for the public DNS namespace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

DNS properties for the public DNS\n namespace.

" + "smithy.api#documentation": "

DNS properties for\n the public DNS namespace.

" } }, "com.amazonaws.servicediscovery#PublicDnsPropertiesMutableChange": { @@ -3145,13 +3517,13 @@ "SOA": { "target": "com.amazonaws.servicediscovery#SOAChange", "traits": { - "smithy.api#documentation": "

Updated fields for the Start of\n Authority (SOA) record for the hosted zone for the public DNS namespace.

", + "smithy.api#documentation": "

Updated fields for\n the Start of Authority (SOA) record for the hosted zone for the public DNS\n namespace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Updated DNS properties for the\n public DNS namespace.

" + "smithy.api#documentation": "

Updated DNS\n properties for the public DNS namespace.

" } }, "com.amazonaws.servicediscovery#RecordTTL": { @@ -3218,7 +3590,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates one or more records and, optionally, creates a health check based on the settings in a\n specified service. When you submit a RegisterInstance request, the following occurs:

\n
    \n
  • \n

    For each DNS record that you define in the service that's specified by ServiceId, a record\n is created or updated in the hosted zone that's associated with the corresponding namespace.

    \n
  • \n
  • \n

    If the service includes HealthCheckConfig, a health check is created based on the settings\n in the health check configuration.

    \n
  • \n
  • \n

    The health check, if any, is associated with each of the new or updated records.

    \n
  • \n
\n \n

One RegisterInstance request must complete before you can submit another request and specify\n the same service ID and instance ID.

\n
\n

For more information, see CreateService.

\n

When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:

\n
    \n
  • \n

    \n If the health check is healthy: returns all the records

    \n
  • \n
  • \n

    \n If the health check is unhealthy: returns the applicable value for the\n last healthy instance

    \n
  • \n
  • \n

    \n If you didn't specify a health check configuration: returns all the\n records

    \n
  • \n
\n

For the current quota on the number of instances that you can register using the same namespace and using\n the same service, see Cloud Map\n quotas in the Cloud Map Developer Guide.

", + "smithy.api#documentation": "

Creates or updates one or more records and, optionally, creates a health check based on the\n settings in a specified service. When you submit a RegisterInstance request, the\n following occurs:

\n
    \n
  • \n

    For each DNS record that you define in the service that's specified by\n ServiceId, a record is created or updated in the hosted zone that's associated\n with the corresponding namespace.

    \n
  • \n
  • \n

    If the service includes HealthCheckConfig, a health check is created based on\n the settings in the health check configuration.

    \n
  • \n
  • \n

    The health check, if any, is associated with each of the new or updated records.

    \n
  • \n
\n \n

One RegisterInstance request must complete before you can submit another\n request and specify the same service ID and instance ID.

\n
\n

For more information, see CreateService.

\n

When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable\n value:

\n
    \n
  • \n

    \n If the health check is healthy: returns all the\n records

    \n
  • \n
  • \n

    \n If the health check is unhealthy: returns the applicable\n value for the last healthy instance

    \n
  • \n
  • \n

    \n If you didn't specify a health check configuration:\n returns all the records

    \n
  • \n
\n

For the current quota on the number of instances that you can register using the same\n namespace and using the same service, see Cloud Map quotas in the\n Cloud Map Developer Guide.

", "smithy.api#examples": [ { "title": "Example: Register Instance", @@ -3235,6 +3607,21 @@ "output": { "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k95yg2u7" } + }, + { + "title": "Register instance using service ARN", + "documentation": "Registers an instance using a service ARN instead of service ID, useful when working with shared namespaces. Shows registering an instance to a service created by a sharee in a namespace owned by another account.", + "input": { + "InstanceId": "i-abcd1234xmpl5678", + "ServiceId": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", + "Attributes": { + "AWS_INSTANCE_IPV4": "192.0.2.44", + "AWS_INSTANCE_PORT": "80" + } + }, + "output": { + "OperationId": "abcd1234-xmpl-5678-9012-abcd1234xmpl" + } } ] } @@ -3243,30 +3630,30 @@ "type": "structure", "members": { "ServiceId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the service that you want to use for settings for the instance.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the service that you want to use for settings for the instance. For\n services created in a shared namespace, specify the service ARN. For more information about\n shared namespaces, see Cross-account Cloud Map namespace sharing in the\n Cloud Map Developer Guide.

", "smithy.api#required": {} } }, "InstanceId": { "target": "com.amazonaws.servicediscovery#InstanceId", "traits": { - "smithy.api#documentation": "

An identifier that you want to associate with the instance. Note the following:

\n
    \n
  • \n

    If the service that's specified by ServiceId includes settings for an SRV\n record, the value of InstanceId is automatically included as part of the value for the\n SRV record. For more information, see DnsRecord > Type.

    \n
  • \n
  • \n

    You can use this value to update an existing instance.

    \n
  • \n
  • \n

    To register a new instance, you must specify a value that's unique among instances that you register by\n using the same service.

    \n
  • \n
  • \n

    If you specify an existing InstanceId and ServiceId, Cloud Map updates the\n existing DNS records, if any. If there's also an existing health check, Cloud Map deletes the old health\n check and creates a new one.

    \n \n

    The health check isn't deleted immediately, so it will still appear for a while if you submit a\n ListHealthChecks request, for example.

    \n
    \n
  • \n
\n \n

Do not include sensitive information in InstanceId if the namespace is discoverable by public\n DNS queries and any Type member of DnsRecord for the service contains\n SRV because the InstanceId is discoverable by public DNS queries.

\n
", + "smithy.api#documentation": "

An identifier that you want to associate with the instance. Note the following:

\n
    \n
  • \n

    If the service that's specified by ServiceId includes settings for an\n SRV record, the value of InstanceId is automatically included as\n part of the value for the SRV record. For more information, see DnsRecord >\n Type.

    \n
  • \n
  • \n

    You can use this value to update an existing instance.

    \n
  • \n
  • \n

    To register a new instance, you must specify a value that's unique among instances that\n you register by using the same service.

    \n
  • \n
  • \n

    If you specify an existing InstanceId and ServiceId, Cloud Map\n updates the existing DNS records, if any. If there's also an existing health check, Cloud Map\n deletes the old health check and creates a new one.

    \n \n

    The health check isn't deleted immediately, so it will still appear for a while if you\n submit a ListHealthChecks request, for example.

    \n
    \n
  • \n
\n \n

Do not include sensitive information in InstanceId if the namespace is\n discoverable by public DNS queries and any Type member of DnsRecord\n for the service contains SRV because the InstanceId is discoverable by\n public DNS queries.

\n
", "smithy.api#required": {} } }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows failed RegisterInstance requests\n to be retried without the risk of executing the operation twice. You must use a unique\n CreatorRequestId string every time you submit a RegisterInstance request if you're\n registering additional instances for the same namespace and service. CreatorRequestId can be any\n unique string (for example, a date/time stamp).

", + "smithy.api#documentation": "

A unique string that identifies the request and that allows failed\n RegisterInstance requests to be retried without the risk of executing the operation\n twice. You must use a unique CreatorRequestId string every time you submit a\n RegisterInstance request if you're registering additional instances for the same\n namespace and service. CreatorRequestId can be any unique string (for example, a\n date/time stamp).

", "smithy.api#idempotencyToken": {} } }, "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "

A string map that contains the following information for the service that you specify in\n ServiceId:

\n
    \n
  • \n

    The attributes that apply to the records that are defined in the service.

    \n
  • \n
  • \n

    For each attribute, the applicable value.

    \n
  • \n
\n \n

Do not include sensitive information in the attributes if the namespace is discoverable by public DNS\n queries.

\n
\n

The following are the supported attribute keys.

\n
\n
AWS_ALIAS_DNS_NAME
\n
\n

If you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load\n balancer, specify the DNS name that's associated with the load balancer. For information about how to get the\n DNS name, see \"DNSName\" in the topic AliasTarget in the\n Route 53 API Reference.

\n

Note the following:

\n
    \n
  • \n

    The configuration for the service that's specified by ServiceId must include settings for\n an A record, an AAAA record, or both.

    \n
  • \n
  • \n

    In the service that's specified by ServiceId, the value of RoutingPolicy\n must be WEIGHTED.

    \n
  • \n
  • \n

    If the service that's specified by ServiceId includes HealthCheckConfig\n settings, Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the\n alias record.

    \n
  • \n
  • \n

    Cloud Map currently doesn't support creating alias records that route traffic to Amazon Web Services\n resources other than Elastic Load Balancing load balancers.

    \n
  • \n
  • \n

    If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the\n AWS_INSTANCE attributes.

    \n
  • \n
  • \n

    The AWS_ALIAS_DNS_NAME is not supported in the GovCloud (US) Regions.

    \n
  • \n
\n
\n
AWS_EC2_INSTANCE_ID
\n
\n

\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the\n AWS_EC2_INSTANCE_ID attribute is specified, then the only other attribute that can be specified\n is AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID attribute is specified,\n then the AWS_INSTANCE_IPV4 attribute will be filled out with the primary private IPv4\n address.

\n
\n
AWS_INIT_HEALTH_STATUS
\n
\n

If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

\n
\n
AWS_INSTANCE_CNAME
\n
\n

If the service configuration includes a CNAME record, the domain name that you want Route 53\n to return in response to DNS queries (for example, example.com).

\n

This value is required if the service specified by ServiceId includes settings for an\n CNAME record.

\n
\n
AWS_INSTANCE_IPV4
\n
\n

If the service configuration includes an A record, the IPv4 address that you want Route 53 to\n return in response to DNS queries (for example, 192.0.2.44).

\n

This value is required if the service specified by ServiceId includes settings for an\n A record. If the service includes settings for an SRV record, you must specify a\n value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_IPV6
\n
\n

If the service configuration includes an AAAA record, the IPv6 address that you want Route 53\n to return in response to DNS queries (for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345).

\n

This value is required if the service specified by ServiceId includes settings for an\n AAAA record. If the service includes settings for an SRV record, you must specify\n a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_PORT
\n
\n

If the service includes an SRV record, the value that you want Route 53 to return for the\n port.

\n

If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to\n send requests to.

\n

This value is required if you specified settings for an SRV record or a Route 53 health check\n when you created the service.

\n
\n
Custom attributes
\n
\n

You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute\n name is 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of\n all provided attributes (sum of all keys and values) must not exceed 5,000 characters.

\n
\n
", + "smithy.api#documentation": "

A string map that contains the following information for the service that you specify in\n ServiceId:

\n
    \n
  • \n

    The attributes that apply to the records that are defined in the service.

    \n
  • \n
  • \n

    For each attribute, the applicable value.

    \n
  • \n
\n \n

Do not include sensitive information in the attributes if the namespace is discoverable by\n public DNS queries.

\n
\n

The following are the supported attribute keys.

\n
\n
AWS_ALIAS_DNS_NAME
\n
\n

If you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an\n Elastic Load Balancing load balancer, specify the DNS name that's associated with the load balancer. For\n information about how to get the DNS name, see \"DNSName\" in the topic AliasTarget in the Route 53 API Reference.

\n

Note the following:

\n
    \n
  • \n

    The configuration for the service that's specified by ServiceId must\n include settings for an A record, an AAAA record, or both.

    \n
  • \n
  • \n

    In the service that's specified by ServiceId, the value of\n RoutingPolicy must be WEIGHTED.

    \n
  • \n
  • \n

    If the service that's specified by ServiceId includes\n HealthCheckConfig settings, Cloud Map will create the Route 53 health check, but\n it doesn't associate the health check with the alias record.

    \n
  • \n
  • \n

    Cloud Map currently doesn't support creating alias records that route traffic to\n Amazon Web Services resources other than Elastic Load Balancing load balancers.

    \n
  • \n
  • \n

    If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for\n any of the AWS_INSTANCE attributes.

    \n
  • \n
  • \n

    The AWS_ALIAS_DNS_NAME is not supported in the GovCloud (US)\n Regions.

    \n
  • \n
\n
\n
AWS_EC2_INSTANCE_ID
\n
\n

\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the\n AWS_EC2_INSTANCE_ID attribute is specified, then the only other attribute that\n can be specified is AWS_INIT_HEALTH_STATUS. When the\n AWS_EC2_INSTANCE_ID attribute is specified, then the\n AWS_INSTANCE_IPV4 attribute will be filled out with the primary private IPv4\n address.

\n
\n
AWS_INIT_HEALTH_STATUS
\n
\n

If the service configuration includes HealthCheckCustomConfig, you can\n optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom\n health check, HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

\n
\n
AWS_INSTANCE_CNAME
\n
\n

If the service configuration includes a CNAME record, the domain name that\n you want Route 53 to return in response to DNS queries (for example,\n example.com).

\n

This value is required if the service specified by ServiceId includes\n settings for an CNAME record.

\n
\n
AWS_INSTANCE_IPV4
\n
\n

If the service configuration includes an A record, the IPv4 address that you\n want Route 53 to return in response to DNS queries (for example, 192.0.2.44).

\n

This value is required if the service specified by ServiceId includes\n settings for an A record. If the service includes settings for an\n SRV record, you must specify a value for AWS_INSTANCE_IPV4,\n AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_IPV6
\n
\n

If the service configuration includes an AAAA record, the IPv6 address that\n you want Route 53 to return in response to DNS queries (for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345).

\n

This value is required if the service specified by ServiceId includes\n settings for an AAAA record. If the service includes settings for an\n SRV record, you must specify a value for AWS_INSTANCE_IPV4,\n AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_PORT
\n
\n

If the service includes an SRV record, the value that you want Route 53 to\n return for the port.

\n

If the service includes HealthCheckConfig, the port on the endpoint that you\n want Route 53 to send requests to.

\n

This value is required if you specified settings for an SRV record or a\n Route 53 health check when you created the service.

\n
\n
Custom attributes
\n
\n

You can add up to 30 custom attributes. For each key-value pair, the maximum length of\n the attribute name is 255 characters, and the maximum length of the attribute value is 1,024\n characters. The total size of all provided attributes (sum of all keys and values) must not\n exceed 5,000 characters.

\n
\n
", "smithy.api#required": {} } } @@ -3297,7 +3684,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation can't be completed because you've reached the quota for the number of requests. For more\n information, see Cloud Map API request\n throttling quota in the Cloud Map Developer Guide.

", + "smithy.api#documentation": "

The operation can't be completed because you've reached the quota for the number of\n requests. For more information, see Cloud Map API request throttling quota in the\n Cloud Map Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -3331,7 +3718,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified resource can't be deleted because it contains other resources. For example, you can't delete\n a service that contains any instances.

", + "smithy.api#documentation": "

The specified resource can't be deleted because it contains other resources. For example,\n you can't delete a service that contains any instances.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -3344,7 +3731,7 @@ } }, "traits": { - "smithy.api#documentation": "

The resource can't be created because you've reached the quota on the number of resources.

", + "smithy.api#documentation": "

The resource can't be created because you've reached the quota on the number of\n resources.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3481,7 +3868,7 @@ "name": "servicediscovery" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Cloud Map\n

With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice\n applications run in. When an instance becomes available, you can call the Cloud Map API to register the\n instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and\n an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service\n receive an answer that contains up to eight healthy records.

", + "smithy.api#documentation": "Cloud Map\n

With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your\n microservice applications run in. When an instance becomes available, you can call the Cloud Map\n API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map\n automatically creates DNS records and an optional health check. Clients that submit public or\n private DNS queries, or HTTP requests, for the service receive an answer that contains up to\n eight healthy records.

", "smithy.api#title": "AWS Cloud Map", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -4368,17 +4755,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4392,17 +4768,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4416,17 +4781,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4440,17 +4794,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4549,13 +4892,13 @@ "TTL": { "target": "com.amazonaws.servicediscovery#RecordTTL", "traits": { - "smithy.api#documentation": "

The time to live (TTL) for purposes\n of negative caching.

", + "smithy.api#documentation": "

The time to live\n (TTL) for purposes of negative caching.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Start of Authority (SOA) properties\n for a public or private DNS namespace.

" + "smithy.api#documentation": "

Start of Authority\n (SOA) properties for a public or private DNS namespace.

" } }, "com.amazonaws.servicediscovery#SOAChange": { @@ -4564,13 +4907,13 @@ "TTL": { "target": "com.amazonaws.servicediscovery#RecordTTL", "traits": { - "smithy.api#documentation": "

The updated time to live (TTL) for\n purposes of negative caching.

", + "smithy.api#documentation": "

The updated time to\n live (TTL) for purposes of negative caching.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Updated Start of Authority (SOA)\n properties for a public or private DNS namespace.

" + "smithy.api#documentation": "

Updated Start of\n Authority (SOA) properties for a public or private DNS namespace.

" } }, "com.amazonaws.servicediscovery#Service": { @@ -4588,6 +4931,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

" } }, + "ResourceOwner": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that created the namespace with which the service is associated.\n If this isn't your account ID, it is the ID of the account that shared the namespace with your\n account. For more information about shared namespaces, see Cross-account Cloud Map\n namespace sharing in the Cloud Map Developer Guide.

" + } + }, "Name": { "target": "com.amazonaws.servicediscovery#ServiceName", "traits": { @@ -4609,43 +4958,49 @@ "InstanceCount": { "target": "com.amazonaws.servicediscovery#ResourceCount", "traits": { - "smithy.api#documentation": "

The number of instances that are currently associated with the service. Instances that were previously\n associated with the service but that are deleted aren't included in the count. The count might not reflect\n pending registrations and deregistrations.

" + "smithy.api#documentation": "

The number of instances that are currently associated with the service. Instances that were\n previously associated with the service but that are deleted aren't included in the count. The\n count might not reflect pending registrations and deregistrations.

" } }, "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create\n when you register an instance.

\n \n

The record types of a service can only be changed by deleting the service and recreating it with a new\n Dnsconfig.

\n
" + "smithy.api#documentation": "

A complex type that contains information about the Route 53 DNS records that you want\n Cloud Map to create when you register an instance.

\n \n

The record types of a service can only be changed by deleting the service and recreating it\n with a new Dnsconfig.

\n
" } }, "Type": { "target": "com.amazonaws.servicediscovery#ServiceType", "traits": { - "smithy.api#documentation": "

Describes the systems that can be used to discover the service instances.

\n
\n
DNS_HTTP
\n
\n

The service instances can be discovered using either DNS queries or the DiscoverInstances\n API operation.

\n
\n
HTTP
\n
\n

The service instances can only be discovered using the DiscoverInstances API\n operation.

\n
\n
DNS
\n
\n

Reserved.

\n
\n
" + "smithy.api#documentation": "

Describes the systems that can be used to discover the service instances.

\n
\n
DNS_HTTP
\n
\n

The service instances can be discovered using either DNS queries or the\n DiscoverInstances API operation.

\n
\n
HTTP
\n
\n

The service instances can only be discovered using the DiscoverInstances API\n operation.

\n
\n
DNS
\n
\n

Reserved.

\n
\n
" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. A complex type that contains settings for an\n optional health check. If you specify settings for a health check, Cloud Map associates the health check with\n the records that you specify in DnsConfig.

\n

For information about the charges for health checks, see Amazon Route 53 Pricing.

" + "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. A complex type that contains\n settings for an optional health check. If you specify settings for a health check, Cloud Map\n associates the health check with the records that you specify in DnsConfig.

\n

For information about the charges for health checks, see Amazon Route 53 Pricing.

" } }, "HealthCheckCustomConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig", "traits": { - "smithy.api#documentation": "

A complex type that contains information about an optional custom health check.

\n \n

If you specify a health check configuration, you can specify either HealthCheckCustomConfig\n or HealthCheckConfig but not both.

\n
" + "smithy.api#documentation": "

A complex type that contains information about an optional custom health check.

\n \n

If you specify a health check configuration, you can specify either\n HealthCheckCustomConfig or HealthCheckConfig but not both.

\n
" } }, "CreateDate": { "target": "com.amazonaws.servicediscovery#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The\n value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.

" + "smithy.api#documentation": "

The date and time that the service was created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, "CreatorRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows failed requests to be retried without the risk\n of running the operation twice. CreatorRequestId can be any unique string (for example, a\n date/timestamp).

" + "smithy.api#documentation": "

A unique string that identifies the request and that allows failed requests to be retried\n without the risk of running the operation twice. CreatorRequestId can be any unique\n string (for example, a date/timestamp).

" + } + }, + "CreatedByAccount": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that created the service. If this isn't your account ID, it is\n the ID of account of the namespace owner or of another account with which the namespace has been\n shared. For more information about shared namespaces, see Cross-account Cloud Map\n namespace sharing in the Cloud Map Developer Guide.

" } } }, @@ -4670,6 +5025,12 @@ "traits": { "smithy.api#documentation": "

The ID of the existing service.

" } + }, + "ServiceArn": { + "target": "com.amazonaws.servicediscovery#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the existing service.

" + } } }, "traits": { @@ -4717,15 +5078,21 @@ "smithy.api#documentation": "

The ARN of the service that the attributes are associated with.

" } }, + "ResourceOwner": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that created the namespace with which the service is associated.\n If this isn't your account ID, it is the ID of the account that shared the namespace with your\n account. For more information about shared namespaces, see Cross-account Cloud Map\n namespace sharing in the Cloud Map Developer Guide.

" + } + }, "Attributes": { "target": "com.amazonaws.servicediscovery#ServiceAttributesMap", "traits": { - "smithy.api#documentation": "

A string map that contains the following information for the service that you specify in\n ServiceArn:

\n
    \n
  • \n

    The attributes that apply to the service.

    \n
  • \n
  • \n

    For each attribute, the applicable value.

    \n
  • \n
\n

You can specify a total of 30 attributes.

" + "smithy.api#documentation": "

A string map that contains the following information for the service that you specify in\n ServiceArn:

\n
    \n
  • \n

    The attributes that apply to the service.

    \n
  • \n
  • \n

    For each attribute, the applicable value.

    \n
  • \n
\n

You can specify a total of 30 attributes.

" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about attributes associated with a specific service.

" + "smithy.api#documentation": "

A complex type that contains information about attributes associated with a specific\n service.

" } }, "com.amazonaws.servicediscovery#ServiceAttributesLimitExceededException": { @@ -4736,7 +5103,7 @@ } }, "traits": { - "smithy.api#documentation": "

The attribute can't be added to the service because you've exceeded the quota for the number of attributes you can add to a service.

", + "smithy.api#documentation": "

The attribute can't be added to the service because you've exceeded the quota for the number\n of attributes you can add to a service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4768,13 +5135,13 @@ "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfigChange", "traits": { - "smithy.api#documentation": "

Information about the Route 53 DNS records that you want Cloud Map to create when you register an\n instance.

" + "smithy.api#documentation": "

Information about the Route 53 DNS records that you want Cloud Map to create when you register\n an instance.

" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. Settings for an optional health check. If you\n specify settings for a health check, Cloud Map associates the health check with the records that you specify in\n DnsConfig.

" + "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. Settings for an optional health\n check. If you specify settings for a health check, Cloud Map associates the health check with\n the records that you specify in DnsConfig.

" } } }, @@ -4788,26 +5155,26 @@ "Name": { "target": "com.amazonaws.servicediscovery#ServiceFilterName", "traits": { - "smithy.api#documentation": "

Specify NAMESPACE_ID.

", + "smithy.api#documentation": "

Specify the services that you want to get using one of the following.

\n
    \n
  • \n

    \n NAMESPACE_ID: Gets the services associated with the specified\n namespace.

    \n
  • \n
  • \n

    \n RESOURCE_OWNER: Gets the services associated with the namespaces created by\n your Amazon Web Services account or by other accounts. This can be used to filter for services created in a\n shared namespace. For more information about shared namespaces, see Cross-account Cloud Map\n namespace sharing in the Cloud Map Developer Guide.

    \n
  • \n
", "smithy.api#required": {} } }, "Values": { "target": "com.amazonaws.servicediscovery#FilterValues", "traits": { - "smithy.api#documentation": "

The values that are applicable to the value that you specify for Condition to filter the list\n of services.

", + "smithy.api#documentation": "

The values that are applicable to the value that you specify for Condition to\n filter the list of services.

\n
    \n
  • \n

    \n NAMESPACE_ID: Specify one namespace ID or ARN. Specify\n the namespace ARN for namespaces that are shared with your Amazon Web Services account.

    \n
  • \n
  • \n

    \n RESOURCE_OWNER: Specify one of SELF or\n OTHER_ACCOUNTS. SELF can be used to filter services associated with\n namespaces created by you and OTHER_ACCOUNTS can be used to filter services\n associated with namespaces that were shared with you.

    \n
  • \n
", "smithy.api#required": {} } }, "Condition": { "target": "com.amazonaws.servicediscovery#FilterCondition", "traits": { - "smithy.api#documentation": "

The operator that you want to use to determine whether a service is returned by ListServices.\n Valid values for Condition include the following:

\n
    \n
  • \n

    \n EQ: When you specify EQ, specify one namespace ID for Values.\n EQ is the default condition and can be omitted.

    \n
  • \n
" + "smithy.api#documentation": "

The operator that you want to use to determine whether a service is returned by\n ListServices. Valid values for Condition include the following:

\n
    \n
  • \n

    \n EQ: When you specify EQ, specify one value. EQ is\n the default condition and can be omitted.

    \n
  • \n
" } } }, "traits": { - "smithy.api#documentation": "

A complex type that lets you specify the namespaces that you want to list services for.

" + "smithy.api#documentation": "

A complex type that lets you specify the namespaces that you want to list services\n for.

" } }, "com.amazonaws.servicediscovery#ServiceFilterName": { @@ -4818,6 +5185,12 @@ "traits": { "smithy.api#enumValue": "NAMESPACE_ID" } + }, + "RESOURCE_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_OWNER" + } } } }, @@ -4870,6 +5243,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

" } }, + "ResourceOwner": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that created the namespace with which the service is associated.\n If this isn't your account ID, it is the ID of the account that shared the namespace with your\n account. For more information about shared namespaces, see Cross-account Cloud Map\n namespace sharing in the Cloud Map Developer Guide.

" + } + }, "Name": { "target": "com.amazonaws.servicediscovery#ServiceName", "traits": { @@ -4879,7 +5258,7 @@ "Type": { "target": "com.amazonaws.servicediscovery#ServiceType", "traits": { - "smithy.api#documentation": "

Describes the systems that can be used to discover the service instances.

\n
\n
DNS_HTTP
\n
\n

The service instances can be discovered using either DNS queries or the DiscoverInstances\n API operation.

\n
\n
HTTP
\n
\n

The service instances can only be discovered using the DiscoverInstances API\n operation.

\n
\n
DNS
\n
\n

Reserved.

\n
\n
" + "smithy.api#documentation": "

Describes the systems that can be used to discover the service instances.

\n
\n
DNS_HTTP
\n
\n

The service instances can be discovered using either DNS queries or the\n DiscoverInstances API operation.

\n
\n
HTTP
\n
\n

The service instances can only be discovered using the DiscoverInstances API\n operation.

\n
\n
DNS
\n
\n

Reserved.

\n
\n
" } }, "Description": { @@ -4891,25 +5270,25 @@ "InstanceCount": { "target": "com.amazonaws.servicediscovery#ResourceCount", "traits": { - "smithy.api#documentation": "

The number of instances that are currently associated with the service. Instances that were previously\n associated with the service but that are deleted aren't included in the count. The count might not reflect\n pending registrations and deregistrations.

" + "smithy.api#documentation": "

The number of instances that are currently associated with the service. Instances that were\n previously associated with the service but that are deleted aren't included in the count. The\n count might not reflect pending registrations and deregistrations.

" } }, "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { - "smithy.api#documentation": "

Information about the Route 53 DNS records that you want Cloud Map to create when you register an\n instance.

" + "smithy.api#documentation": "

Information about the Route 53 DNS records that you want Cloud Map to create when you register\n an instance.

" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. Settings for an optional health check. If you\n specify settings for a health check, Cloud Map associates the health check with the records that you specify in\n DnsConfig.

" + "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. Settings for an optional health\n check. If you specify settings for a health check, Cloud Map associates the health check with\n the records that you specify in DnsConfig.

" } }, "HealthCheckCustomConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckCustomConfig", "traits": { - "smithy.api#documentation": "

Information about an optional custom health check. A custom health check, which requires that you use a\n third-party health checker to evaluate the health of your resources, is useful in the following\n circumstances:

\n
    \n
  • \n

    You can't use a health check that's defined by HealthCheckConfig because the resource isn't\n available over the internet. For example, you can use a custom health check when the instance is in an Amazon\n VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)

    \n
  • \n
  • \n

    You want to use a third-party health checker regardless of where your resources are located.

    \n
  • \n
\n \n

If you specify a health check configuration, you can specify either HealthCheckCustomConfig\n or HealthCheckConfig but not both.

\n
" + "smithy.api#documentation": "

Information about an optional custom health check. A custom health check, which requires\n that you use a third-party health checker to evaluate the health of your resources, is useful in\n the following circumstances:

\n
    \n
  • \n

    You can't use a health check that's defined by HealthCheckConfig because the\n resource isn't available over the internet. For example, you can use a custom health check when\n the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health\n checker must also be in the VPC.)

    \n
  • \n
  • \n

    You want to use a third-party health checker regardless of where your resources are\n located.

    \n
  • \n
\n \n

If you specify a health check configuration, you can specify either\n HealthCheckCustomConfig or HealthCheckConfig but not both.

\n
" } }, "CreateDate": { @@ -4917,6 +5296,12 @@ "traits": { "smithy.api#documentation": "

The date and time that the service was created.

" } + }, + "CreatedByAccount": { + "target": "com.amazonaws.servicediscovery#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that created the service. If this isn't your account ID, it is\n the account ID of the namespace owner or of another account with which the namespace has been\n shared. For more information about shared namespaces, see Cross-account Cloud Map\n namespace sharing in the Cloud Map Developer Guide.

" + } } }, "traits": { @@ -4970,7 +5355,7 @@ "Value": { "target": "com.amazonaws.servicediscovery#TagValue", "traits": { - "smithy.api#documentation": "

The string value that's associated with the key of the tag. You can set the value of a tag to an empty\n string, but you can't set the value of a tag to null.

", + "smithy.api#documentation": "

The string value that's associated with the key of the tag. You can set the value of a tag\n to an empty string, but you can't set the value of a tag to null.

", "smithy.api#required": {} } } @@ -5068,7 +5453,7 @@ "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { - "smithy.api#documentation": "

The tags to add to the specified resource. Specifying the tag key is required. You can set the value of a\n tag to an empty string, but you can't set the value of a tag to null.

", + "smithy.api#documentation": "

The tags to add to the specified resource. Specifying the tag key is required. You can set\n the value of a tag to an empty string, but you can't set the value of a tag to null.

", "smithy.api#required": {} } } @@ -5110,7 +5495,7 @@ } }, "traits": { - "smithy.api#documentation": "

The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a\n resource is 50.

", + "smithy.api#documentation": "

The list of tags on the resource is over the quota. The maximum number of tags that can be\n applied to a resource is 50.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -5215,6 +5600,19 @@ "output": { "OperationId": "ft52xe2koxhoeormaceymagglsdjyvEXAMPLE" } + }, + { + "title": "Update HTTP namespace using namespace ARN for shared namespace", + "documentation": "This example updates an HTTP namespace using a namespace ARN instead of namespace ID.", + "input": { + "Id": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-vh4nbmexample", + "Namespace": { + "Description": "Updated description for shared HTTP namespace." + } + }, + "output": { + "OperationId": "ft52xe2koxhoeormaceymagglsdjyvexample" + } } ] } @@ -5223,23 +5621,23 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the namespace that you\n want to update.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the namespace that you want to update.

", "smithy.api#required": {} } }, "UpdaterRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

A unique string that identifies the\n request and that allows failed UpdateHttpNamespace requests to be retried without the risk of\n running the operation twice. UpdaterRequestId can be any unique string (for example, a\n date/timestamp).

", + "smithy.api#documentation": "

A unique string that identifies the request and that allows failed\n UpdateHttpNamespace requests to be retried without the risk of running the\n operation twice. UpdaterRequestId can be any unique string (for example, a\n date/timestamp).

", "smithy.api#idempotencyToken": {} } }, "Namespace": { "target": "com.amazonaws.servicediscovery#HttpNamespaceChange", "traits": { - "smithy.api#documentation": "

Updated properties for the the HTTP\n namespace.

", + "smithy.api#documentation": "

Updated properties for the the HTTP namespace.

", "smithy.api#required": {} } } @@ -5285,8 +5683,18 @@ } ], "traits": { - "smithy.api#documentation": "

Submits a request to change the health status of a custom health check to healthy or unhealthy.

\n

You can use UpdateInstanceCustomHealthStatus to change the status only for custom health\n checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it\n to change the status for Route 53 health checks, which you define using HealthCheckConfig.

\n

For more information, see HealthCheckCustomConfig.

", + "smithy.api#documentation": "

Submits a request to change the health status of a custom health check to healthy or\n unhealthy.

\n

You can use UpdateInstanceCustomHealthStatus to change the status only for\n custom health checks, which you define using HealthCheckCustomConfig when you create\n a service. You can't use it to change the status for Route 53 health checks, which you define using\n HealthCheckConfig.

\n

For more information, see HealthCheckCustomConfig.

", "smithy.api#examples": [ + { + "title": "Update instance custom health status using service ARN", + "documentation": "Updates instance custom health status using a service ARN instead of service ID, useful when working with shared namespaces.", + "input": { + "InstanceId": "i-abcd1234xmpl5678", + "ServiceId": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", + "Status": "HEALTHY" + }, + "output": {} + }, { "title": "UpdateInstanceCustomHealthStatus Example", "documentation": "This example submits a request to change the health status of an instance associated with a service with a custom health check to HEALTHY.", @@ -5303,9 +5711,9 @@ "type": "structure", "members": { "ServiceId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the service that includes the configuration for the custom health check that you want to change\n the status for.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the service that includes the configuration for the custom health\n check that you want to change the status for. For services created in a shared namespace, specify\n the service ARN. For more information about shared namespaces, see Cross-account Cloud Map\n namespace sharing in the Cloud Map Developer Guide.

", "smithy.api#required": {} } }, @@ -5368,17 +5776,16 @@ } }, { - "title": "To update a public DNS namespace", - "documentation": "The following example updates the description of a public DNS namespace.", + "title": "Update private DNS namespace using namespace ARN for shared namespace", + "documentation": "This example updates a private DNS namespace using a namespace ARN instead of namespace ID.", "input": { - "Id": "ns-bk3aEXAMPLE", - "UpdaterRequestId": "", + "Id": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-bk3aexample", "Namespace": { - "Description": "The updated namespace description." + "Description": "Updated description for shared private DNS namespace." } }, "output": { - "OperationId": "ft52xe2koxhoeormaceymagglsdjEXAMPLE" + "OperationId": "ft52xe2koxhoeormaceymagglsdjyvexample" } } ] @@ -5388,23 +5795,23 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the namespace that you\n want to update.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the namespace that you want to update.

", "smithy.api#required": {} } }, "UpdaterRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

A unique string that identifies the\n request and that allows failed UpdatePrivateDnsNamespace requests to be retried without the risk of\n running the operation twice. UpdaterRequestId can be any unique string (for example, a\n date/timestamp).

", + "smithy.api#documentation": "

A unique string that identifies the request and that allows failed\n UpdatePrivateDnsNamespace requests to be retried without the risk of running the\n operation twice. UpdaterRequestId can be any unique string (for example, a\n date/timestamp).

", "smithy.api#idempotencyToken": {} } }, "Namespace": { "target": "com.amazonaws.servicediscovery#PrivateDnsNamespaceChange", "traits": { - "smithy.api#documentation": "

Updated properties for the private\n DNS namespace.

", + "smithy.api#documentation": "

Updated properties for the private DNS namespace.

", "smithy.api#required": {} } } @@ -5450,30 +5857,59 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a public DNS\n namespace.

" + "smithy.api#documentation": "

Updates a public DNS namespace.

", + "smithy.api#examples": [ + { + "title": "To update a public DNS namespace", + "documentation": "The following example updates the description of a public DNS namespace.", + "input": { + "Id": "ns-bk3aEXAMPLE", + "UpdaterRequestId": "", + "Namespace": { + "Description": "The updated namespace description." + } + }, + "output": { + "OperationId": "ft52xe2koxhoeormaceymagglsdjEXAMPLE" + } + }, + { + "title": "Update public DNS namespace using namespace ARN for shared namespace", + "documentation": "This example updates a public DNS namespace using a namespace ARN instead of namespace ID.", + "input": { + "Id": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-bk3aexample", + "Namespace": { + "Description": "Updated description for shared public DNS namespace." + } + }, + "output": { + "OperationId": "ft52xe2koxhoeormaceymagglsdjexample" + } + } + ] } }, "com.amazonaws.servicediscovery#UpdatePublicDnsNamespaceRequest": { "type": "structure", "members": { "Id": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the namespace being\n updated.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the namespace being updated.

", "smithy.api#required": {} } }, "UpdaterRequestId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

A unique string that identifies the\n request and that allows failed UpdatePublicDnsNamespace requests to be retried without the risk of\n running the operation twice. UpdaterRequestId can be any unique string (for example, a\n date/timestamp).

", + "smithy.api#documentation": "

A unique string that identifies the request and that allows failed\n UpdatePublicDnsNamespace requests to be retried without the risk of running the\n operation twice. UpdaterRequestId can be any unique string (for example, a\n date/timestamp).

", "smithy.api#idempotencyToken": {} } }, "Namespace": { "target": "com.amazonaws.servicediscovery#PublicDnsNamespaceChange", "traits": { - "smithy.api#documentation": "

Updated properties for the public\n DNS namespace.

", + "smithy.api#documentation": "

Updated properties for the public DNS namespace.

", "smithy.api#required": {} } } @@ -5516,7 +5952,7 @@ } ], "traits": { - "smithy.api#documentation": "

Submits a request to perform the following operations:

\n
    \n
  • \n

    Update the TTL setting for existing DnsRecords configurations

    \n
  • \n
  • \n

    Add, update, or delete HealthCheckConfig for a specified service

    \n \n

    You can't add, update, or delete a HealthCheckCustomConfig configuration.

    \n
    \n
  • \n
\n

For public and private DNS namespaces, note the following:

\n
    \n
  • \n

    If you omit any existing DnsRecords or HealthCheckConfig configurations from an\n UpdateService request, the configurations are deleted from the service.

    \n
  • \n
  • \n

    If you omit an existing HealthCheckCustomConfig configuration from an\n UpdateService request, the configuration isn't deleted from the service.

    \n
  • \n
\n

When you update settings for a service, Cloud Map also updates the corresponding settings in all the\n records and health checks that were created by using the specified service.

", + "smithy.api#documentation": "

Submits a request to perform the following operations:

\n
    \n
  • \n

    Update the TTL setting for existing DnsRecords configurations

    \n
  • \n
  • \n

    Add, update, or delete HealthCheckConfig for a specified service

    \n \n

    You can't add, update, or delete a HealthCheckCustomConfig\n configuration.

    \n
    \n
  • \n
\n

For public and private DNS namespaces, note the following:

\n
    \n
  • \n

    If you omit any existing DnsRecords or HealthCheckConfig\n configurations from an UpdateService request, the configurations are deleted from\n the service.

    \n
  • \n
  • \n

    If you omit an existing HealthCheckCustomConfig configuration from an\n UpdateService request, the configuration isn't deleted from the service.

    \n
  • \n
\n \n

You can't call UpdateService and update settings in the following\n scenarios:

\n
    \n
  • \n

    When the service is associated with an HTTP namespace

    \n
  • \n
  • \n

    When the service is associated with a shared namespace and contains instances that were\n registered by Amazon Web Services accounts other than the account making the UpdateService\n call

    \n
  • \n
\n
\n

When you update settings for a service, Cloud Map also updates the corresponding settings\n in all the records and health checks that were created by using the specified service.

", "smithy.api#examples": [ { "title": "UpdateService Example", @@ -5542,6 +5978,19 @@ "output": { "OperationId": "m35hsdrkxwjffm3xef4bxyy6vc3ewakx-jdn3y5g5" } + }, + { + "title": "Update service using service ARN for shared namespace", + "documentation": "This example updates a service using a service ARN instead of service ID. This is useful for updating services associated with shared namespaces.", + "input": { + "Id": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004", + "Service": { + "Description": "Updated service description for shared namespace" + } + }, + "output": { + "OperationId": "m35hsdrkxwjffm3xef4bxyy6vc3ewakx-jdn3y5g5" + } } ] } @@ -5568,6 +6017,18 @@ "traits": { "smithy.api#documentation": "

Submits a request to update a specified service to add service-level attributes.

", "smithy.api#examples": [ + { + "title": "Update service attributes using service ARN", + "documentation": "Updates service attributes using a service ARN instead of service ID, useful when working with shared namespaces.", + "input": { + "ServiceId": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", + "Attributes": { + "Port": "8080", + "Protocol": "HTTP" + } + }, + "output": {} + }, { "title": "UpdateServiceAttributes Example", "documentation": "This example submits a request to update the specified service to add a port attribute with the value 80.", @@ -5586,9 +6047,9 @@ "type": "structure", "members": { "ServiceId": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the service that you want to update.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the service that you want to update. For services created in a\n namespace shared with your Amazon Web Services account, specify the service ARN.

", "smithy.api#required": {} } }, @@ -5615,16 +6076,16 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.servicediscovery#ResourceId", + "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The ID of the service that you want to update.

", + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the service that you want to update. If the namespace associated with\n the service is shared with your Amazon Web Services account, specify the service ARN. For more information\n about shared namespaces, see Cross-account Cloud Map namespace sharing in the\n Cloud Map Developer Guide\n

", "smithy.api#required": {} } }, "Service": { "target": "com.amazonaws.servicediscovery#ServiceChange", "traits": { - "smithy.api#documentation": "

A complex type that contains the new settings for the service. You can specify a maximum of 30 attributes (key-value pairs).

", + "smithy.api#documentation": "

A complex type that contains the new settings for the service. You can specify a maximum of\n 30 attributes (key-value pairs).

", "smithy.api#required": {} } } diff --git a/codegen/sdk/aws-models/ses.json b/codegen/sdk/aws-models/ses.json index c570e34d690..662ed62631a 100644 --- a/codegen/sdk/aws-models/ses.json +++ b/codegen/sdk/aws-models/ses.json @@ -7258,17 +7258,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -7282,17 +7271,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -7306,17 +7284,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -7330,17 +7297,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/sesv2.json b/codegen/sdk/aws-models/sesv2.json index 44894d87b21..60c5ea153d8 100644 --- a/codegen/sdk/aws-models/sesv2.json +++ b/codegen/sdk/aws-models/sesv2.json @@ -13438,17 +13438,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -13462,17 +13451,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -13486,17 +13464,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -13510,17 +13477,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -13736,17 +13692,6 @@ "Region": "us-east-1", "Endpoint": "https://example.com" } - }, - { - "documentation": "Valid EndpointId with DualStack enabled and partition does not support DualStack", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "EndpointId": "abc123.456def", - "UseDualStack": true, - "Region": "us-isob-east-1" - } } ], "version": "1.0" diff --git a/codegen/sdk/aws-models/sfn.json b/codegen/sdk/aws-models/sfn.json index 1862cbdb384..f3c48596a1a 100644 --- a/codegen/sdk/aws-models/sfn.json +++ b/codegen/sdk/aws-models/sfn.json @@ -1031,17 +1031,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1055,17 +1044,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1079,17 +1057,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1103,17 +1070,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/shield.json b/codegen/sdk/aws-models/shield.json index 6dbdbd8b0ee..66a156a6220 100644 --- a/codegen/sdk/aws-models/shield.json +++ b/codegen/sdk/aws-models/shield.json @@ -795,17 +795,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -819,17 +808,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -843,17 +821,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -867,17 +834,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/signer.json b/codegen/sdk/aws-models/signer.json index 0977eb8bf9a..f872ff5791b 100644 --- a/codegen/sdk/aws-models/signer.json +++ b/codegen/sdk/aws-models/signer.json @@ -3557,17 +3557,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3581,17 +3570,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3605,17 +3583,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3629,17 +3596,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/simspaceweaver.json b/codegen/sdk/aws-models/simspaceweaver.json index a35e2aec6cb..0e8debaee67 100644 --- a/codegen/sdk/aws-models/simspaceweaver.json +++ b/codegen/sdk/aws-models/simspaceweaver.json @@ -1623,17 +1623,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1647,17 +1636,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1671,17 +1649,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1695,17 +1662,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/sms.json b/codegen/sdk/aws-models/sms.json deleted file mode 100644 index f5eaaf6a294..00000000000 --- a/codegen/sdk/aws-models/sms.json +++ /dev/null @@ -1,5687 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.sms#AWSServerMigrationService_V2016_10_24": { - "type": "service", - "version": "2016-10-24", - "operations": [ - { - "target": "com.amazonaws.sms#CreateApp" - }, - { - "target": "com.amazonaws.sms#CreateReplicationJob" - }, - { - "target": "com.amazonaws.sms#DeleteApp" - }, - { - "target": "com.amazonaws.sms#DeleteAppLaunchConfiguration" - }, - { - "target": "com.amazonaws.sms#DeleteAppReplicationConfiguration" - }, - { - "target": "com.amazonaws.sms#DeleteAppValidationConfiguration" - }, - { - "target": "com.amazonaws.sms#DeleteReplicationJob" - }, - { - "target": "com.amazonaws.sms#DeleteServerCatalog" - }, - { - "target": "com.amazonaws.sms#DisassociateConnector" - }, - { - "target": "com.amazonaws.sms#GenerateChangeSet" - }, - { - "target": "com.amazonaws.sms#GenerateTemplate" - }, - { - "target": "com.amazonaws.sms#GetApp" - }, - { - "target": "com.amazonaws.sms#GetAppLaunchConfiguration" - }, - { - "target": "com.amazonaws.sms#GetAppReplicationConfiguration" - }, - { - "target": "com.amazonaws.sms#GetAppValidationConfiguration" - }, - { - "target": "com.amazonaws.sms#GetAppValidationOutput" - }, - { - "target": "com.amazonaws.sms#GetConnectors" - }, - { - "target": "com.amazonaws.sms#GetReplicationJobs" - }, - { - "target": "com.amazonaws.sms#GetReplicationRuns" - }, - { - "target": "com.amazonaws.sms#GetServers" - }, - { - "target": "com.amazonaws.sms#ImportAppCatalog" - }, - { - "target": "com.amazonaws.sms#ImportServerCatalog" - }, - { - "target": "com.amazonaws.sms#LaunchApp" - }, - { - "target": "com.amazonaws.sms#ListApps" - }, - { - "target": "com.amazonaws.sms#NotifyAppValidationOutput" - }, - { - "target": "com.amazonaws.sms#PutAppLaunchConfiguration" - }, - { - "target": "com.amazonaws.sms#PutAppReplicationConfiguration" - }, - { - "target": "com.amazonaws.sms#PutAppValidationConfiguration" - }, - { - "target": "com.amazonaws.sms#StartAppReplication" - }, - { - "target": "com.amazonaws.sms#StartOnDemandAppReplication" - }, - { - "target": "com.amazonaws.sms#StartOnDemandReplicationRun" - }, - { - "target": "com.amazonaws.sms#StopAppReplication" - }, - { - "target": "com.amazonaws.sms#TerminateApp" - }, - { - "target": "com.amazonaws.sms#UpdateApp" - }, - { - "target": "com.amazonaws.sms#UpdateReplicationJob" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "SMS", - "arnNamespace": "sms", - "cloudFormationName": "SMS", - "cloudTrailEventSource": "sms.amazonaws.com", - "endpointPrefix": "sms" - }, - "aws.auth#sigv4": { - "name": "sms" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#deprecated": { - "message": "AWS Server Migration Service is Deprecated." - }, - "smithy.api#documentation": "\n

\n Product update\n

\n

We recommend Amazon Web Services Application Migration Service (Amazon Web Services\n MGN) as the primary migration service for lift-and-shift migrations. If Amazon Web Services MGN is\n unavailable in a specific Amazon Web Services Region, you can use the Server Migration Service APIs through March\n 2023.

\n
\n

Server Migration Service (Server Migration Service) makes it easier and faster for you to migrate your\n on-premises workloads to Amazon Web Services. To learn more about Server Migration Service, see the following \n resources:

\n ", - "smithy.api#title": "AWS Server Migration Service", - "smithy.api#xmlNamespace": { - "uri": "http://ec2.amazon.com/servermigration/2016-10-24/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://sms-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://sms-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://sms.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://sms.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - } - ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://sms-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://sms.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://sms-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://sms.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms-fips.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://sms-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://sms.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://sms.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.sms#AmiId": { - "type": "string" - }, - "com.amazonaws.sms#AppDescription": { - "type": "string" - }, - "com.amazonaws.sms#AppId": { - "type": "string" - }, - "com.amazonaws.sms#AppIdWithValidation": { - "type": "string", - "traits": { - "smithy.api#pattern": "^app-[0-9a-f]{17}$" - } - }, - "com.amazonaws.sms#AppIds": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#AppId" - } - }, - "com.amazonaws.sms#AppLaunchConfigurationStatus": { - "type": "enum", - "members": { - "NotConfigured": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_CONFIGURED" - } - }, - "Configured": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONFIGURED" - } - } - } - }, - "com.amazonaws.sms#AppLaunchStatus": { - "type": "enum", - "members": { - "ReadyForConfiguration": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READY_FOR_CONFIGURATION" - } - }, - "ConfigurationInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONFIGURATION_IN_PROGRESS" - } - }, - "ConfigurationInvalid": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONFIGURATION_INVALID" - } - }, - "ReadyForLaunch": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READY_FOR_LAUNCH" - } - }, - "ValidationInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALIDATION_IN_PROGRESS" - } - }, - "LaunchPending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAUNCH_PENDING" - } - }, - "LaunchInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAUNCH_IN_PROGRESS" - } - }, - "Launched": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAUNCHED" - } - }, - "PartiallyLaunched": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARTIALLY_LAUNCHED" - } - }, - "DeltaLaunchInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELTA_LAUNCH_IN_PROGRESS" - } - }, - "DeltaLaunchFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELTA_LAUNCH_FAILED" - } - }, - "LaunchFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAUNCH_FAILED" - } - }, - "TerminateInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATE_IN_PROGRESS" - } - }, - "TerminateFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATE_FAILED" - } - }, - "Terminated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATED" - } - } - } - }, - "com.amazonaws.sms#AppLaunchStatusMessage": { - "type": "string" - }, - "com.amazonaws.sms#AppName": { - "type": "string" - }, - "com.amazonaws.sms#AppReplicationConfigurationStatus": { - "type": "enum", - "members": { - "NotConfigured": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_CONFIGURED" - } - }, - "Configured": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONFIGURED" - } - } - } - }, - "com.amazonaws.sms#AppReplicationStatus": { - "type": "enum", - "members": { - "ReadyForConfiguration": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READY_FOR_CONFIGURATION" - } - }, - "ConfigurationInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONFIGURATION_IN_PROGRESS" - } - }, - "ConfigurationInvalid": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONFIGURATION_INVALID" - } - }, - "ReadyForReplication": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READY_FOR_REPLICATION" - } - }, - "ValidationInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALIDATION_IN_PROGRESS" - } - }, - "ReplicationPending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REPLICATION_PENDING" - } - }, - "ReplicationInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REPLICATION_IN_PROGRESS" - } - }, - "Replicated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REPLICATED" - } - }, - "PartiallyReplicated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARTIALLY_REPLICATED" - } - }, - "DeltaReplicationInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELTA_REPLICATION_IN_PROGRESS" - } - }, - "DeltaReplicated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELTA_REPLICATED" - } - }, - "DeltaReplicationFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELTA_REPLICATION_FAILED" - } - }, - "ReplicationFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REPLICATION_FAILED" - } - }, - "ReplicationStopping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REPLICATION_STOPPING" - } - }, - "ReplicationStopFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REPLICATION_STOP_FAILED" - } - }, - "ReplicationStopped": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REPLICATION_STOPPED" - } - } - } - }, - "com.amazonaws.sms#AppReplicationStatusMessage": { - "type": "string" - }, - "com.amazonaws.sms#AppStatus": { - "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" - } - }, - "Deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - } - } - }, - "com.amazonaws.sms#AppStatusMessage": { - "type": "string" - }, - "com.amazonaws.sms#AppSummary": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The unique ID of the application.

" - } - }, - "importedAppId": { - "target": "com.amazonaws.sms#ImportedAppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - }, - "name": { - "target": "com.amazonaws.sms#AppName", - "traits": { - "smithy.api#documentation": "

The name of the application.

" - } - }, - "description": { - "target": "com.amazonaws.sms#AppDescription", - "traits": { - "smithy.api#documentation": "

The description of the application.

" - } - }, - "status": { - "target": "com.amazonaws.sms#AppStatus", - "traits": { - "smithy.api#documentation": "

Status of the application.

" - } - }, - "statusMessage": { - "target": "com.amazonaws.sms#AppStatusMessage", - "traits": { - "smithy.api#documentation": "

A message related to the status of the application

" - } - }, - "replicationConfigurationStatus": { - "target": "com.amazonaws.sms#AppReplicationConfigurationStatus", - "traits": { - "smithy.api#documentation": "

Status of the replication configuration.

" - } - }, - "replicationStatus": { - "target": "com.amazonaws.sms#AppReplicationStatus", - "traits": { - "smithy.api#documentation": "

The replication status of the application.

" - } - }, - "replicationStatusMessage": { - "target": "com.amazonaws.sms#AppReplicationStatusMessage", - "traits": { - "smithy.api#documentation": "

A message related to the replication status of the application.

" - } - }, - "latestReplicationTime": { - "target": "com.amazonaws.sms#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the application's most recent successful replication.

" - } - }, - "launchConfigurationStatus": { - "target": "com.amazonaws.sms#AppLaunchConfigurationStatus", - "traits": { - "smithy.api#documentation": "

Status of the launch configuration.

" - } - }, - "launchStatus": { - "target": "com.amazonaws.sms#AppLaunchStatus", - "traits": { - "smithy.api#documentation": "

The launch status of the application.

" - } - }, - "launchStatusMessage": { - "target": "com.amazonaws.sms#AppLaunchStatusMessage", - "traits": { - "smithy.api#documentation": "

A message related to the launch status of the application.

" - } - }, - "launchDetails": { - "target": "com.amazonaws.sms#LaunchDetails", - "traits": { - "smithy.api#documentation": "

Details about the latest launch of the application.

" - } - }, - "creationTime": { - "target": "com.amazonaws.sms#Timestamp", - "traits": { - "smithy.api#documentation": "

The creation time of the application.

" - } - }, - "lastModified": { - "target": "com.amazonaws.sms#Timestamp", - "traits": { - "smithy.api#documentation": "

The last modified time of the application.

" - } - }, - "roleName": { - "target": "com.amazonaws.sms#RoleName", - "traits": { - "smithy.api#documentation": "

The name of the service role in the customer's account used by Server Migration Service.

" - } - }, - "totalServerGroups": { - "target": "com.amazonaws.sms#TotalServerGroups", - "traits": { - "smithy.api#documentation": "

The number of server groups present in the application.

" - } - }, - "totalServers": { - "target": "com.amazonaws.sms#TotalServers", - "traits": { - "smithy.api#documentation": "

The number of servers present in the application.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the application.

" - } - }, - "com.amazonaws.sms#AppValidationConfiguration": { - "type": "structure", - "members": { - "validationId": { - "target": "com.amazonaws.sms#ValidationId", - "traits": { - "smithy.api#documentation": "

The ID of the validation.

" - } - }, - "name": { - "target": "com.amazonaws.sms#NonEmptyStringWithMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the configuration.

" - } - }, - "appValidationStrategy": { - "target": "com.amazonaws.sms#AppValidationStrategy", - "traits": { - "smithy.api#documentation": "

The validation strategy.

" - } - }, - "ssmValidationParameters": { - "target": "com.amazonaws.sms#SSMValidationParameters", - "traits": { - "smithy.api#documentation": "

The validation parameters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration for validating an application.

" - } - }, - "com.amazonaws.sms#AppValidationConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#AppValidationConfiguration" - } - }, - "com.amazonaws.sms#AppValidationOutput": { - "type": "structure", - "members": { - "ssmOutput": { - "target": "com.amazonaws.sms#SSMOutput", - "traits": { - "smithy.api#documentation": "

Output from using SSM to validate the application.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Output from validating an application.

" - } - }, - "com.amazonaws.sms#AppValidationStrategy": { - "type": "enum", - "members": { - "SSM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SSM" - } - } - } - }, - "com.amazonaws.sms#Apps": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#AppSummary" - } - }, - "com.amazonaws.sms#AssociatePublicIpAddress": { - "type": "boolean" - }, - "com.amazonaws.sms#AutoLaunch": { - "type": "boolean" - }, - "com.amazonaws.sms#BucketName": { - "type": "string" - }, - "com.amazonaws.sms#ClientToken": { - "type": "string" - }, - "com.amazonaws.sms#Command": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64000 - } - } - }, - "com.amazonaws.sms#Connector": { - "type": "structure", - "members": { - "connectorId": { - "target": "com.amazonaws.sms#ConnectorId", - "traits": { - "smithy.api#documentation": "

The ID of the connector.

" - } - }, - "version": { - "target": "com.amazonaws.sms#ConnectorVersion", - "traits": { - "smithy.api#documentation": "

The connector version.

" - } - }, - "status": { - "target": "com.amazonaws.sms#ConnectorStatus", - "traits": { - "smithy.api#documentation": "

The status of the connector.

" - } - }, - "capabilityList": { - "target": "com.amazonaws.sms#ConnectorCapabilityList", - "traits": { - "smithy.api#documentation": "

The capabilities of the connector.

" - } - }, - "vmManagerName": { - "target": "com.amazonaws.sms#VmManagerName", - "traits": { - "smithy.api#documentation": "

The name of the VM manager.

" - } - }, - "vmManagerType": { - "target": "com.amazonaws.sms#VmManagerType", - "traits": { - "smithy.api#documentation": "

The VM management product.

" - } - }, - "vmManagerId": { - "target": "com.amazonaws.sms#VmManagerId", - "traits": { - "smithy.api#documentation": "

The ID of the VM manager.

" - } - }, - "ipAddress": { - "target": "com.amazonaws.sms#IpAddress", - "traits": { - "smithy.api#documentation": "

The IP address of the connector.

" - } - }, - "macAddress": { - "target": "com.amazonaws.sms#MacAddress", - "traits": { - "smithy.api#documentation": "

The MAC address of the connector.

" - } - }, - "associatedOn": { - "target": "com.amazonaws.sms#Timestamp", - "traits": { - "smithy.api#documentation": "

The time the connector was associated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a connector.

" - } - }, - "com.amazonaws.sms#ConnectorCapability": { - "type": "enum", - "members": { - "vSphere": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VSPHERE" - } - }, - "scvmm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCVMM" - } - }, - "hyperVManager": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HYPERV-MANAGER" - } - }, - "snapshotBatching": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SNAPSHOT_BATCHING" - } - }, - "smsOptimized": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMS_OPTIMIZED" - } - } - } - }, - "com.amazonaws.sms#ConnectorCapabilityList": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#ConnectorCapability", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.sms#ConnectorId": { - "type": "string" - }, - "com.amazonaws.sms#ConnectorList": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#Connector", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.sms#ConnectorStatus": { - "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.sms#ConnectorVersion": { - "type": "string" - }, - "com.amazonaws.sms#CreateApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#CreateAppRequest" - }, - "output": { - "target": "com.amazonaws.sms#CreateAppResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an application. An application consists of one or more server groups. Each\n server group contain one or more servers.

" - } - }, - "com.amazonaws.sms#CreateAppRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.sms#AppName", - "traits": { - "smithy.api#documentation": "

The name of the new application.

" - } - }, - "description": { - "target": "com.amazonaws.sms#AppDescription", - "traits": { - "smithy.api#documentation": "

The description of the new application

" - } - }, - "roleName": { - "target": "com.amazonaws.sms#RoleName", - "traits": { - "smithy.api#documentation": "

The name of the service role in the customer's account to be used by Server Migration Service.

" - } - }, - "clientToken": { - "target": "com.amazonaws.sms#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of\n application creation.

" - } - }, - "serverGroups": { - "target": "com.amazonaws.sms#ServerGroups", - "traits": { - "smithy.api#documentation": "

The server groups to include in the application.

" - } - }, - "tags": { - "target": "com.amazonaws.sms#Tags", - "traits": { - "smithy.api#documentation": "

The tags to be associated with the application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#CreateAppResponse": { - "type": "structure", - "members": { - "appSummary": { - "target": "com.amazonaws.sms#AppSummary", - "traits": { - "smithy.api#documentation": "

A summary description of the application.

" - } - }, - "serverGroups": { - "target": "com.amazonaws.sms#ServerGroups", - "traits": { - "smithy.api#documentation": "

The server groups included in the application.

" - } - }, - "tags": { - "target": "com.amazonaws.sms#Tags", - "traits": { - "smithy.api#documentation": "

The tags associated with the application.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#CreateReplicationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#CreateReplicationJobRequest" - }, - "output": { - "target": "com.amazonaws.sms#CreateReplicationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#NoConnectorsAvailableException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#ReplicationJobAlreadyExistsException" - }, - { - "target": "com.amazonaws.sms#ServerCannotBeReplicatedException" - }, - { - "target": "com.amazonaws.sms#TemporarilyUnavailableException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a replication job. The replication job schedules periodic replication runs\n to replicate your server to Amazon Web Services. Each replication run creates an Amazon Machine Image\n (AMI).

" - } - }, - "com.amazonaws.sms#CreateReplicationJobRequest": { - "type": "structure", - "members": { - "serverId": { - "target": "com.amazonaws.sms#ServerId", - "traits": { - "smithy.api#documentation": "

The ID of the server.

", - "smithy.api#required": {} - } - }, - "seedReplicationTime": { - "target": "com.amazonaws.sms#Timestamp", - "traits": { - "smithy.api#documentation": "

The seed replication time.

", - "smithy.api#required": {} - } - }, - "frequency": { - "target": "com.amazonaws.sms#Frequency", - "traits": { - "smithy.api#documentation": "

The time between consecutive replication runs, in hours.

" - } - }, - "runOnce": { - "target": "com.amazonaws.sms#RunOnce", - "traits": { - "smithy.api#documentation": "

Indicates whether to run the replication job one time.

" - } - }, - "licenseType": { - "target": "com.amazonaws.sms#LicenseType", - "traits": { - "smithy.api#documentation": "

The license type to be used for the AMI created by a successful replication\n run.

" - } - }, - "roleName": { - "target": "com.amazonaws.sms#RoleName", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to be used by the Server Migration Service.

" - } - }, - "description": { - "target": "com.amazonaws.sms#Description", - "traits": { - "smithy.api#documentation": "

The description of the replication job.

" - } - }, - "numberOfRecentAmisToKeep": { - "target": "com.amazonaws.sms#NumberOfRecentAmisToKeep", - "traits": { - "smithy.api#documentation": "

The maximum number of SMS-created AMIs to retain. The oldest is deleted after the\n maximum number is reached and a new AMI is created.

" - } - }, - "encrypted": { - "target": "com.amazonaws.sms#Encrypted", - "traits": { - "smithy.api#documentation": "

Indicates whether the replication job produces encrypted AMIs.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.sms#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The ID of the KMS key for replication jobs that produce encrypted AMIs. \n This value can be any of the following:

\n
    \n
  • \n

    KMS key ID

    \n
  • \n
  • \n

    KMS key alias

    \n
  • \n
  • \n

    ARN referring to the KMS key ID

    \n
  • \n
  • \n

    ARN referring to the KMS key alias

    \n
  • \n
\n

If encrypted is true but a KMS key ID is not specified, the\n customer's default KMS key for Amazon EBS is used.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#CreateReplicationJobResponse": { - "type": "structure", - "members": { - "replicationJobId": { - "target": "com.amazonaws.sms#ReplicationJobId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the replication job.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#DeleteApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#DeleteAppRequest" - }, - "output": { - "target": "com.amazonaws.sms#DeleteAppResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified application. Optionally deletes the launched stack associated with\n the application and all Server Migration Service replication jobs for servers in the application.

" - } - }, - "com.amazonaws.sms#DeleteAppLaunchConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#DeleteAppLaunchConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.sms#DeleteAppLaunchConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the launch configuration for the specified application.

" - } - }, - "com.amazonaws.sms#DeleteAppLaunchConfigurationRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#DeleteAppLaunchConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#DeleteAppReplicationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#DeleteAppReplicationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.sms#DeleteAppReplicationConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the replication configuration for the specified application.

" - } - }, - "com.amazonaws.sms#DeleteAppReplicationConfigurationRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#DeleteAppReplicationConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#DeleteAppRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - }, - "forceStopAppReplication": { - "target": "com.amazonaws.sms#ForceStopAppReplication", - "traits": { - "smithy.api#documentation": "

Indicates whether to stop all replication jobs corresponding to the servers\n in the application while deleting the application.

" - } - }, - "forceTerminateApp": { - "target": "com.amazonaws.sms#ForceTerminateApp", - "traits": { - "smithy.api#documentation": "

Indicates whether to terminate the stack corresponding to the\n application while deleting the application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#DeleteAppResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#DeleteAppValidationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#DeleteAppValidationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.sms#DeleteAppValidationConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the validation configuration for the specified application.

" - } - }, - "com.amazonaws.sms#DeleteAppValidationConfigurationRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppIdWithValidation", - "traits": { - "smithy.api#documentation": "

The ID of the application.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#DeleteAppValidationConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#DeleteReplicationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#DeleteReplicationJobRequest" - }, - "output": { - "target": "com.amazonaws.sms#DeleteReplicationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#ReplicationJobNotFoundException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified replication job.

\n

After you delete a replication job, there are no further replication runs. Amazon Web Services\n deletes the contents of the Amazon S3 bucket used to store Server Migration Service artifacts. The AMIs created\n by the replication runs are not deleted.

" - } - }, - "com.amazonaws.sms#DeleteReplicationJobRequest": { - "type": "structure", - "members": { - "replicationJobId": { - "target": "com.amazonaws.sms#ReplicationJobId", - "traits": { - "smithy.api#documentation": "

The ID of the replication job.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#DeleteReplicationJobResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#DeleteServerCatalog": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#DeleteServerCatalogRequest" - }, - "output": { - "target": "com.amazonaws.sms#DeleteServerCatalogResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes all servers from your server catalog.

" - } - }, - "com.amazonaws.sms#DeleteServerCatalogRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#DeleteServerCatalogResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#Description": { - "type": "string" - }, - "com.amazonaws.sms#DisassociateConnector": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#DisassociateConnectorRequest" - }, - "output": { - "target": "com.amazonaws.sms#DisassociateConnectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates the specified connector from Server Migration Service.

\n

After you disassociate a connector, it is no longer available to support\n replication jobs.

" - } - }, - "com.amazonaws.sms#DisassociateConnectorRequest": { - "type": "structure", - "members": { - "connectorId": { - "target": "com.amazonaws.sms#ConnectorId", - "traits": { - "smithy.api#documentation": "

The ID of the connector.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#DisassociateConnectorResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#DryRunOperationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sms#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DryRunOperationException", - "httpResponseCode": 412 - }, - "smithy.api#documentation": "

The user has the required permissions, so the request would have succeeded, \n but a dry run was performed.

", - "smithy.api#error": "client", - "smithy.api#httpError": 412 - } - }, - "com.amazonaws.sms#EC2KeyName": { - "type": "string" - }, - "com.amazonaws.sms#Encrypted": { - "type": "boolean" - }, - "com.amazonaws.sms#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.sms#ExecutionTimeoutSeconds": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 60, - "max": 28800 - } - } - }, - "com.amazonaws.sms#ForceStopAppReplication": { - "type": "boolean" - }, - "com.amazonaws.sms#ForceTerminateApp": { - "type": "boolean" - }, - "com.amazonaws.sms#Frequency": { - "type": "integer" - }, - "com.amazonaws.sms#GenerateChangeSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#GenerateChangeSetRequest" - }, - "output": { - "target": "com.amazonaws.sms#GenerateChangeSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Generates a target change set for a currently launched stack and writes it to an Amazon S3\n object in the customer’s Amazon S3 bucket.

" - } - }, - "com.amazonaws.sms#GenerateChangeSetRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application associated with the change set.

" - } - }, - "changesetFormat": { - "target": "com.amazonaws.sms#OutputFormat", - "traits": { - "smithy.api#documentation": "

The format for the change set.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#GenerateChangeSetResponse": { - "type": "structure", - "members": { - "s3Location": { - "target": "com.amazonaws.sms#S3Location", - "traits": { - "smithy.api#documentation": "

The location of the Amazon S3 object.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#GenerateTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#GenerateTemplateRequest" - }, - "output": { - "target": "com.amazonaws.sms#GenerateTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Generates an CloudFormation template based on the current launch configuration and writes it to\n an Amazon S3 object in the customer’s Amazon S3 bucket.

" - } - }, - "com.amazonaws.sms#GenerateTemplateRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application associated with the CloudFormation template.

" - } - }, - "templateFormat": { - "target": "com.amazonaws.sms#OutputFormat", - "traits": { - "smithy.api#documentation": "

The format for generating the CloudFormation template.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#GenerateTemplateResponse": { - "type": "structure", - "members": { - "s3Location": { - "target": "com.amazonaws.sms#S3Location", - "traits": { - "smithy.api#documentation": "

The location of the Amazon S3 object.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#GetApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#GetAppRequest" - }, - "output": { - "target": "com.amazonaws.sms#GetAppResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieve information about the specified application.

" - } - }, - "com.amazonaws.sms#GetAppLaunchConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#GetAppLaunchConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.sms#GetAppLaunchConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the application launch configuration associated with the specified application.

" - } - }, - "com.amazonaws.sms#GetAppLaunchConfigurationRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#GetAppLaunchConfigurationResponse": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - }, - "roleName": { - "target": "com.amazonaws.sms#RoleName", - "traits": { - "smithy.api#documentation": "

The name of the service role in the customer's account that CloudFormation uses to launch the\n application.

" - } - }, - "autoLaunch": { - "target": "com.amazonaws.sms#AutoLaunch", - "traits": { - "smithy.api#documentation": "

Indicates whether the application is configured to launch automatically after replication is complete.

" - } - }, - "serverGroupLaunchConfigurations": { - "target": "com.amazonaws.sms#ServerGroupLaunchConfigurations", - "traits": { - "smithy.api#documentation": "

The launch configurations for server groups in this application.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#GetAppReplicationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#GetAppReplicationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.sms#GetAppReplicationConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the application replication configuration associated with the specified\n application.

" - } - }, - "com.amazonaws.sms#GetAppReplicationConfigurationRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#GetAppReplicationConfigurationResponse": { - "type": "structure", - "members": { - "serverGroupReplicationConfigurations": { - "target": "com.amazonaws.sms#ServerGroupReplicationConfigurations", - "traits": { - "smithy.api#documentation": "

The replication configurations associated with server groups in this application.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#GetAppRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#GetAppResponse": { - "type": "structure", - "members": { - "appSummary": { - "target": "com.amazonaws.sms#AppSummary", - "traits": { - "smithy.api#documentation": "

Information about the application.

" - } - }, - "serverGroups": { - "target": "com.amazonaws.sms#ServerGroups", - "traits": { - "smithy.api#documentation": "

The server groups that belong to the application.

" - } - }, - "tags": { - "target": "com.amazonaws.sms#Tags", - "traits": { - "smithy.api#documentation": "

The tags associated with the application.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#GetAppValidationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#GetAppValidationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.sms#GetAppValidationConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves information about a configuration for validating an application.

" - } - }, - "com.amazonaws.sms#GetAppValidationConfigurationRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppIdWithValidation", - "traits": { - "smithy.api#documentation": "

The ID of the application.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#GetAppValidationConfigurationResponse": { - "type": "structure", - "members": { - "appValidationConfigurations": { - "target": "com.amazonaws.sms#AppValidationConfigurations", - "traits": { - "smithy.api#documentation": "

The configuration for application validation.

" - } - }, - "serverGroupValidationConfigurations": { - "target": "com.amazonaws.sms#ServerGroupValidationConfigurations", - "traits": { - "smithy.api#documentation": "

The configuration for instance validation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#GetAppValidationOutput": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#GetAppValidationOutputRequest" - }, - "output": { - "target": "com.amazonaws.sms#GetAppValidationOutputResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves output from validating an application.

" - } - }, - "com.amazonaws.sms#GetAppValidationOutputRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppIdWithValidation", - "traits": { - "smithy.api#documentation": "

The ID of the application.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#GetAppValidationOutputResponse": { - "type": "structure", - "members": { - "validationOutputList": { - "target": "com.amazonaws.sms#ValidationOutputList", - "traits": { - "smithy.api#documentation": "

The validation output.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#GetConnectors": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#GetConnectorsRequest" - }, - "output": { - "target": "com.amazonaws.sms#GetConnectorsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the connectors registered with the Server Migration Service.

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "connectorList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.sms#GetConnectorsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.sms#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } - }, - "maxResults": { - "target": "com.amazonaws.sms#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. The default value is 50.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#GetConnectorsResponse": { - "type": "structure", - "members": { - "connectorList": { - "target": "com.amazonaws.sms#ConnectorList", - "traits": { - "smithy.api#documentation": "

Information about the registered connectors.

" - } - }, - "nextToken": { - "target": "com.amazonaws.sms#NextToken", - "traits": { - "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when\n there are no more results to return.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#GetReplicationJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#GetReplicationJobsRequest" - }, - "output": { - "target": "com.amazonaws.sms#GetReplicationJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the specified replication job or all of your replication jobs.

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "replicationJobList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.sms#GetReplicationJobsRequest": { - "type": "structure", - "members": { - "replicationJobId": { - "target": "com.amazonaws.sms#ReplicationJobId", - "traits": { - "smithy.api#documentation": "

The ID of the replication job.

" - } - }, - "nextToken": { - "target": "com.amazonaws.sms#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } - }, - "maxResults": { - "target": "com.amazonaws.sms#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. The default value is 50.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#GetReplicationJobsResponse": { - "type": "structure", - "members": { - "replicationJobList": { - "target": "com.amazonaws.sms#ReplicationJobList", - "traits": { - "smithy.api#documentation": "

Information about the replication jobs.

" - } - }, - "nextToken": { - "target": "com.amazonaws.sms#NextToken", - "traits": { - "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when\n there are no more results to return.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#GetReplicationRuns": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#GetReplicationRunsRequest" - }, - "output": { - "target": "com.amazonaws.sms#GetReplicationRunsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the replication runs for the specified replication job.

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "replicationRunList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.sms#GetReplicationRunsRequest": { - "type": "structure", - "members": { - "replicationJobId": { - "target": "com.amazonaws.sms#ReplicationJobId", - "traits": { - "smithy.api#documentation": "

The ID of the replication job.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.sms#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } - }, - "maxResults": { - "target": "com.amazonaws.sms#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. The default value is 50.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#GetReplicationRunsResponse": { - "type": "structure", - "members": { - "replicationJob": { - "target": "com.amazonaws.sms#ReplicationJob", - "traits": { - "smithy.api#documentation": "

Information about the replication job.

" - } - }, - "replicationRunList": { - "target": "com.amazonaws.sms#ReplicationRunList", - "traits": { - "smithy.api#documentation": "

Information about the replication runs.

" - } - }, - "nextToken": { - "target": "com.amazonaws.sms#NextToken", - "traits": { - "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when\n there are no more results to return.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#GetServers": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#GetServersRequest" - }, - "output": { - "target": "com.amazonaws.sms#GetServersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the servers in your server catalog.

\n

Before you can describe your servers, you must import them using ImportServerCatalog.

", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "serverList", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.sms#GetServersRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.sms#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } - }, - "maxResults": { - "target": "com.amazonaws.sms#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. The default value is 50.\n To retrieve the remaining results, make another call with the returned\n NextToken value.

" - } - }, - "vmServerAddressList": { - "target": "com.amazonaws.sms#VmServerAddressList", - "traits": { - "smithy.api#documentation": "

The server addresses.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#GetServersResponse": { - "type": "structure", - "members": { - "lastModifiedOn": { - "target": "com.amazonaws.sms#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the server was last modified.

" - } - }, - "serverCatalogStatus": { - "target": "com.amazonaws.sms#ServerCatalogStatus", - "traits": { - "smithy.api#documentation": "

The status of the server catalog.

" - } - }, - "serverList": { - "target": "com.amazonaws.sms#ServerList", - "traits": { - "smithy.api#documentation": "

Information about the servers.

" - } - }, - "nextToken": { - "target": "com.amazonaws.sms#NextToken", - "traits": { - "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when\n there are no more results to return.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#ImportAppCatalog": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#ImportAppCatalogRequest" - }, - "output": { - "target": "com.amazonaws.sms#ImportAppCatalogResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Allows application import from Migration Hub.

" - } - }, - "com.amazonaws.sms#ImportAppCatalogRequest": { - "type": "structure", - "members": { - "roleName": { - "target": "com.amazonaws.sms#RoleName", - "traits": { - "smithy.api#documentation": "

The name of the service role. If you omit this parameter, we create a service-linked role\n for Migration Hub in your account. Otherwise, the role that you provide must have the policy\n and trust policy described in the Migration Hub User Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#ImportAppCatalogResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#ImportServerCatalog": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#ImportServerCatalogRequest" - }, - "output": { - "target": "com.amazonaws.sms#ImportServerCatalogResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#NoConnectorsAvailableException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gathers a complete list of on-premises servers. Connectors must be installed and\n monitoring all servers to import.

\n

This call returns immediately, but might take additional time to retrieve all the\n servers.

" - } - }, - "com.amazonaws.sms#ImportServerCatalogRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#ImportServerCatalogResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#ImportedAppId": { - "type": "string" - }, - "com.amazonaws.sms#InstanceId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)$" - } - }, - "com.amazonaws.sms#InstanceType": { - "type": "string" - }, - "com.amazonaws.sms#InternalError": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sms#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InternalError", - "httpResponseCode": 500 - }, - "smithy.api#documentation": "

An internal error occurred.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.sms#InvalidParameterException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sms#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidParameter", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A specified parameter is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.sms#IpAddress": { - "type": "string" - }, - "com.amazonaws.sms#KmsKeyId": { - "type": "string" - }, - "com.amazonaws.sms#LaunchApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#LaunchAppRequest" - }, - "output": { - "target": "com.amazonaws.sms#LaunchAppResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Launches the specified application as a stack in CloudFormation.

" - } - }, - "com.amazonaws.sms#LaunchAppRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#LaunchAppResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#LaunchDetails": { - "type": "structure", - "members": { - "latestLaunchTime": { - "target": "com.amazonaws.sms#Timestamp", - "traits": { - "smithy.api#documentation": "

The latest time that this application was launched successfully.

" - } - }, - "stackName": { - "target": "com.amazonaws.sms#StackName", - "traits": { - "smithy.api#documentation": "

The name of the latest stack launched for this application.

" - } - }, - "stackId": { - "target": "com.amazonaws.sms#StackId", - "traits": { - "smithy.api#documentation": "

The ID of the latest stack launched for this application.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the latest launch of an application.

" - } - }, - "com.amazonaws.sms#LaunchOrder": { - "type": "integer" - }, - "com.amazonaws.sms#LicenseType": { - "type": "enum", - "members": { - "AWS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS" - } - }, - "BYOL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BYOL" - } - } - } - }, - "com.amazonaws.sms#ListApps": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#ListAppsRequest" - }, - "output": { - "target": "com.amazonaws.sms#ListAppsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves summaries for all applications.

" - } - }, - "com.amazonaws.sms#ListAppsRequest": { - "type": "structure", - "members": { - "appIds": { - "target": "com.amazonaws.sms#AppIds", - "traits": { - "smithy.api#documentation": "

The unique application IDs.

" - } - }, - "nextToken": { - "target": "com.amazonaws.sms#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } - }, - "maxResults": { - "target": "com.amazonaws.sms#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. The default value is 100. To\n retrieve the remaining results, make another call with the returned\n NextToken value.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#ListAppsResponse": { - "type": "structure", - "members": { - "apps": { - "target": "com.amazonaws.sms#Apps", - "traits": { - "smithy.api#documentation": "

The application summaries.

" - } - }, - "nextToken": { - "target": "com.amazonaws.sms#NextToken", - "traits": { - "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when there\n are no more results to return.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#LogicalId": { - "type": "string" - }, - "com.amazonaws.sms#MacAddress": { - "type": "string" - }, - "com.amazonaws.sms#MaxResults": { - "type": "integer" - }, - "com.amazonaws.sms#MissingRequiredParameterException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sms#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "MissingRequiredParameter", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A required parameter is missing.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.sms#NextToken": { - "type": "string" - }, - "com.amazonaws.sms#NoConnectorsAvailableException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sms#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "NoConnectorsAvailable", - "httpResponseCode": 430 - }, - "smithy.api#documentation": "

There are no connectors available.

", - "smithy.api#error": "client", - "smithy.api#httpError": 430 - } - }, - "com.amazonaws.sms#NonEmptyStringWithMaxLen255": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.sms#NotificationContext": { - "type": "structure", - "members": { - "validationId": { - "target": "com.amazonaws.sms#ValidationId", - "traits": { - "smithy.api#documentation": "

The ID of the validation.

" - } - }, - "status": { - "target": "com.amazonaws.sms#ValidationStatus", - "traits": { - "smithy.api#documentation": "

The status of the validation.

" - } - }, - "statusMessage": { - "target": "com.amazonaws.sms#ValidationStatusMessage", - "traits": { - "smithy.api#documentation": "

The status message.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the status of validating an application.

" - } - }, - "com.amazonaws.sms#NotifyAppValidationOutput": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#NotifyAppValidationOutputRequest" - }, - "output": { - "target": "com.amazonaws.sms#NotifyAppValidationOutputResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides information to Server Migration Service about whether application validation is successful.

" - } - }, - "com.amazonaws.sms#NotifyAppValidationOutputRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppIdWithValidation", - "traits": { - "smithy.api#documentation": "

The ID of the application.

", - "smithy.api#required": {} - } - }, - "notificationContext": { - "target": "com.amazonaws.sms#NotificationContext", - "traits": { - "smithy.api#documentation": "

The notification information.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#NotifyAppValidationOutputResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#NumberOfRecentAmisToKeep": { - "type": "integer" - }, - "com.amazonaws.sms#OperationNotPermittedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sms#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "OperationNotPermitted", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

This operation is not allowed.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.sms#OutputFormat": { - "type": "enum", - "members": { - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON" - } - }, - "YAML": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "YAML" - } - } - } - }, - "com.amazonaws.sms#PutAppLaunchConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#PutAppLaunchConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.sms#PutAppLaunchConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates the launch configuration for the specified application.

" - } - }, - "com.amazonaws.sms#PutAppLaunchConfigurationRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - }, - "roleName": { - "target": "com.amazonaws.sms#RoleName", - "traits": { - "smithy.api#documentation": "

The name of service role in the customer's account that CloudFormation uses to launch the\n application.

" - } - }, - "autoLaunch": { - "target": "com.amazonaws.sms#AutoLaunch", - "traits": { - "smithy.api#documentation": "

Indicates whether the application is configured to launch automatically after replication is complete.

" - } - }, - "serverGroupLaunchConfigurations": { - "target": "com.amazonaws.sms#ServerGroupLaunchConfigurations", - "traits": { - "smithy.api#documentation": "

Information about the launch configurations for server groups in the application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#PutAppLaunchConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#PutAppReplicationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#PutAppReplicationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.sms#PutAppReplicationConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates the replication configuration for the specified application.

" - } - }, - "com.amazonaws.sms#PutAppReplicationConfigurationRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - }, - "serverGroupReplicationConfigurations": { - "target": "com.amazonaws.sms#ServerGroupReplicationConfigurations", - "traits": { - "smithy.api#documentation": "

Information about the replication configurations for server groups in the application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#PutAppReplicationConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#PutAppValidationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#PutAppValidationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.sms#PutAppValidationConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates a validation configuration for the specified application.

" - } - }, - "com.amazonaws.sms#PutAppValidationConfigurationRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppIdWithValidation", - "traits": { - "smithy.api#documentation": "

The ID of the application.

", - "smithy.api#required": {} - } - }, - "appValidationConfigurations": { - "target": "com.amazonaws.sms#AppValidationConfigurations", - "traits": { - "smithy.api#documentation": "

The configuration for application validation.

" - } - }, - "serverGroupValidationConfigurations": { - "target": "com.amazonaws.sms#ServerGroupValidationConfigurations", - "traits": { - "smithy.api#documentation": "

The configuration for instance validation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#PutAppValidationConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#ReplicationJob": { - "type": "structure", - "members": { - "replicationJobId": { - "target": "com.amazonaws.sms#ReplicationJobId", - "traits": { - "smithy.api#documentation": "

The ID of the replication job.

" - } - }, - "serverId": { - "target": "com.amazonaws.sms#ServerId", - "traits": { - "smithy.api#documentation": "

The ID of the server.

" - } - }, - "serverType": { - "target": "com.amazonaws.sms#ServerType", - "traits": { - "smithy.api#documentation": "

The type of server.

" - } - }, - "vmServer": { - "target": "com.amazonaws.sms#VmServer", - "traits": { - "smithy.api#documentation": "

Information about the VM server.

" - } - }, - "seedReplicationTime": { - "target": "com.amazonaws.sms#Timestamp", - "traits": { - "smithy.api#documentation": "

The seed replication time.

" - } - }, - "frequency": { - "target": "com.amazonaws.sms#Frequency", - "traits": { - "smithy.api#documentation": "

The time between consecutive replication runs, in hours.

" - } - }, - "runOnce": { - "target": "com.amazonaws.sms#RunOnce", - "traits": { - "smithy.api#documentation": "

Indicates whether to run the replication job one time.

" - } - }, - "nextReplicationRunStartTime": { - "target": "com.amazonaws.sms#Timestamp", - "traits": { - "smithy.api#documentation": "

The start time of the next replication run.

" - } - }, - "licenseType": { - "target": "com.amazonaws.sms#LicenseType", - "traits": { - "smithy.api#documentation": "

The license type to be used for the AMI created by a successful replication\n run.

" - } - }, - "roleName": { - "target": "com.amazonaws.sms#RoleName", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to be used by Server Migration Service.

" - } - }, - "latestAmiId": { - "target": "com.amazonaws.sms#AmiId", - "traits": { - "smithy.api#documentation": "

The ID of the latest Amazon Machine Image (AMI).

" - } - }, - "state": { - "target": "com.amazonaws.sms#ReplicationJobState", - "traits": { - "smithy.api#documentation": "

The state of the replication job.

" - } - }, - "statusMessage": { - "target": "com.amazonaws.sms#ReplicationJobStatusMessage", - "traits": { - "smithy.api#documentation": "

The description of the current status of the replication job.

" - } - }, - "description": { - "target": "com.amazonaws.sms#Description", - "traits": { - "smithy.api#documentation": "

The description of the replication job.

" - } - }, - "numberOfRecentAmisToKeep": { - "target": "com.amazonaws.sms#NumberOfRecentAmisToKeep", - "traits": { - "smithy.api#documentation": "

The number of recent AMIs to keep in the customer's account for a replication job. By\n default, the value is set to zero, meaning that all AMIs are kept.

" - } - }, - "encrypted": { - "target": "com.amazonaws.sms#Encrypted", - "traits": { - "smithy.api#documentation": "

Indicates whether the replication job should produce encrypted AMIs.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.sms#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The ID of the KMS key for replication jobs that produce encrypted AMIs. \n This value can be any of the following:

\n
    \n
  • \n

    KMS key ID

    \n
  • \n
  • \n

    KMS key alias

    \n
  • \n
  • \n

    ARN referring to the KMS key ID

    \n
  • \n
  • \n

    ARN referring to the KMS key alias

    \n
  • \n
\n

If encrypted is enabled but a KMS key ID is not specified, the\n customer's default KMS key for Amazon EBS is used.

" - } - }, - "replicationRunList": { - "target": "com.amazonaws.sms#ReplicationRunList", - "traits": { - "smithy.api#documentation": "

Information about the replication runs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a replication job.

" - } - }, - "com.amazonaws.sms#ReplicationJobAlreadyExistsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sms#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ReplicationJobAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified replication job already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.sms#ReplicationJobId": { - "type": "string" - }, - "com.amazonaws.sms#ReplicationJobList": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#ReplicationJob", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.sms#ReplicationJobNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sms#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ReplicationJobNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified replication job does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.sms#ReplicationJobState": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "Active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "Deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "Completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "PausedOnFailure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PAUSED_ON_FAILURE" - } - }, - "Failing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILING" - } - } - } - }, - "com.amazonaws.sms#ReplicationJobStatusMessage": { - "type": "string" - }, - "com.amazonaws.sms#ReplicationJobTerminated": { - "type": "boolean" - }, - "com.amazonaws.sms#ReplicationRun": { - "type": "structure", - "members": { - "replicationRunId": { - "target": "com.amazonaws.sms#ReplicationRunId", - "traits": { - "smithy.api#documentation": "

The ID of the replication run.

" - } - }, - "state": { - "target": "com.amazonaws.sms#ReplicationRunState", - "traits": { - "smithy.api#documentation": "

The state of the replication run.

" - } - }, - "type": { - "target": "com.amazonaws.sms#ReplicationRunType", - "traits": { - "smithy.api#documentation": "

The type of replication run.

" - } - }, - "stageDetails": { - "target": "com.amazonaws.sms#ReplicationRunStageDetails", - "traits": { - "smithy.api#documentation": "

Details about the current stage of the replication run.

" - } - }, - "statusMessage": { - "target": "com.amazonaws.sms#ReplicationRunStatusMessage", - "traits": { - "smithy.api#documentation": "

The description of the current status of the replication job.

" - } - }, - "amiId": { - "target": "com.amazonaws.sms#AmiId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) from the replication\n run.

" - } - }, - "scheduledStartTime": { - "target": "com.amazonaws.sms#Timestamp", - "traits": { - "smithy.api#documentation": "

The start time of the next replication run.

" - } - }, - "completedTime": { - "target": "com.amazonaws.sms#Timestamp", - "traits": { - "smithy.api#documentation": "

The completion time of the last replication run.

" - } - }, - "description": { - "target": "com.amazonaws.sms#Description", - "traits": { - "smithy.api#documentation": "

The description of the replication run.

" - } - }, - "encrypted": { - "target": "com.amazonaws.sms#Encrypted", - "traits": { - "smithy.api#documentation": "

Indicates whether the replication run should produce an encrypted AMI.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.sms#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The ID of the KMS key for replication jobs that produce encrypted AMIs. \n This value can be any of the following:

\n
    \n
  • \n

    KMS key ID

    \n
  • \n
  • \n

    KMS key alias

    \n
  • \n
  • \n

    ARN referring to the KMS key ID

    \n
  • \n
  • \n

    ARN referring to the KMS key alias

    \n
  • \n
\n

If encrypted is true but a KMS key ID is not specified, the\n customer's default KMS key for Amazon EBS is used.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a replication run.

" - } - }, - "com.amazonaws.sms#ReplicationRunId": { - "type": "string" - }, - "com.amazonaws.sms#ReplicationRunLimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sms#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ReplicationRunLimitExceeded", - "httpResponseCode": 429 - }, - "smithy.api#documentation": "

You have exceeded the number of on-demand replication runs you can request in a\n 24-hour period.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.sms#ReplicationRunList": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#ReplicationRun", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.sms#ReplicationRunStage": { - "type": "string" - }, - "com.amazonaws.sms#ReplicationRunStageDetails": { - "type": "structure", - "members": { - "stage": { - "target": "com.amazonaws.sms#ReplicationRunStage", - "traits": { - "smithy.api#documentation": "

The current stage of a replication run.

" - } - }, - "stageProgress": { - "target": "com.amazonaws.sms#ReplicationRunStageProgress", - "traits": { - "smithy.api#documentation": "

The progress of the current stage of a replication run.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details of the current stage of a replication run.

" - } - }, - "com.amazonaws.sms#ReplicationRunStageProgress": { - "type": "string" - }, - "com.amazonaws.sms#ReplicationRunState": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "Missed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MISSED" - } - }, - "Active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "Deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "Deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - } - }, - "com.amazonaws.sms#ReplicationRunStatusMessage": { - "type": "string" - }, - "com.amazonaws.sms#ReplicationRunType": { - "type": "enum", - "members": { - "OnDemand": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ON_DEMAND" - } - }, - "Automatic": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTOMATIC" - } - } - } - }, - "com.amazonaws.sms#RoleName": { - "type": "string" - }, - "com.amazonaws.sms#RunOnce": { - "type": "boolean" - }, - "com.amazonaws.sms#S3BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - } - } - }, - "com.amazonaws.sms#S3KeyName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.sms#S3Location": { - "type": "structure", - "members": { - "bucket": { - "target": "com.amazonaws.sms#S3BucketName", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket name.

" - } - }, - "key": { - "target": "com.amazonaws.sms#S3KeyName", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket key.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Location of an Amazon S3 object.

" - } - }, - "com.amazonaws.sms#SSMOutput": { - "type": "structure", - "members": { - "s3Location": { - "target": "com.amazonaws.sms#S3Location" - } - }, - "traits": { - "smithy.api#documentation": "

Contains the location of validation output.

" - } - }, - "com.amazonaws.sms#SSMValidationParameters": { - "type": "structure", - "members": { - "source": { - "target": "com.amazonaws.sms#Source", - "traits": { - "smithy.api#documentation": "

The location of the validation script.

" - } - }, - "instanceId": { - "target": "com.amazonaws.sms#InstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the instance. The instance must have the following tag: UserForSMSApplicationValidation=true.

" - } - }, - "scriptType": { - "target": "com.amazonaws.sms#ScriptType", - "traits": { - "smithy.api#documentation": "

The type of validation script.

" - } - }, - "command": { - "target": "com.amazonaws.sms#Command", - "traits": { - "smithy.api#documentation": "

The command to run the validation script.

" - } - }, - "executionTimeoutSeconds": { - "target": "com.amazonaws.sms#ExecutionTimeoutSeconds", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The timeout interval, in seconds.

" - } - }, - "outputS3BucketName": { - "target": "com.amazonaws.sms#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the S3 bucket for output.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains validation parameters.

" - } - }, - "com.amazonaws.sms#ScriptType": { - "type": "enum", - "members": { - "SHELL_SCRIPT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHELL_SCRIPT" - } - }, - "POWERSHELL_SCRIPT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POWERSHELL_SCRIPT" - } - } - } - }, - "com.amazonaws.sms#SecurityGroup": { - "type": "string" - }, - "com.amazonaws.sms#Server": { - "type": "structure", - "members": { - "serverId": { - "target": "com.amazonaws.sms#ServerId", - "traits": { - "smithy.api#documentation": "

The ID of the server.

" - } - }, - "serverType": { - "target": "com.amazonaws.sms#ServerType", - "traits": { - "smithy.api#documentation": "

The type of server.

" - } - }, - "vmServer": { - "target": "com.amazonaws.sms#VmServer", - "traits": { - "smithy.api#documentation": "

Information about the VM server.

" - } - }, - "replicationJobId": { - "target": "com.amazonaws.sms#ReplicationJobId", - "traits": { - "smithy.api#documentation": "

The ID of the replication job.

" - } - }, - "replicationJobTerminated": { - "target": "com.amazonaws.sms#ReplicationJobTerminated", - "traits": { - "smithy.api#documentation": "

Indicates whether the replication job is deleted or failed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a server.

" - } - }, - "com.amazonaws.sms#ServerCannotBeReplicatedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sms#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ServerCannotBeReplicated", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified server cannot be replicated.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.sms#ServerCatalogStatus": { - "type": "enum", - "members": { - "NotImported": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_IMPORTED" - } - }, - "Importing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORTING" - } - }, - "Available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "Deleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "Expired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPIRED" - } - } - } - }, - "com.amazonaws.sms#ServerGroup": { - "type": "structure", - "members": { - "serverGroupId": { - "target": "com.amazonaws.sms#ServerGroupId", - "traits": { - "smithy.api#documentation": "

The ID of a server group.

" - } - }, - "name": { - "target": "com.amazonaws.sms#ServerGroupName", - "traits": { - "smithy.api#documentation": "

The name of a server group.

" - } - }, - "serverList": { - "target": "com.amazonaws.sms#ServerList", - "traits": { - "smithy.api#documentation": "

The servers that belong to a server group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Logical grouping of servers.

" - } - }, - "com.amazonaws.sms#ServerGroupId": { - "type": "string" - }, - "com.amazonaws.sms#ServerGroupLaunchConfiguration": { - "type": "structure", - "members": { - "serverGroupId": { - "target": "com.amazonaws.sms#ServerGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the server group with which the launch configuration is\n associated.

" - } - }, - "launchOrder": { - "target": "com.amazonaws.sms#LaunchOrder", - "traits": { - "smithy.api#documentation": "

The launch order of servers in the server group.

" - } - }, - "serverLaunchConfigurations": { - "target": "com.amazonaws.sms#ServerLaunchConfigurations", - "traits": { - "smithy.api#documentation": "

The launch configuration for servers in the server group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Launch configuration for a server group.

" - } - }, - "com.amazonaws.sms#ServerGroupLaunchConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#ServerGroupLaunchConfiguration" - } - }, - "com.amazonaws.sms#ServerGroupName": { - "type": "string" - }, - "com.amazonaws.sms#ServerGroupReplicationConfiguration": { - "type": "structure", - "members": { - "serverGroupId": { - "target": "com.amazonaws.sms#ServerGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the server group with which this replication configuration is\n associated.

" - } - }, - "serverReplicationConfigurations": { - "target": "com.amazonaws.sms#ServerReplicationConfigurations", - "traits": { - "smithy.api#documentation": "

The replication configuration for servers in the server group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Replication configuration for a server group.

" - } - }, - "com.amazonaws.sms#ServerGroupReplicationConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#ServerGroupReplicationConfiguration" - } - }, - "com.amazonaws.sms#ServerGroupValidationConfiguration": { - "type": "structure", - "members": { - "serverGroupId": { - "target": "com.amazonaws.sms#ServerGroupId", - "traits": { - "smithy.api#documentation": "

The ID of the server group.

" - } - }, - "serverValidationConfigurations": { - "target": "com.amazonaws.sms#ServerValidationConfigurations", - "traits": { - "smithy.api#documentation": "

The validation configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration for validating an instance.

" - } - }, - "com.amazonaws.sms#ServerGroupValidationConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#ServerGroupValidationConfiguration" - } - }, - "com.amazonaws.sms#ServerGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#ServerGroup" - } - }, - "com.amazonaws.sms#ServerId": { - "type": "string" - }, - "com.amazonaws.sms#ServerLaunchConfiguration": { - "type": "structure", - "members": { - "server": { - "target": "com.amazonaws.sms#Server", - "traits": { - "smithy.api#documentation": "

The ID of the server with which the launch configuration is associated.

" - } - }, - "logicalId": { - "target": "com.amazonaws.sms#LogicalId", - "traits": { - "smithy.api#documentation": "

The logical ID of the server in the CloudFormation template.

" - } - }, - "vpc": { - "target": "com.amazonaws.sms#VPC", - "traits": { - "smithy.api#documentation": "

The ID of the VPC into which the server should be launched.

" - } - }, - "subnet": { - "target": "com.amazonaws.sms#Subnet", - "traits": { - "smithy.api#documentation": "

The ID of the subnet the server should be launched into.

" - } - }, - "securityGroup": { - "target": "com.amazonaws.sms#SecurityGroup", - "traits": { - "smithy.api#documentation": "

The ID of the security group that applies to the launched server.

" - } - }, - "ec2KeyName": { - "target": "com.amazonaws.sms#EC2KeyName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon EC2 SSH key to be used for connecting to the launched server.

" - } - }, - "userData": { - "target": "com.amazonaws.sms#UserData", - "traits": { - "smithy.api#documentation": "

Location of the user-data script to be executed when launching the server.

" - } - }, - "instanceType": { - "target": "com.amazonaws.sms#InstanceType", - "traits": { - "smithy.api#documentation": "

The instance type to use when launching the server.

" - } - }, - "associatePublicIpAddress": { - "target": "com.amazonaws.sms#AssociatePublicIpAddress", - "traits": { - "smithy.api#documentation": "

Indicates whether a publicly accessible IP address is created when launching the server.

" - } - }, - "iamInstanceProfileName": { - "target": "com.amazonaws.sms#RoleName", - "traits": { - "smithy.api#documentation": "

The name of the IAM instance profile.

" - } - }, - "configureScript": { - "target": "com.amazonaws.sms#S3Location" - }, - "configureScriptType": { - "target": "com.amazonaws.sms#ScriptType", - "traits": { - "smithy.api#documentation": "

The type of configuration script.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Launch configuration for a server.

" - } - }, - "com.amazonaws.sms#ServerLaunchConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#ServerLaunchConfiguration" - } - }, - "com.amazonaws.sms#ServerList": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#Server", - "traits": { - "smithy.api#xmlName": "item" - } - } - }, - "com.amazonaws.sms#ServerReplicationConfiguration": { - "type": "structure", - "members": { - "server": { - "target": "com.amazonaws.sms#Server", - "traits": { - "smithy.api#documentation": "

The ID of the server with which this replication configuration is\n associated.

" - } - }, - "serverReplicationParameters": { - "target": "com.amazonaws.sms#ServerReplicationParameters", - "traits": { - "smithy.api#documentation": "

The parameters for replicating the server.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Replication configuration of a server.

" - } - }, - "com.amazonaws.sms#ServerReplicationConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#ServerReplicationConfiguration" - } - }, - "com.amazonaws.sms#ServerReplicationParameters": { - "type": "structure", - "members": { - "seedTime": { - "target": "com.amazonaws.sms#Timestamp", - "traits": { - "smithy.api#documentation": "

The seed time for creating a replication job for the server.

" - } - }, - "frequency": { - "target": "com.amazonaws.sms#Frequency", - "traits": { - "smithy.api#documentation": "

The frequency of creating replication jobs for the server.

" - } - }, - "runOnce": { - "target": "com.amazonaws.sms#RunOnce", - "traits": { - "smithy.api#documentation": "

Indicates whether to run the replication job one time.

" - } - }, - "licenseType": { - "target": "com.amazonaws.sms#LicenseType", - "traits": { - "smithy.api#documentation": "

The license type for creating a replication job for the server.

" - } - }, - "numberOfRecentAmisToKeep": { - "target": "com.amazonaws.sms#NumberOfRecentAmisToKeep", - "traits": { - "smithy.api#documentation": "

The number of recent AMIs to keep when creating a replication job for this server.

" - } - }, - "encrypted": { - "target": "com.amazonaws.sms#Encrypted", - "traits": { - "smithy.api#documentation": "

Indicates whether the replication job produces encrypted AMIs.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.sms#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The ID of the KMS key for replication jobs that produce encrypted AMIs. \n This value can be any of the following:

\n
    \n
  • \n

    KMS key ID

    \n
  • \n
  • \n

    KMS key alias

    \n
  • \n
  • \n

    ARN referring to the KMS key ID

    \n
  • \n
  • \n

    ARN referring to the KMS key alias

    \n
  • \n
\n

If encrypted is enabled but a KMS key ID is not specified, the\n customer's default KMS key for Amazon EBS is used.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The replication parameters for replicating a server.

" - } - }, - "com.amazonaws.sms#ServerType": { - "type": "enum", - "members": { - "VirtualMachine": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VIRTUAL_MACHINE" - } - } - } - }, - "com.amazonaws.sms#ServerValidationConfiguration": { - "type": "structure", - "members": { - "server": { - "target": "com.amazonaws.sms#Server" - }, - "validationId": { - "target": "com.amazonaws.sms#ValidationId", - "traits": { - "smithy.api#documentation": "

The ID of the validation.

" - } - }, - "name": { - "target": "com.amazonaws.sms#NonEmptyStringWithMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the configuration.

" - } - }, - "serverValidationStrategy": { - "target": "com.amazonaws.sms#ServerValidationStrategy", - "traits": { - "smithy.api#documentation": "

The validation strategy.

" - } - }, - "userDataValidationParameters": { - "target": "com.amazonaws.sms#UserDataValidationParameters", - "traits": { - "smithy.api#documentation": "

The validation parameters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration for validating an instance.

" - } - }, - "com.amazonaws.sms#ServerValidationConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#ServerValidationConfiguration" - } - }, - "com.amazonaws.sms#ServerValidationOutput": { - "type": "structure", - "members": { - "server": { - "target": "com.amazonaws.sms#Server" - } - }, - "traits": { - "smithy.api#documentation": "

Contains output from validating an instance.

" - } - }, - "com.amazonaws.sms#ServerValidationStrategy": { - "type": "enum", - "members": { - "USERDATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USERDATA" - } - } - } - }, - "com.amazonaws.sms#Source": { - "type": "structure", - "members": { - "s3Location": { - "target": "com.amazonaws.sms#S3Location" - } - }, - "traits": { - "smithy.api#documentation": "

Contains the location of a validation script.

" - } - }, - "com.amazonaws.sms#StackId": { - "type": "string" - }, - "com.amazonaws.sms#StackName": { - "type": "string" - }, - "com.amazonaws.sms#StartAppReplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#StartAppReplicationRequest" - }, - "output": { - "target": "com.amazonaws.sms#StartAppReplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts replicating the specified application by creating replication jobs for each server in the\n application.

" - } - }, - "com.amazonaws.sms#StartAppReplicationRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#StartAppReplicationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#StartOnDemandAppReplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#StartOnDemandAppReplicationRequest" - }, - "output": { - "target": "com.amazonaws.sms#StartOnDemandAppReplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an on-demand replication run for the specified application.

" - } - }, - "com.amazonaws.sms#StartOnDemandAppReplicationRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.sms#Description", - "traits": { - "smithy.api#documentation": "

The description of the replication run.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#StartOnDemandAppReplicationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#StartOnDemandReplicationRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#StartOnDemandReplicationRunRequest" - }, - "output": { - "target": "com.amazonaws.sms#StartOnDemandReplicationRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#DryRunOperationException" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#ReplicationRunLimitExceededException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an on-demand replication run for the specified replication job. This\n replication run starts immediately. This replication run is in addition to the ones\n already scheduled.

\n

There is a limit on the number of on-demand replications runs that you can request\n in a 24-hour period.

" - } - }, - "com.amazonaws.sms#StartOnDemandReplicationRunRequest": { - "type": "structure", - "members": { - "replicationJobId": { - "target": "com.amazonaws.sms#ReplicationJobId", - "traits": { - "smithy.api#documentation": "

The ID of the replication job.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.sms#Description", - "traits": { - "smithy.api#documentation": "

The description of the replication run.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#StartOnDemandReplicationRunResponse": { - "type": "structure", - "members": { - "replicationRunId": { - "target": "com.amazonaws.sms#ReplicationRunId", - "traits": { - "smithy.api#documentation": "

The ID of the replication run.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#StopAppReplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#StopAppReplicationRequest" - }, - "output": { - "target": "com.amazonaws.sms#StopAppReplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops replicating the specified application by deleting the replication job for each server in\n the application.

" - } - }, - "com.amazonaws.sms#StopAppReplicationRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#StopAppReplicationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#Subnet": { - "type": "string" - }, - "com.amazonaws.sms#Tag": { - "type": "structure", - "members": { - "key": { - "target": "com.amazonaws.sms#TagKey", - "traits": { - "smithy.api#documentation": "

The tag key.

" - } - }, - "value": { - "target": "com.amazonaws.sms#TagValue", - "traits": { - "smithy.api#documentation": "

The tag value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Key/value pair that can be assigned to an application.

" - } - }, - "com.amazonaws.sms#TagKey": { - "type": "string" - }, - "com.amazonaws.sms#TagValue": { - "type": "string" - }, - "com.amazonaws.sms#Tags": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#Tag" - } - }, - "com.amazonaws.sms#TemporarilyUnavailableException": { - "type": "structure", - "members": {}, - "traits": { - "aws.protocols#awsQueryError": { - "code": "TemporarilyUnavailable", - "httpResponseCode": 503 - }, - "smithy.api#documentation": "

The service is temporarily unavailable.

", - "smithy.api#error": "server", - "smithy.api#httpError": 503 - } - }, - "com.amazonaws.sms#TerminateApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#TerminateAppRequest" - }, - "output": { - "target": "com.amazonaws.sms#TerminateAppResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Terminates the stack for the specified application.

" - } - }, - "com.amazonaws.sms#TerminateAppRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#TerminateAppResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.sms#TotalServerGroups": { - "type": "integer" - }, - "com.amazonaws.sms#TotalServers": { - "type": "integer" - }, - "com.amazonaws.sms#UnauthorizedOperationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sms#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "UnauthorizedOperation", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

You lack permissions needed to perform this operation. Check your IAM policies,\n and ensure that you are using the correct access keys.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.sms#UpdateApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#UpdateAppRequest" - }, - "output": { - "target": "com.amazonaws.sms#UpdateAppResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the specified application.

" - } - }, - "com.amazonaws.sms#UpdateAppRequest": { - "type": "structure", - "members": { - "appId": { - "target": "com.amazonaws.sms#AppId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - }, - "name": { - "target": "com.amazonaws.sms#AppName", - "traits": { - "smithy.api#documentation": "

The new name of the application.

" - } - }, - "description": { - "target": "com.amazonaws.sms#AppDescription", - "traits": { - "smithy.api#documentation": "

The new description of the application.

" - } - }, - "roleName": { - "target": "com.amazonaws.sms#RoleName", - "traits": { - "smithy.api#documentation": "

The name of the service role in the customer's account used by Server Migration Service.

" - } - }, - "serverGroups": { - "target": "com.amazonaws.sms#ServerGroups", - "traits": { - "smithy.api#documentation": "

The server groups in the application to update.

" - } - }, - "tags": { - "target": "com.amazonaws.sms#Tags", - "traits": { - "smithy.api#documentation": "

The tags to associate with the application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#UpdateAppResponse": { - "type": "structure", - "members": { - "appSummary": { - "target": "com.amazonaws.sms#AppSummary", - "traits": { - "smithy.api#documentation": "

A summary description of the application.

" - } - }, - "serverGroups": { - "target": "com.amazonaws.sms#ServerGroups", - "traits": { - "smithy.api#documentation": "

The updated server groups in the application.

" - } - }, - "tags": { - "target": "com.amazonaws.sms#Tags", - "traits": { - "smithy.api#documentation": "

The tags associated with the application.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#UpdateReplicationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.sms#UpdateReplicationJobRequest" - }, - "output": { - "target": "com.amazonaws.sms#UpdateReplicationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.sms#InternalError" - }, - { - "target": "com.amazonaws.sms#InvalidParameterException" - }, - { - "target": "com.amazonaws.sms#MissingRequiredParameterException" - }, - { - "target": "com.amazonaws.sms#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.sms#ReplicationJobNotFoundException" - }, - { - "target": "com.amazonaws.sms#ServerCannotBeReplicatedException" - }, - { - "target": "com.amazonaws.sms#TemporarilyUnavailableException" - }, - { - "target": "com.amazonaws.sms#UnauthorizedOperationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the specified settings for the specified replication job.

" - } - }, - "com.amazonaws.sms#UpdateReplicationJobRequest": { - "type": "structure", - "members": { - "replicationJobId": { - "target": "com.amazonaws.sms#ReplicationJobId", - "traits": { - "smithy.api#documentation": "

The ID of the replication job.

", - "smithy.api#required": {} - } - }, - "frequency": { - "target": "com.amazonaws.sms#Frequency", - "traits": { - "smithy.api#documentation": "

The time between consecutive replication runs, in hours.

" - } - }, - "nextReplicationRunStartTime": { - "target": "com.amazonaws.sms#Timestamp", - "traits": { - "smithy.api#documentation": "

The start time of the next replication run.

" - } - }, - "licenseType": { - "target": "com.amazonaws.sms#LicenseType", - "traits": { - "smithy.api#documentation": "

The license type to be used for the AMI created by a successful replication\n run.

" - } - }, - "roleName": { - "target": "com.amazonaws.sms#RoleName", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to be used by Server Migration Service.

" - } - }, - "description": { - "target": "com.amazonaws.sms#Description", - "traits": { - "smithy.api#documentation": "

The description of the replication job.

" - } - }, - "numberOfRecentAmisToKeep": { - "target": "com.amazonaws.sms#NumberOfRecentAmisToKeep", - "traits": { - "smithy.api#documentation": "

The maximum number of SMS-created AMIs to retain. The oldest is deleted after the\n maximum number is reached and a new AMI is created.

" - } - }, - "encrypted": { - "target": "com.amazonaws.sms#Encrypted", - "traits": { - "smithy.api#documentation": "

When true, the replication job produces encrypted AMIs. For more information,\n KmsKeyId.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.sms#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The ID of the KMS key for replication jobs that produce encrypted AMIs. \n This value can be any of the following:

\n
    \n
  • \n

    KMS key ID

    \n
  • \n
  • \n

    KMS key alias

    \n
  • \n
  • \n

    ARN referring to the KMS key ID

    \n
  • \n
  • \n

    ARN referring to the KMS key alias

    \n
  • \n
\n

If encrypted is enabled but a KMS key ID is not specified, the\n customer's default KMS key for Amazon EBS is used.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.sms#UpdateReplicationJobResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.sms#UserData": { - "type": "structure", - "members": { - "s3Location": { - "target": "com.amazonaws.sms#S3Location", - "traits": { - "smithy.api#documentation": "

Amazon S3 location of the user-data script.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A script that runs on first launch of an Amazon EC2 instance. Used for configuring the\n server during launch.

" - } - }, - "com.amazonaws.sms#UserDataValidationParameters": { - "type": "structure", - "members": { - "source": { - "target": "com.amazonaws.sms#Source", - "traits": { - "smithy.api#documentation": "

The location of the validation script.

" - } - }, - "scriptType": { - "target": "com.amazonaws.sms#ScriptType", - "traits": { - "smithy.api#documentation": "

The type of validation script.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains validation parameters.

" - } - }, - "com.amazonaws.sms#VPC": { - "type": "string" - }, - "com.amazonaws.sms#ValidationId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^val-[0-9a-f]{17}$" - } - }, - "com.amazonaws.sms#ValidationOutput": { - "type": "structure", - "members": { - "validationId": { - "target": "com.amazonaws.sms#ValidationId", - "traits": { - "smithy.api#documentation": "

The ID of the validation.

" - } - }, - "name": { - "target": "com.amazonaws.sms#NonEmptyStringWithMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the validation.

" - } - }, - "status": { - "target": "com.amazonaws.sms#ValidationStatus", - "traits": { - "smithy.api#documentation": "

The status of the validation.

" - } - }, - "statusMessage": { - "target": "com.amazonaws.sms#ValidationStatusMessage", - "traits": { - "smithy.api#documentation": "

The status message.

" - } - }, - "latestValidationTime": { - "target": "com.amazonaws.sms#Timestamp", - "traits": { - "smithy.api#documentation": "

The latest time that the validation was performed.

" - } - }, - "appValidationOutput": { - "target": "com.amazonaws.sms#AppValidationOutput", - "traits": { - "smithy.api#documentation": "

The output from validating an application.

" - } - }, - "serverValidationOutput": { - "target": "com.amazonaws.sms#ServerValidationOutput", - "traits": { - "smithy.api#documentation": "

The output from validation an instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains validation output.

" - } - }, - "com.amazonaws.sms#ValidationOutputList": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#ValidationOutput" - } - }, - "com.amazonaws.sms#ValidationStatus": { - "type": "enum", - "members": { - "ReadyForValidation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READY_FOR_VALIDATION" - } - }, - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "InProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.sms#ValidationStatusMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2500 - } - } - }, - "com.amazonaws.sms#VmId": { - "type": "string" - }, - "com.amazonaws.sms#VmManagerId": { - "type": "string" - }, - "com.amazonaws.sms#VmManagerName": { - "type": "string" - }, - "com.amazonaws.sms#VmManagerType": { - "type": "enum", - "members": { - "vSphere": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VSPHERE" - } - }, - "scvmm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCVMM" - } - }, - "hyperVManager": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HYPERV-MANAGER" - } - } - } - }, - "com.amazonaws.sms#VmName": { - "type": "string" - }, - "com.amazonaws.sms#VmPath": { - "type": "string" - }, - "com.amazonaws.sms#VmServer": { - "type": "structure", - "members": { - "vmServerAddress": { - "target": "com.amazonaws.sms#VmServerAddress", - "traits": { - "smithy.api#documentation": "

The VM server location.

" - } - }, - "vmName": { - "target": "com.amazonaws.sms#VmName", - "traits": { - "smithy.api#documentation": "

The name of the VM.

" - } - }, - "vmManagerName": { - "target": "com.amazonaws.sms#VmManagerName", - "traits": { - "smithy.api#documentation": "

The name of the VM manager.

" - } - }, - "vmManagerType": { - "target": "com.amazonaws.sms#VmManagerType", - "traits": { - "smithy.api#documentation": "

The type of VM management product.

" - } - }, - "vmPath": { - "target": "com.amazonaws.sms#VmPath", - "traits": { - "smithy.api#documentation": "

The VM folder path in the vCenter Server virtual machine inventory tree.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a VM server.

" - } - }, - "com.amazonaws.sms#VmServerAddress": { - "type": "structure", - "members": { - "vmManagerId": { - "target": "com.amazonaws.sms#VmManagerId", - "traits": { - "smithy.api#documentation": "

The ID of the VM manager.

" - } - }, - "vmId": { - "target": "com.amazonaws.sms#VmId", - "traits": { - "smithy.api#documentation": "

The ID of the VM.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a VM server location.

" - } - }, - "com.amazonaws.sms#VmServerAddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.sms#VmServerAddress" - } - } - } -} diff --git a/codegen/sdk/aws-models/snow-device-management.json b/codegen/sdk/aws-models/snow-device-management.json index 81f64cd5c55..ecf766f2539 100644 --- a/codegen/sdk/aws-models/snow-device-management.json +++ b/codegen/sdk/aws-models/snow-device-management.json @@ -2233,17 +2233,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2257,17 +2246,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2281,17 +2259,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2305,17 +2272,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/snowball.json b/codegen/sdk/aws-models/snowball.json index 72c739a4769..f23e9292302 100644 --- a/codegen/sdk/aws-models/snowball.json +++ b/codegen/sdk/aws-models/snowball.json @@ -1108,17 +1108,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1132,17 +1121,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1156,17 +1134,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1180,17 +1147,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -1611,7 +1567,7 @@ "SnowballType": { "target": "com.amazonaws.snowball#SnowballType", "traits": { - "smithy.api#documentation": "

The type of Snowcone device to use for this cluster.\n

\n \n

For cluster jobs, Amazon Web Services Snow Family currently supports only the\n EDGE device type.

\n
" + "smithy.api#documentation": "

The type of Snowball Edge device to use for this cluster.\n

\n \n

For cluster jobs, Amazon Web Services Snow Family currently supports only the\n EDGE device type.

\n
" } }, "CreationDate": { @@ -2157,7 +2113,7 @@ "DeviceConfiguration": { "target": "com.amazonaws.snowball#DeviceConfiguration", "traits": { - "smithy.api#documentation": "

Defines the device configuration for an Snowcone job.

\n

For more information, see\n \"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide or\n \"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide.

" + "smithy.api#documentation": "

Defines the device configuration for an Snowball Edge job.

\n

For more information, see\n \"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide or\n \"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide.

" } }, "RemoteManagement": { @@ -2724,7 +2680,7 @@ "SnowconeDeviceConfiguration": { "target": "com.amazonaws.snowball#SnowconeDeviceConfiguration", "traits": { - "smithy.api#documentation": "

Returns information about the device configuration for an Snowcone\n job.

" + "smithy.api#documentation": "

Returns information about the device configuration for an Snowball Edge\n job.

" } } }, @@ -4896,12 +4852,12 @@ "WirelessConnection": { "target": "com.amazonaws.snowball#WirelessConnection", "traits": { - "smithy.api#documentation": "

Configures the wireless connection for the Snowcone device.

" + "smithy.api#documentation": "

Configures the wireless connection for the Snowball Edge device.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies the device configuration for an Snowcone job.

" + "smithy.api#documentation": "

Specifies the device configuration for an Snowball Edge job.

" } }, "com.amazonaws.snowball#SnsTopicARN": { @@ -5381,12 +5337,12 @@ "target": "com.amazonaws.snowball#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Enables the Wi-Fi adapter on an Snowcone device.

" + "smithy.api#documentation": "

Enables the Wi-Fi adapter on an Snowball Edge device.

" } } }, "traits": { - "smithy.api#documentation": "

Configures the wireless connection on an Snowcone device.

" + "smithy.api#documentation": "

Configures the wireless connection on an Snowball Edge device.

" } } } diff --git a/codegen/sdk/aws-models/sns.json b/codegen/sdk/aws-models/sns.json index 715a1bce859..77ed79b9a78 100644 --- a/codegen/sdk/aws-models/sns.json +++ b/codegen/sdk/aws-models/sns.json @@ -1141,17 +1141,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1165,17 +1154,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1189,17 +1167,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1213,17 +1180,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/socialmessaging.json b/codegen/sdk/aws-models/socialmessaging.json index 30e60f7d9b3..5ec1c08b5ef 100644 --- a/codegen/sdk/aws-models/socialmessaging.json +++ b/codegen/sdk/aws-models/socialmessaging.json @@ -3037,17 +3037,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3061,17 +3050,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3085,17 +3063,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3109,17 +3076,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/sqs.json b/codegen/sdk/aws-models/sqs.json index 21d8282d0bb..de09e813c27 100644 --- a/codegen/sdk/aws-models/sqs.json +++ b/codegen/sdk/aws-models/sqs.json @@ -1064,17 +1064,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1088,17 +1077,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1112,17 +1090,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1136,17 +1103,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -1634,7 +1590,7 @@ "Attributes": { "target": "com.amazonaws.sqs#QueueAttributeMap", "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 CreateQueue action uses:

\n
    \n
  • \n

    \n DelaySeconds – The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 seconds (15 minutes). Default: 0.

    \n
  • \n
  • \n

    \n MaximumMessageSize – The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).

    \n
  • \n
  • \n

    \n MessageRetentionPeriod – The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1\n minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.

    \n
  • \n
  • \n

    \n Policy – The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the IAM User Guide.

    \n
  • \n
  • \n

    \n ReceiveMessageWaitTimeSeconds – The length of time, in\n seconds, for which a \n ReceiveMessage\n action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.

    \n
  • \n
  • \n

    \n VisibilityTimeout – The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.

    \n
  • \n
\n

The following attributes apply only to dead-letter queues:\n

\n
    \n
  • \n

    \n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:

    \n
      \n
    • \n

      \n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

      \n
    • \n
    • \n

      \n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.

      \n
    • \n
    \n
  • \n
  • \n

    \n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

    \n
      \n
    • \n

      \n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:

      \n
        \n
      • \n

        \n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.

        \n
      • \n
      • \n

        \n denyAll – No source queues can specify this queue as the dead-letter\n queue.

        \n
      • \n
      • \n

        \n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.

        \n
      • \n
      \n
    • \n
    • \n

      \n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.

      \n
    • \n
    \n
  • \n
\n \n

The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.

\n
\n

The following attributes apply 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 SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is\n always alias/aws/sqs, the alias of a custom CMK can, for example,\n be alias/MyAlias\n . For more examples, see\n KeyId in the Key Management Service API\n Reference.

    \n
  • \n
  • \n

    \n KmsDataKeyReusePeriodSeconds – The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?\n

    \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

The following attributes apply only to FIFO (first-in-first-out)\n queues:

\n
    \n
  • \n

    \n FifoQueue – Designates a queue as FIFO. Valid values are\n true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You\n can provide this attribute only during queue creation. You can't change it for\n an existing queue. When you set this attribute, you must also provide the\n MessageGroupId for your messages explicitly.

    \n

    For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.

    \n
  • \n
  • \n

    \n ContentBasedDeduplication – Enables content-based\n deduplication. Valid values are true and false. For\n more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:

    \n
      \n
    • \n

      Every message must have a unique\n MessageDeduplicationId.

      \n
        \n
      • \n

        You may provide a MessageDeduplicationId\n explicitly.

        \n
      • \n
      • \n

        If you aren't able to provide a\n MessageDeduplicationId and you enable\n ContentBasedDeduplication for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the\n message (but not the attributes of the message).

        \n
      • \n
      • \n

        If you don't provide a MessageDeduplicationId and\n the queue doesn't have ContentBasedDeduplication\n set, the action fails with an error.

        \n
      • \n
      • \n

        If the queue has ContentBasedDeduplication set,\n your MessageDeduplicationId overrides the generated\n one.

        \n
      • \n
      \n
    • \n
    • \n

      When ContentBasedDeduplication is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.

      \n
    • \n
    • \n

      If you send one message with ContentBasedDeduplication\n enabled and then another message with a\n MessageDeduplicationId that is the same as the one\n generated for the first MessageDeduplicationId, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.

      \n
    • \n
    \n
  • \n
\n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n
    \n
  • \n

    \n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.

    \n
  • \n
  • \n

    \n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

    \n
  • \n
\n

To enable high throughput for FIFO queues, do the following:

\n
    \n
  • \n

    Set DeduplicationScope to messageGroup.

    \n
  • \n
  • \n

    Set FifoThroughputLimit to perMessageGroupId.

    \n
  • \n
\n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.

", + "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 CreateQueue action uses:

\n
    \n
  • \n

    \n DelaySeconds – The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 seconds (15 minutes). Default: 0.

    \n
  • \n
  • \n

    \n MaximumMessageSize – The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) to 1,048,576 bytes (1 MiB). Default: 1,048,576 bytes (1 MiB).

    \n
  • \n
  • \n

    \n MessageRetentionPeriod – The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1\n minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.

    \n
  • \n
  • \n

    \n Policy – The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the IAM User Guide.

    \n
  • \n
  • \n

    \n ReceiveMessageWaitTimeSeconds – The length of time, in\n seconds, for which a \n ReceiveMessage\n action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.

    \n
  • \n
  • \n

    \n VisibilityTimeout – The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.

    \n
  • \n
\n

The following attributes apply only to dead-letter queues:\n

\n
    \n
  • \n

    \n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:

    \n
      \n
    • \n

      \n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

      \n
    • \n
    • \n

      \n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.

      \n
    • \n
    \n
  • \n
  • \n

    \n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

    \n
      \n
    • \n

      \n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:

      \n
        \n
      • \n

        \n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.

        \n
      • \n
      • \n

        \n denyAll – No source queues can specify this queue as the dead-letter\n queue.

        \n
      • \n
      • \n

        \n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.

        \n
      • \n
      \n
    • \n
    • \n

      \n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.

      \n
    • \n
    \n
  • \n
\n \n

The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.

\n
\n

The following attributes apply 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 SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is\n always alias/aws/sqs, the alias of a custom CMK can, for example,\n be alias/MyAlias\n . For more examples, see\n KeyId in the Key Management Service API\n Reference.

    \n
  • \n
  • \n

    \n KmsDataKeyReusePeriodSeconds – The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?\n

    \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

The following attributes apply only to FIFO (first-in-first-out)\n queues:

\n
    \n
  • \n

    \n FifoQueue – Designates a queue as FIFO. Valid values are\n true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You\n can provide this attribute only during queue creation. You can't change it for\n an existing queue. When you set this attribute, you must also provide the\n MessageGroupId for your messages explicitly.

    \n

    For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.

    \n
  • \n
  • \n

    \n ContentBasedDeduplication – Enables content-based\n deduplication. Valid values are true and false. For\n more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:

    \n
      \n
    • \n

      Every message must have a unique\n MessageDeduplicationId.

      \n
        \n
      • \n

        You may provide a MessageDeduplicationId\n explicitly.

        \n
      • \n
      • \n

        If you aren't able to provide a\n MessageDeduplicationId and you enable\n ContentBasedDeduplication for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the\n message (but not the attributes of the message).

        \n
      • \n
      • \n

        If you don't provide a MessageDeduplicationId and\n the queue doesn't have ContentBasedDeduplication\n set, the action fails with an error.

        \n
      • \n
      • \n

        If the queue has ContentBasedDeduplication set,\n your MessageDeduplicationId overrides the generated\n one.

        \n
      • \n
      \n
    • \n
    • \n

      When ContentBasedDeduplication is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.

      \n
    • \n
    • \n

      If you send one message with ContentBasedDeduplication\n enabled and then another message with a\n MessageDeduplicationId that is the same as the one\n generated for the first MessageDeduplicationId, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.

      \n
    • \n
    \n
  • \n
\n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n
    \n
  • \n

    \n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.

    \n
  • \n
  • \n

    \n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

    \n
  • \n
\n

To enable high throughput for FIFO queues, do the following:

\n
    \n
  • \n

    Set DeduplicationScope to messageGroup.

    \n
  • \n
  • \n

    Set FifoThroughputLimit to perMessageGroupId.

    \n
  • \n
\n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.

", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" } @@ -2764,7 +2720,7 @@ } }, "traits": { - "smithy.api#documentation": "

The user-specified message attribute value. For string data types, the\n Value attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.\n

\n

\n Name, type, value and the message body must not\n be empty or null. All parts of the message attribute, including Name,\n Type, and Value, are part of the message size restriction\n (256 KiB or 262,144 bytes).

" + "smithy.api#documentation": "

The user-specified message attribute value. For string data types, the\n Value attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.\n

\n

\n Name, type, value and the message body must not\n be empty or null. All parts of the message attribute, including Name,\n Type, and Value, are part of the message size restriction\n (1 MiB or 1,048,576 bytes).

" } }, "com.amazonaws.sqs#MessageBodyAttributeMap": { @@ -3543,7 +3499,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

If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.

\n
" } }, "com.amazonaws.sqs#SendMessageBatch": { @@ -3608,7 +3564,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 1 MiB \n 1,048,576 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

If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.

\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": { @@ -3791,7 +3747,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 \n 1 MiB or 1,048,576 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

If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.

\n
", "smithy.api#required": {} } }, @@ -3925,7 +3881,7 @@ "Attributes": { "target": "com.amazonaws.sqs#QueueAttributeMap", "traits": { - "smithy.api#documentation": "

A map of attributes to set.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the SetQueueAttributes action uses:

\n
    \n
  • \n

    \n DelaySeconds – The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 (15 minutes). Default: 0.

    \n
  • \n
  • \n

    \n MaximumMessageSize – The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).

    \n
  • \n
  • \n

    \n MessageRetentionPeriod – The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer representing seconds,\n from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.

    \n
  • \n
  • \n

    \n Policy – The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the Identity and Access Management User\n Guide.

    \n
  • \n
  • \n

    \n ReceiveMessageWaitTimeSeconds – The length of time, in\n seconds, for which a \n ReceiveMessage\n action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.

    \n
  • \n
  • \n

    \n VisibilityTimeout – The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.

    \n
  • \n
\n

The following attributes apply only to dead-letter queues:\n

\n
    \n
  • \n

    \n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:

    \n
      \n
    • \n

      \n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

      \n
    • \n
    • \n

      \n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.

      \n
    • \n
    \n
  • \n
  • \n

    \n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

    \n
      \n
    • \n

      \n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:

      \n
        \n
      • \n

        \n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.

        \n
      • \n
      • \n

        \n denyAll – No source queues can specify this queue as the dead-letter\n queue.

        \n
      • \n
      • \n

        \n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.

        \n
      • \n
      \n
    • \n
    • \n

      \n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.

      \n
    • \n
    \n
  • \n
\n \n

The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.

\n
\n

The following attributes apply 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 SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is\n always alias/aws/sqs, the alias of a custom CMK can, for example,\n be alias/MyAlias\n . For more examples, see\n KeyId in the Key Management Service API\n Reference.

    \n
  • \n
  • \n

    \n KmsDataKeyReusePeriodSeconds – The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?.

    \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

The following attribute applies only to FIFO (first-in-first-out)\n queues:

\n
    \n
  • \n

    \n ContentBasedDeduplication – Enables content-based\n deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:

    \n
      \n
    • \n

      Every message must have a unique\n MessageDeduplicationId.

      \n
        \n
      • \n

        You may provide a MessageDeduplicationId\n explicitly.

        \n
      • \n
      • \n

        If you aren't able to provide a\n MessageDeduplicationId and you enable\n ContentBasedDeduplication for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the\n message (but not the attributes of the message).

        \n
      • \n
      • \n

        If you don't provide a MessageDeduplicationId and\n the queue doesn't have ContentBasedDeduplication\n set, the action fails with an error.

        \n
      • \n
      • \n

        If the queue has ContentBasedDeduplication set,\n your MessageDeduplicationId overrides the generated\n one.

        \n
      • \n
      \n
    • \n
    • \n

      When ContentBasedDeduplication is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.

      \n
    • \n
    • \n

      If you send one message with ContentBasedDeduplication\n enabled and then another message with a\n MessageDeduplicationId that is the same as the one\n generated for the first MessageDeduplicationId, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.

      \n
    • \n
    \n
  • \n
\n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n
    \n
  • \n

    \n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.

    \n
  • \n
  • \n

    \n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

    \n
  • \n
\n

To enable high throughput for FIFO queues, do the following:

\n
    \n
  • \n

    Set DeduplicationScope to messageGroup.

    \n
  • \n
  • \n

    Set FifoThroughputLimit to perMessageGroupId.

    \n
  • \n
\n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.

", + "smithy.api#documentation": "

A map of attributes to set.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the SetQueueAttributes action uses:

\n
    \n
  • \n

    \n DelaySeconds – The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 (15 minutes). Default: 0.

    \n
  • \n
  • \n

    \n MaximumMessageSize – The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) up to 1,048,576 bytes (1 MiB). Default: 1,048,576 bytes (1 MiB).

    \n
  • \n
  • \n

    \n MessageRetentionPeriod – The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer representing seconds,\n from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.

    \n
  • \n
  • \n

    \n Policy – The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the Identity and Access Management User\n Guide.

    \n
  • \n
  • \n

    \n ReceiveMessageWaitTimeSeconds – The length of time, in\n seconds, for which a \n ReceiveMessage\n action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.

    \n
  • \n
  • \n

    \n VisibilityTimeout – The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.

    \n
  • \n
\n

The following attributes apply only to dead-letter queues:\n

\n
    \n
  • \n

    \n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:

    \n
      \n
    • \n

      \n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

      \n
    • \n
    • \n

      \n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.

      \n
    • \n
    \n
  • \n
  • \n

    \n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

    \n
      \n
    • \n

      \n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:

      \n
        \n
      • \n

        \n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.

        \n
      • \n
      • \n

        \n denyAll – No source queues can specify this queue as the dead-letter\n queue.

        \n
      • \n
      • \n

        \n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.

        \n
      • \n
      \n
    • \n
    • \n

      \n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.

      \n
    • \n
    \n
  • \n
\n \n

The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.

\n
\n

The following attributes apply 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 SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is\n always alias/aws/sqs, the alias of a custom CMK can, for example,\n be alias/MyAlias\n . For more examples, see\n KeyId in the Key Management Service API\n Reference.

    \n
  • \n
  • \n

    \n KmsDataKeyReusePeriodSeconds – The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?.

    \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

The following attribute applies only to FIFO (first-in-first-out)\n queues:

\n
    \n
  • \n

    \n ContentBasedDeduplication – Enables content-based\n deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:

    \n
      \n
    • \n

      Every message must have a unique\n MessageDeduplicationId.

      \n
        \n
      • \n

        You may provide a MessageDeduplicationId\n explicitly.

        \n
      • \n
      • \n

        If you aren't able to provide a\n MessageDeduplicationId and you enable\n ContentBasedDeduplication for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the\n message (but not the attributes of the message).

        \n
      • \n
      • \n

        If you don't provide a MessageDeduplicationId and\n the queue doesn't have ContentBasedDeduplication\n set, the action fails with an error.

        \n
      • \n
      • \n

        If the queue has ContentBasedDeduplication set,\n your MessageDeduplicationId overrides the generated\n one.

        \n
      • \n
      \n
    • \n
    • \n

      When ContentBasedDeduplication is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.

      \n
    • \n
    • \n

      If you send one message with ContentBasedDeduplication\n enabled and then another message with a\n MessageDeduplicationId that is the same as the one\n generated for the first MessageDeduplicationId, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.

      \n
    • \n
    \n
  • \n
\n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n
    \n
  • \n

    \n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.

    \n
  • \n
  • \n

    \n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.

    \n
  • \n
\n

To enable high throughput for FIFO queues, do the following:

\n
    \n
  • \n

    Set DeduplicationScope to messageGroup.

    \n
  • \n
  • \n

    Set FifoThroughputLimit to perMessageGroupId.

    \n
  • \n
\n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.

", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" diff --git a/codegen/sdk/aws-models/ssm-contacts.json b/codegen/sdk/aws-models/ssm-contacts.json index 9de76c79d04..fe2823a3db6 100644 --- a/codegen/sdk/aws-models/ssm-contacts.json +++ b/codegen/sdk/aws-models/ssm-contacts.json @@ -289,7 +289,7 @@ "RetryIntervalInMinutes": { "target": "com.amazonaws.ssmcontacts#RetryIntervalInMinutes", "traits": { - "smithy.api#documentation": "

The number of minutes to wait to retry sending engagement in the case the engagement\n initially fails.

" + "smithy.api#documentation": "

The number of minutes to wait before retrying to send engagement if the engagement\n initially failed.

" } } }, @@ -382,7 +382,7 @@ "Type": { "target": "com.amazonaws.ssmcontacts#ContactType", "traits": { - "smithy.api#documentation": "

Refers to the type of contact. A single contact is type PERSONAL and an\n escalation plan is type ESCALATION.

", + "smithy.api#documentation": "

The type of contact.

\n
    \n
  • \n

    \n PERSONAL: A single, individual contact.

    \n
  • \n
  • \n

    \n ESCALATION: An escalation plan.

    \n
  • \n
  • \n

    \n ONCALL_SCHEDULE: An on-call schedule.

    \n
  • \n
", "smithy.api#required": {} } } @@ -716,7 +716,7 @@ "Type": { "target": "com.amazonaws.ssmcontacts#ContactType", "traits": { - "smithy.api#documentation": "

To create an escalation plan use ESCALATION. To create a contact use\n PERSONAL.

", + "smithy.api#documentation": "

The type of contact to create.

\n
    \n
  • \n

    \n PERSONAL: A single, individual contact.

    \n
  • \n
  • \n

    \n ESCALATION: An escalation plan.

    \n
  • \n
  • \n

    \n ONCALL_SCHEDULE: An on-call schedule.

    \n
  • \n
", "smithy.api#required": {} } }, @@ -894,7 +894,7 @@ "ContactIds": { "target": "com.amazonaws.ssmcontacts#RotationContactsArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the contacts to add to the rotation.

\n

The order that you list the contacts in is their shift order in the rotation schedule.\n To change the order of the contact's shifts, use the UpdateRotation\n operation.

", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the contacts to add to the rotation.

\n \n

Only the PERSONAL contact type is supported. The contact types\n ESCALATION and ONCALL_SCHEDULE are not supported for this\n operation.

\n
\n

The order that you list the contacts in is their shift order in the rotation schedule.\n To change the order of the contact's shifts, use the UpdateRotation\n operation.

", "smithy.api#required": {} } }, @@ -907,7 +907,7 @@ "TimeZoneId": { "target": "com.amazonaws.ssmcontacts#TimeZoneId", "traits": { - "smithy.api#documentation": "

The time zone to base the rotation’s activity on in Internet Assigned Numbers Authority\n (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For more\n information, see the Time Zone\n Database on the IANA website.

\n \n

Designators for time zones that don’t support Daylight Savings Time rules, such as\n Pacific Standard Time (PST) and Pacific Daylight Time (PDT), are not supported.

\n
", + "smithy.api#documentation": "

The time zone to base the rotation’s activity on in Internet Assigned Numbers Authority\n (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For more\n information, see the Time Zone\n Database on the IANA website.

\n \n

Designators for time zones that don’t support Daylight Savings Time rules, such as\n Pacific Standard Time (PST), are not supported.

\n
", "smithy.api#required": {} } }, @@ -1114,7 +1114,7 @@ } ], "traits": { - "smithy.api#documentation": "

To remove a contact from Incident Manager, you can delete the contact. Deleting a contact\n removes them from all escalation plans and related response plans. Deleting an escalation\n plan removes it from all related response plans. You will have to recreate the contact and\n its contact channels before you can use it again.

" + "smithy.api#documentation": "

To remove a contact from Incident Manager, you can delete the contact. However, deleting a\n contact does not remove it from escalation plans and related response plans. Deleting an\n escalation plan also does not remove it from all related response plans. To modify an\n escalation plan, we recommend using the UpdateContact action to specify a\n different existing contact.

" } }, "com.amazonaws.ssmcontacts#DeleteContactChannel": { @@ -1143,7 +1143,7 @@ } ], "traits": { - "smithy.api#documentation": "

To no longer receive engagements on a contact channel, you can delete the channel from a\n contact. Deleting the contact channel removes it from the contact's engagement plan. If you\n delete the only contact channel for a contact, you won't be able to engage that contact\n during an incident.

" + "smithy.api#documentation": "

To stop receiving engagements on a contact channel, you can delete the channel from a\n contact. Deleting the contact channel does not remove it from the contact's engagement\n plan, but the stage that includes the channel will be ignored. If you delete the only\n contact channel for a contact, you'll no longer be able to engage that contact during an\n incident.

" } }, "com.amazonaws.ssmcontacts#DeleteContactChannelRequest": { @@ -1869,7 +1869,7 @@ "Type": { "target": "com.amazonaws.ssmcontacts#ContactType", "traits": { - "smithy.api#documentation": "

The type of contact, either PERSONAL or ESCALATION.

", + "smithy.api#documentation": "

The type of contact.

", "smithy.api#required": {} } }, @@ -2297,7 +2297,7 @@ "Type": { "target": "com.amazonaws.ssmcontacts#ContactType", "traits": { - "smithy.api#documentation": "

The type of contact. A contact is type PERSONAL and an escalation plan is\n type ESCALATION.

" + "smithy.api#documentation": "

The type of contact.

" } } }, @@ -3154,7 +3154,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags of an escalation plan or contact.

" + "smithy.api#documentation": "

Lists the tags of a contact, escalation plan, rotation, or on-call schedule.

" } }, "com.amazonaws.ssmcontacts#ListTagsForResourceRequest": { @@ -3163,7 +3163,7 @@ "ResourceARN": { "target": "com.amazonaws.ssmcontacts#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact or escalation plan.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact, escalation plan, rotation, or on-call\n schedule.

", "smithy.api#required": {} } } @@ -3588,14 +3588,14 @@ "NumberOfOnCalls": { "target": "com.amazonaws.ssmcontacts#NumberOfOnCalls", "traits": { - "smithy.api#documentation": "

The number of contacts, or shift team members designated to be on call concurrently\n during a shift. For example, in an on-call schedule containing ten contacts, a value of\n 2 designates that two of them are on call at any given time.

", + "smithy.api#documentation": "

The number of contacts, or shift team members designated to be on call concurrently\n during a shift. For example, in an on-call schedule that contains ten contacts, a value of\n 2 designates that two of them are on call at any given time.

", "smithy.api#required": {} } }, "ShiftCoverages": { "target": "com.amazonaws.ssmcontacts#ShiftCoveragesMap", "traits": { - "smithy.api#documentation": "

Information about the days of the week included in on-call rotation coverage.

" + "smithy.api#documentation": "

Information about the days of the week that the on-call rotation coverage\n includes.

" } }, "RecurrenceMultiplier": { @@ -4503,17 +4503,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4527,17 +4516,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4551,17 +4529,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4575,17 +4542,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5208,13 +5164,13 @@ "ChannelTargetInfo": { "target": "com.amazonaws.ssmcontacts#ChannelTargetInfo", "traits": { - "smithy.api#documentation": "

Information about the contact channel Incident Manager is engaging.

" + "smithy.api#documentation": "

Information about the contact channel that Incident Manager engages.

" } }, "ContactTargetInfo": { "target": "com.amazonaws.ssmcontacts#ContactTargetInfo", "traits": { - "smithy.api#documentation": "

Information about the contact that Incident Manager is engaging.

" + "smithy.api#documentation": "

Information about the contact that Incident Manager engages.

" } } }, @@ -5535,7 +5491,7 @@ "ContactIds": { "target": "com.amazonaws.ssmcontacts#RotationContactsArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation.

\n

The order in which you list the contacts is their shift order in the rotation\n schedule.

" + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation.

\n \n

Only the PERSONAL contact type is supported. The contact types\n ESCALATION and ONCALL_SCHEDULE are not supported for this\n operation.

\n
\n

The order in which you list the contacts is their shift order in the rotation\n schedule.

" } }, "StartTime": { @@ -5547,7 +5503,7 @@ "TimeZoneId": { "target": "com.amazonaws.ssmcontacts#TimeZoneId", "traits": { - "smithy.api#documentation": "

The time zone to base the updated rotation’s activity on, in Internet Assigned Numbers\n Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For\n more information, see the Time Zone\n Database on the IANA website.

\n \n

Designators for time zones that don’t support Daylight Savings Time Rules, such as\n Pacific Standard Time (PST) and Pacific Daylight Time (PDT), aren't supported.

\n
" + "smithy.api#documentation": "

The time zone to base the updated rotation’s activity on, in Internet Assigned Numbers\n Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For\n more information, see the Time Zone\n Database on the IANA website.

\n \n

Designators for time zones that don’t support Daylight Savings Time Rules, such as\n Pacific Standard Time (PST), aren't supported.

\n
" } }, "Recurrence": { diff --git a/codegen/sdk/aws-models/ssm-guiconnect.json b/codegen/sdk/aws-models/ssm-guiconnect.json index e9258014e60..c712fb40c3e 100644 --- a/codegen/sdk/aws-models/ssm-guiconnect.json +++ b/codegen/sdk/aws-models/ssm-guiconnect.json @@ -973,17 +973,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -997,17 +986,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1021,17 +999,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1045,17 +1012,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/ssm-incidents.json b/codegen/sdk/aws-models/ssm-incidents.json index 5cc6a2fadff..095fab5029f 100644 --- a/codegen/sdk/aws-models/ssm-incidents.json +++ b/codegen/sdk/aws-models/ssm-incidents.json @@ -4417,17 +4417,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4441,17 +4430,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4465,17 +4443,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4489,17 +4456,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/ssm-quicksetup.json b/codegen/sdk/aws-models/ssm-quicksetup.json index 82995476bad..ac6b91978b9 100644 --- a/codegen/sdk/aws-models/ssm-quicksetup.json +++ b/codegen/sdk/aws-models/ssm-quicksetup.json @@ -1760,17 +1760,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1784,17 +1773,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1808,17 +1786,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1832,17 +1799,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/ssm-sap.json b/codegen/sdk/aws-models/ssm-sap.json index e437809fe89..f5bddeadfb6 100644 --- a/codegen/sdk/aws-models/ssm-sap.json +++ b/codegen/sdk/aws-models/ssm-sap.json @@ -96,7 +96,7 @@ "AssociatedApplicationArns": { "target": "com.amazonaws.ssmsap#ApplicationArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names of the associated AWS Systems Manager for SAP\n applications.

" + "smithy.api#documentation": "

The Amazon Resource Names of the associated AWS Systems Manager for SAP applications.

" } } }, @@ -130,7 +130,7 @@ "SecretId": { "target": "com.amazonaws.ssmsap#SecretId", "traits": { - "smithy.api#documentation": "

The secret ID created in AWS Secrets Manager to store the credentials of the SAP\n application.

", + "smithy.api#documentation": "

The secret ID created in AWS Secrets Manager to store the credentials of the SAP application.

", "smithy.api#required": {} } } @@ -284,7 +284,7 @@ } }, "traits": { - "smithy.api#documentation": "

The summary of the SAP application registered with AWS Systems Manager for SAP.\n

" + "smithy.api#documentation": "

The summary of the SAP application registered with AWS Systems Manager for SAP.

" } }, "com.amazonaws.ssmsap#ApplicationSummaryList": { @@ -310,6 +310,12 @@ } } }, + "com.amazonaws.ssmsap#ApplicationTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#ApplicationType" + } + }, "com.amazonaws.ssmsap#Arn": { "type": "string", "traits": { @@ -367,7 +373,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration parameters for AWS Backint Agent for SAP HANA. You can backup your SAP\n HANA database with AWS Backup or Amazon S3.

" + "smithy.api#documentation": "

Configuration parameters for AWS Backint Agent for SAP HANA. You can backup your SAP HANA database with AWS Backup or Amazon S3.

" } }, "com.amazonaws.ssmsap#BackintMode": { @@ -440,13 +446,13 @@ "ParentComponent": { "target": "com.amazonaws.ssmsap#ComponentId", "traits": { - "smithy.api#documentation": "

The parent component of a highly available environment. For example, in a highly\n available SAP on AWS workload, the parent component consists of the entire setup,\n including the child components.

" + "smithy.api#documentation": "

The parent component of a highly available environment. For example, in a highly available SAP on AWS workload, the parent component consists of the entire setup, including the child components.

" } }, "ChildComponents": { "target": "com.amazonaws.ssmsap#ComponentIdList", "traits": { - "smithy.api#documentation": "

The child components of a highly available environment. For example, in a highly\n available SAP on AWS workload, the child component consists of the primary and secondar\n instances.

" + "smithy.api#documentation": "

The child components of a highly available environment. For example, in a highly available SAP on AWS workload, the child component consists of the primary and secondar instances.

" } }, "ApplicationId": { @@ -464,7 +470,7 @@ "Status": { "target": "com.amazonaws.ssmsap#ComponentStatus", "traits": { - "smithy.api#documentation": "

The status of the component.

\n
    \n
  • \n

    ACTIVATED - this status has been deprecated.

    \n
  • \n
  • \n

    STARTING - the component is in the process of being started.

    \n
  • \n
  • \n

    STOPPED - the component is not running.

    \n
  • \n
  • \n

    STOPPING - the component is in the process of being stopped.

    \n
  • \n
  • \n

    RUNNING - the component is running.

    \n
  • \n
  • \n

    RUNNING_WITH_ERROR - one or more child component(s) of the parent component is not\n running. Call \n GetComponent\n to review the status of each child\n component.

    \n
  • \n
  • \n

    UNDEFINED - AWS Systems Manager for SAP cannot provide the component status\n based on the discovered information. Verify your SAP application.

    \n
  • \n
" + "smithy.api#documentation": "

The status of the component.

  • ACTIVATED - this status has been deprecated.

  • STARTING - the component is in the process of being started.

  • STOPPED - the component is not running.

  • STOPPING - the component is in the process of being stopped.

  • RUNNING - the component is running.

  • RUNNING_WITH_ERROR - one or more child component(s) of the parent component is not running. Call GetComponent to review the status of each child component.

  • UNDEFINED - AWS Systems Manager for SAP cannot provide the component status based on the discovered information. Verify your SAP application.

" } }, "SapHostname": { @@ -578,27 +584,27 @@ "ComponentType": { "target": "com.amazonaws.ssmsap#ComponentType", "traits": { - "smithy.api#documentation": "

This string is the type of the component.

\n

Accepted value is WD.

", + "smithy.api#documentation": "

This string is the type of the component.

Accepted value is WD.

", "smithy.api#required": {} } }, "Sid": { "target": "com.amazonaws.ssmsap#SID", "traits": { - "smithy.api#documentation": "

This string is the SAP System ID of the component.

\n

Accepted values are alphanumeric.

", + "smithy.api#documentation": "

This string is the SAP System ID of the component.

Accepted values are alphanumeric.

", "smithy.api#required": {} } }, "Ec2InstanceId": { "target": "com.amazonaws.ssmsap#InstanceId", "traits": { - "smithy.api#documentation": "

This is the Amazon EC2 instance on which your SAP component is running.

\n

Accepted values are alphanumeric.

", + "smithy.api#documentation": "

This is the Amazon EC2 instance on which your SAP component is running.

Accepted values are alphanumeric.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

This is information about the component of \n your SAP application, such as Web Dispatcher.

" + "smithy.api#documentation": "

This is information about the component of your SAP application, such as Web Dispatcher.

" } }, "com.amazonaws.ssmsap#ComponentInfoList": { @@ -757,6 +763,164 @@ } } }, + "com.amazonaws.ssmsap#ConfigurationCheckDefinition": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ssmsap#ConfigurationCheckType", + "traits": { + "smithy.api#documentation": "

The unique identifier of the configuration check.

" + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the configuration check.

" + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A description of what the configuration check validates.

" + } + }, + "ApplicableApplicationTypes": { + "target": "com.amazonaws.ssmsap#ApplicationTypeList", + "traits": { + "smithy.api#documentation": "

The list of SSMSAP application types that this configuration check can be evaluated against.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a configuration check definition supported by AWS Systems Manager for SAP.

" + } + }, + "com.amazonaws.ssmsap#ConfigurationCheckDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#ConfigurationCheckDefinition" + } + }, + "com.amazonaws.ssmsap#ConfigurationCheckOperation": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ssmsap#OperationId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the configuration check operation.

" + } + }, + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application against which the configuration check was performed.

" + } + }, + "Status": { + "target": "com.amazonaws.ssmsap#OperationStatus", + "traits": { + "smithy.api#documentation": "

The current status of the configuration check operation.

" + } + }, + "StatusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A message providing additional details about the status of the configuration check operation.

" + } + }, + "ConfigurationCheckId": { + "target": "com.amazonaws.ssmsap#ConfigurationCheckType", + "traits": { + "smithy.api#documentation": "

The unique identifier of the configuration check that was performed.

" + } + }, + "ConfigurationCheckName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the configuration check that was performed.

" + } + }, + "ConfigurationCheckDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A description of the configuration check that was performed.

" + } + }, + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the configuration check operation started.

" + } + }, + "EndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the configuration check operation completed.

" + } + }, + "RuleStatusCounts": { + "target": "com.amazonaws.ssmsap#RuleStatusCounts", + "traits": { + "smithy.api#documentation": "

A summary of all the rule results, showing counts for each status type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a configuration check operation that has been executed against an application.

" + } + }, + "com.amazonaws.ssmsap#ConfigurationCheckOperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#ConfigurationCheckOperation" + } + }, + "com.amazonaws.ssmsap#ConfigurationCheckOperationListingMode": { + "type": "enum", + "members": { + "ALL_OPERATIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_OPERATIONS" + } + }, + "LATEST_PER_CHECK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATEST_PER_CHECK" + } + } + } + }, + "com.amazonaws.ssmsap#ConfigurationCheckType": { + "type": "enum", + "members": { + "SAP_CHECK_01": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAP_CHECK_01" + } + }, + "SAP_CHECK_02": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAP_CHECK_02" + } + }, + "SAP_CHECK_03": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAP_CHECK_03" + } + } + } + }, + "com.amazonaws.ssmsap#ConfigurationCheckTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#ConfigurationCheckType" + } + }, "com.amazonaws.ssmsap#ConflictException": { "type": "structure", "members": { @@ -864,12 +1028,12 @@ "ConnectedComponentArns": { "target": "com.amazonaws.ssmsap#ComponentArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names of the connected AWS Systems Manager for SAP\n components.

" + "smithy.api#documentation": "

The Amazon Resource Names of the connected AWS Systems Manager for SAP components.

" } } }, "traits": { - "smithy.api#documentation": "

The SAP HANA database of the application registered with AWS Systems Manager for\n SAP.

" + "smithy.api#documentation": "

The SAP HANA database of the application registered with AWS Systems Manager for SAP.

" } }, "com.amazonaws.ssmsap#DatabaseConnection": { @@ -1131,7 +1295,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deregister an SAP application with AWS Systems Manager for SAP. This action does not\n affect the existing setup of your SAP workloads on Amazon EC2.

", + "smithy.api#documentation": "

Deregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1168,7 +1332,7 @@ "Value": { "target": "com.amazonaws.ssmsap#FilterValue", "traits": { - "smithy.api#documentation": "

The filter values. Filter values are case-sensitive. If you specify multiple values for\n a filter, the values are joined with an OR, and the request returns all results that match\n any of the specified values

", + "smithy.api#documentation": "

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values

", "smithy.api#required": {} } }, @@ -1254,7 +1418,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets an application registered with AWS Systems Manager for SAP. It also returns the\n components of the application.

", + "smithy.api#documentation": "

Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1292,7 +1456,7 @@ "Application": { "target": "com.amazonaws.ssmsap#Application", "traits": { - "smithy.api#documentation": "

Returns all of the metadata of an application registered with AWS Systems Manager for\n SAP.

" + "smithy.api#documentation": "

Returns all of the metadata of an application registered with AWS Systems Manager for SAP.

" } }, "Tags": { @@ -1323,7 +1487,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the component of an application registered with AWS Systems Manager for\n SAP.

", + "smithy.api#documentation": "

Gets the component of an application registered with AWS Systems Manager for SAP.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1368,6 +1532,61 @@ } } }, + "com.amazonaws.ssmsap#GetConfigurationCheckOperation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#GetConfigurationCheckOperationInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#GetConfigurationCheckOperationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the details of a configuration check operation by specifying the operation ID.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/get-configuration-check-operation" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmsap#GetConfigurationCheckOperationInput": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.ssmsap#OperationId", + "traits": { + "smithy.api#documentation": "

The ID of the configuration check operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmsap#GetConfigurationCheckOperationOutput": { + "type": "structure", + "members": { + "ConfigurationCheckOperation": { + "target": "com.amazonaws.ssmsap#ConfigurationCheckOperation", + "traits": { + "smithy.api#documentation": "

Returns the details of a configuration check operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ssmsap#GetDatabase": { "type": "operation", "input": { @@ -1385,7 +1604,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the SAP HANA database of an application registered with AWS Systems Manager for\n SAP.

", + "smithy.api#documentation": "

Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1429,7 +1648,7 @@ "Database": { "target": "com.amazonaws.ssmsap#Database", "traits": { - "smithy.api#documentation": "

The SAP HANA database of an application registered with AWS Systems Manager for\n SAP.

" + "smithy.api#documentation": "

The SAP HANA database of an application registered with AWS Systems Manager for SAP.

" } }, "Tags": { @@ -1736,7 +1955,7 @@ "target": "com.amazonaws.ssmsap#MaxResults", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.

" + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" } }, "Filters": { @@ -1759,7 +1978,7 @@ "NextToken": { "target": "com.amazonaws.ssmsap#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" } } } @@ -1821,7 +2040,7 @@ "target": "com.amazonaws.ssmsap#MaxResults", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.

\n

If you do not specify a value for MaxResults, the request returns 50 items per page by\n default.

" + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If you do not specify a value for MaxResults, the request returns 50 items per page by default.

" } } } @@ -1838,152 +2057,153 @@ "NextToken": { "target": "com.amazonaws.ssmsap#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" } } } }, - "com.amazonaws.ssmsap#ListDatabases": { + "com.amazonaws.ssmsap#ListConfigurationCheckDefinitions": { "type": "operation", "input": { - "target": "com.amazonaws.ssmsap#ListDatabasesInput" + "target": "com.amazonaws.ssmsap#ListConfigurationCheckDefinitionsInput" }, "output": { - "target": "com.amazonaws.ssmsap#ListDatabasesOutput" + "target": "com.amazonaws.ssmsap#ListConfigurationCheckDefinitionsOutput" }, "errors": [ { "target": "com.amazonaws.ssmsap#InternalServerException" }, - { - "target": "com.amazonaws.ssmsap#ResourceNotFoundException" - }, { "target": "com.amazonaws.ssmsap#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Lists the SAP HANA databases of an application registered with AWS Systems Manager for\n SAP.

", + "smithy.api#documentation": "

Lists all configuration check types supported by AWS Systems Manager for SAP.

", "smithy.api#http": { "code": 200, "method": "POST", - "uri": "/list-databases" + "uri": "/list-configuration-check-definitions" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", - "items": "Databases" + "items": "ConfigurationChecks" }, "smithy.api#readonly": {} } }, - "com.amazonaws.ssmsap#ListDatabasesInput": { + "com.amazonaws.ssmsap#ListConfigurationCheckDefinitionsInput": { "type": "structure", "members": { - "ApplicationId": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

" - } - }, - "ComponentId": { - "target": "com.amazonaws.ssmsap#ComponentId", + "MaxResults": { + "target": "com.amazonaws.ssmsap#MaxResults", "traits": { - "smithy.api#documentation": "

The ID of the component.

" + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" } }, "NextToken": { "target": "com.amazonaws.ssmsap#NextToken", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ssmsap#MaxResults", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining\n results, make another call with the returned nextToken value. If you do not specify a value\n for MaxResults, the request returns 50 items per page by default.

" + "smithy.api#documentation": "

The token for the next page of results.

" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.ssmsap#ListDatabasesOutput": { + "com.amazonaws.ssmsap#ListConfigurationCheckDefinitionsOutput": { "type": "structure", "members": { - "Databases": { - "target": "com.amazonaws.ssmsap#DatabaseSummaryList", + "ConfigurationChecks": { + "target": "com.amazonaws.ssmsap#ConfigurationCheckDefinitionList", "traits": { - "smithy.api#documentation": "

The SAP HANA databases of an application.

" + "smithy.api#documentation": "

The configuration check types supported by AWS Systems Manager for SAP.

" } }, "NextToken": { "target": "com.amazonaws.ssmsap#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.ssmsap#ListOperationEvents": { + "com.amazonaws.ssmsap#ListConfigurationCheckOperations": { "type": "operation", "input": { - "target": "com.amazonaws.ssmsap#ListOperationEventsInput" + "target": "com.amazonaws.ssmsap#ListConfigurationCheckOperationsInput" }, "output": { - "target": "com.amazonaws.ssmsap#ListOperationEventsOutput" + "target": "com.amazonaws.ssmsap#ListConfigurationCheckOperationsOutput" }, "errors": [ { "target": "com.amazonaws.ssmsap#InternalServerException" }, + { + "target": "com.amazonaws.ssmsap#ResourceNotFoundException" + }, { "target": "com.amazonaws.ssmsap#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Returns a list of operations events.

\n

Available parameters include OperationID, as well as optional parameters\n MaxResults, NextToken, and Filters.

", + "smithy.api#documentation": "

Lists the configuration check operations performed by AWS Systems Manager for SAP.

", "smithy.api#http": { "code": 200, "method": "POST", - "uri": "/list-operation-events" + "uri": "/list-configuration-check-operations" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", - "items": "OperationEvents" + "items": "ConfigurationCheckOperations" }, "smithy.api#readonly": {} } }, - "com.amazonaws.ssmsap#ListOperationEventsInput": { + "com.amazonaws.ssmsap#ListConfigurationCheckOperationsInput": { "type": "structure", "members": { - "OperationId": { - "target": "com.amazonaws.ssmsap#OperationId", + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", "traits": { - "smithy.api#documentation": "

The ID of the operation.

", + "smithy.api#documentation": "

The ID of the application.

", "smithy.api#required": {} } }, + "ListMode": { + "target": "com.amazonaws.ssmsap#ConfigurationCheckOperationListingMode", + "traits": { + "smithy.api#default": "LATEST_PER_CHECK", + "smithy.api#documentation": "

The mode for listing configuration check operations. Defaults to \"LATEST_PER_CHECK\".

  • LATEST_PER_CHECK - Will list the latest configuration check operation per check type.

  • ALL_OPERATIONS - Will list all configuration check operations performed on the application.

" + } + }, "MaxResults": { "target": "com.amazonaws.ssmsap#MaxResults", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.

\n

If you do not specify a value for MaxResults, the request returns 50 items\n per page by default.

" + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" } }, "NextToken": { "target": "com.amazonaws.ssmsap#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" + "smithy.api#documentation": "

The token for the next page of results.

" } }, "Filters": { "target": "com.amazonaws.ssmsap#FilterList", "traits": { - "smithy.api#documentation": "

Optionally specify filters to narrow the returned operation event items.

\n

Valid filter names include status, resourceID, and\n resourceType. The valid operator for all three filters is\n Equals.

" + "smithy.api#documentation": "

The filters of an operation.

" } } }, @@ -1991,19 +2211,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.ssmsap#ListOperationEventsOutput": { + "com.amazonaws.ssmsap#ListConfigurationCheckOperationsOutput": { "type": "structure", "members": { - "OperationEvents": { - "target": "com.amazonaws.ssmsap#OperationEventList", + "ConfigurationCheckOperations": { + "target": "com.amazonaws.ssmsap#ConfigurationCheckOperationList", "traits": { - "smithy.api#documentation": "

A returned list of operation events that meet the filter criteria.

" + "smithy.api#documentation": "

The configuration check operations performed by AWS Systems Manager for SAP.

" } }, "NextToken": { "target": "com.amazonaws.ssmsap#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, @@ -2011,53 +2231,54 @@ "smithy.api#output": {} } }, - "com.amazonaws.ssmsap#ListOperations": { + "com.amazonaws.ssmsap#ListDatabases": { "type": "operation", "input": { - "target": "com.amazonaws.ssmsap#ListOperationsInput" + "target": "com.amazonaws.ssmsap#ListDatabasesInput" }, "output": { - "target": "com.amazonaws.ssmsap#ListOperationsOutput" + "target": "com.amazonaws.ssmsap#ListDatabasesOutput" }, "errors": [ { "target": "com.amazonaws.ssmsap#InternalServerException" }, + { + "target": "com.amazonaws.ssmsap#ResourceNotFoundException" + }, { "target": "com.amazonaws.ssmsap#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Lists the operations performed by AWS Systems Manager for SAP.

", + "smithy.api#documentation": "

Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.

", "smithy.api#http": { "code": 200, "method": "POST", - "uri": "/list-operations" + "uri": "/list-databases" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", - "items": "Operations" + "items": "Databases" }, "smithy.api#readonly": {} } }, - "com.amazonaws.ssmsap#ListOperationsInput": { + "com.amazonaws.ssmsap#ListDatabasesInput": { "type": "structure", "members": { "ApplicationId": { "target": "com.amazonaws.ssmsap#ApplicationId", "traits": { - "smithy.api#documentation": "

The ID of the application.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the application.

" } }, - "MaxResults": { - "target": "com.amazonaws.ssmsap#MaxResults", + "ComponentId": { + "target": "com.amazonaws.ssmsap#ComponentId", "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining\n results, make another call with the returned nextToken value. If you do not specify a value\n for MaxResults, the request returns 50 items per page by default.

" + "smithy.api#documentation": "

The ID of the component.

" } }, "NextToken": { @@ -2066,15 +2287,182 @@ "smithy.api#documentation": "

The token for the next page of results.

" } }, - "Filters": { - "target": "com.amazonaws.ssmsap#FilterList", + "MaxResults": { + "target": "com.amazonaws.ssmsap#MaxResults", "traits": { - "smithy.api#documentation": "

The filters of an operation.

" + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.

" } } } }, - "com.amazonaws.ssmsap#ListOperationsOutput": { + "com.amazonaws.ssmsap#ListDatabasesOutput": { + "type": "structure", + "members": { + "Databases": { + "target": "com.amazonaws.ssmsap#DatabaseSummaryList", + "traits": { + "smithy.api#documentation": "

The SAP HANA databases of an application.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + } + }, + "com.amazonaws.ssmsap#ListOperationEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#ListOperationEventsInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#ListOperationEventsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of operations events.

Available parameters include OperationID, as well as optional parameters MaxResults, NextToken, and Filters.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-operation-events" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "OperationEvents" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmsap#ListOperationEventsInput": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.ssmsap#OperationId", + "traits": { + "smithy.api#documentation": "

The ID of the operation.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ssmsap#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If you do not specify a value for MaxResults, the request returns 50 items per page by default.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + } + }, + "Filters": { + "target": "com.amazonaws.ssmsap#FilterList", + "traits": { + "smithy.api#documentation": "

Optionally specify filters to narrow the returned operation event items.

Valid filter names include status, resourceID, and resourceType. The valid operator for all three filters is Equals.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmsap#ListOperationEventsOutput": { + "type": "structure", + "members": { + "OperationEvents": { + "target": "com.amazonaws.ssmsap#OperationEventList", + "traits": { + "smithy.api#documentation": "

A returned list of operation events that meet the filter criteria.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmsap#ListOperations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#ListOperationsInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#ListOperationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the operations performed by AWS Systems Manager for SAP.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-operations" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Operations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmsap#ListOperationsInput": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ssmsap#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "Filters": { + "target": "com.amazonaws.ssmsap#FilterList", + "traits": { + "smithy.api#documentation": "

The filters of an operation.

" + } + } + } + }, + "com.amazonaws.ssmsap#ListOperationsOutput": { "type": "structure", "members": { "Operations": { @@ -2086,9 +2474,169 @@ "NextToken": { "target": "com.amazonaws.ssmsap#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + } + }, + "com.amazonaws.ssmsap#ListSubCheckResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#ListSubCheckResultsInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#ListSubCheckResultsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the sub-check results of a specified configuration check operation.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-sub-check-results" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "SubCheckResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmsap#ListSubCheckResultsInput": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.ssmsap#OperationId", + "traits": { + "smithy.api#documentation": "

The ID of the configuration check operation.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ssmsap#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" } } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmsap#ListSubCheckResultsOutput": { + "type": "structure", + "members": { + "SubCheckResults": { + "target": "com.amazonaws.ssmsap#SubCheckResultList", + "traits": { + "smithy.api#documentation": "

The sub-check results of a configuration check operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmsap#ListSubCheckRuleResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#ListSubCheckRuleResultsInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#ListSubCheckRuleResultsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the rules of a specified sub-check belonging to a configuration check operation.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-sub-check-rule-results" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "RuleResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmsap#ListSubCheckRuleResultsInput": { + "type": "structure", + "members": { + "SubCheckResultId": { + "target": "com.amazonaws.ssmsap#SubCheckResultId", + "traits": { + "smithy.api#documentation": "

The ID of the sub check result.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ssmsap#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmsap#ListSubCheckRuleResultsOutput": { + "type": "structure", + "members": { + "RuleResults": { + "target": "com.amazonaws.ssmsap#RuleResultList", + "traits": { + "smithy.api#documentation": "

The rule results of a sub-check belonging to a configuration check operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ssmsap#ListTagsForResource": { @@ -2111,7 +2659,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all tags on an SAP HANA application and/or database registered with AWS Systems\n Manager for SAP.

", + "smithy.api#documentation": "

Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}" @@ -2156,7 +2704,7 @@ "com.amazonaws.ssmsap#NextToken": { "type": "string", "traits": { - "smithy.api#pattern": "^.{16,1024}$" + "smithy.api#pattern": "^.{16,2048}$" } }, "com.amazonaws.ssmsap#Operation": { @@ -2239,19 +2787,19 @@ "Description": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A description of the operation event. For example, \"Stop the EC2 instance\n i-abcdefgh987654321\".

" + "smithy.api#documentation": "

A description of the operation event. For example, \"Stop the EC2 instance i-abcdefgh987654321\".

" } }, "Resource": { "target": "com.amazonaws.ssmsap#Resource", "traits": { - "smithy.api#documentation": "

The resource involved in the operations event.

\n

Contains ResourceArn ARN and ResourceType.

" + "smithy.api#documentation": "

The resource involved in the operations event.

Contains ResourceArn ARN and ResourceType.

" } }, "Status": { "target": "com.amazonaws.ssmsap#OperationEventStatus", "traits": { - "smithy.api#documentation": "

The status of the operation event. The possible statuses are: IN_PROGRESS,\n COMPLETED, and FAILED.

" + "smithy.api#documentation": "

The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.

" } }, "StatusMessage": { @@ -2268,7 +2816,7 @@ } }, "traits": { - "smithy.api#documentation": "

An operation event returns details for an operation, including key milestones which can\n be used to monitor and track operations in progress.

\n

Operation events contain:

\n
    \n
  • \n

    Description string

    \n
  • \n
  • \n

    Resource, including its ARN and type

    \n
  • \n
  • \n

    Status

    \n
  • \n
  • \n

    StatusMessage string

    \n
  • \n
  • \n

    TimeStamp

    \n
  • \n
\n

Operation event examples include StartApplication or StopApplication.

" + "smithy.api#documentation": "

An operation event returns details for an operation, including key milestones which can be used to monitor and track operations in progress.

Operation events contain:

  • Description string

  • Resource, including its ARN and type

  • Status

  • StatusMessage string

  • TimeStamp

Operation event examples include StartApplication or StopApplication.

" } }, "com.amazonaws.ssmsap#OperationEventList": { @@ -2496,7 +3044,7 @@ } ], "traits": { - "smithy.api#documentation": "

Register an SAP application with AWS Systems Manager for SAP. You must meet the\n following requirements before registering.

\n

The SAP application you want to register with AWS Systems Manager for SAP is running\n on Amazon EC2.

\n

AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required\n IAM permissions.

\n

Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to\n manage SAP applications and components.

", + "smithy.api#documentation": "

Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering.

The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2.

AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions.

Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -2563,150 +3111,306 @@ "ComponentsInfo": { "target": "com.amazonaws.ssmsap#ComponentInfoList", "traits": { - "smithy.api#documentation": "

This is an optional parameter for component details \n to which the SAP ABAP application is attached, \n such as Web Dispatcher.

\n

This is an array of ApplicationComponent objects. \n You may input 0 to 5 items.

" + "smithy.api#documentation": "

This is an optional parameter for component details to which the SAP ABAP application is attached, such as Web Dispatcher.

This is an array of ApplicationComponent objects. You may input 0 to 5 items.

" + } + } + } + }, + "com.amazonaws.ssmsap#RegisterApplicationOutput": { + "type": "structure", + "members": { + "Application": { + "target": "com.amazonaws.ssmsap#Application", + "traits": { + "smithy.api#documentation": "

The application registered with AWS Systems Manager for SAP.

" + } + }, + "OperationId": { + "target": "com.amazonaws.ssmsap#OperationId", + "traits": { + "smithy.api#documentation": "

The ID of the operation.

" + } + } + } + }, + "com.amazonaws.ssmsap#ReplicationMode": { + "type": "enum", + "members": { + "PRIMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY" } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "SYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNC" + } + }, + "SYNCMEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNCMEM" + } + }, + "ASYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASYNC" + } + } + } + }, + "com.amazonaws.ssmsap#Resilience": { + "type": "structure", + "members": { + "HsrTier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The tier of the component.

" + } + }, + "HsrReplicationMode": { + "target": "com.amazonaws.ssmsap#ReplicationMode", + "traits": { + "smithy.api#documentation": "

The replication mode of the component.

" + } + }, + "HsrOperationMode": { + "target": "com.amazonaws.ssmsap#OperationMode", + "traits": { + "smithy.api#documentation": "

The operation mode of the component.

" + } + }, + "ClusterStatus": { + "target": "com.amazonaws.ssmsap#ClusterStatus", + "traits": { + "smithy.api#documentation": "

The cluster status of the component.

" + } + }, + "EnqueueReplication": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates if or not enqueue replication is enabled for the ASCS component.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of the SAP HANA system replication for the instance.

" + } + }, + "com.amazonaws.ssmsap#Resource": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.ssmsap#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source resource.

Example of ResourceArn: \"arn:aws:ec2:us-east-1:111111111111:instance/i-abcdefgh987654321\"

" + } + }, + "ResourceType": { + "target": "com.amazonaws.ssmsap#OperationEventResourceType", + "traits": { + "smithy.api#documentation": "

The resource type.

Example of ResourceType: \"AWS::SystemsManagerSAP::Component\" or \"AWS::EC2::Instance\".

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource contains a ResourceArn and the ResourceType.

" + } + }, + "com.amazonaws.ssmsap#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.ssmsap#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

The resource is not available.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.ssmsap#ResourceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.ssmsap#RuleResult": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ssmsap#RuleResultId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the rule result.

" + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A description of what the rule validates.

" + } + }, + "Status": { + "target": "com.amazonaws.ssmsap#RuleResultStatus", + "traits": { + "smithy.api#documentation": "

The status of the rule result.

" + } + }, + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A message providing details about the rule result.

" + } + }, + "Metadata": { + "target": "com.amazonaws.ssmsap#RuleResultMetadata", + "traits": { + "smithy.api#documentation": "

Additional metadata associated with the rule result.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the result of a single rule within a configuration check.

" + } + }, + "com.amazonaws.ssmsap#RuleResultId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$" + } + }, + "com.amazonaws.ssmsap#RuleResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#RuleResult" + } + }, + "com.amazonaws.ssmsap#RuleResultMetadata": { + "type": "map", + "key": { + "target": "com.amazonaws.ssmsap#RuleResultMetadataKey" + }, + "value": { + "target": "com.amazonaws.ssmsap#RuleResultMetadataValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 } } }, - "com.amazonaws.ssmsap#RegisterApplicationOutput": { - "type": "structure", - "members": { - "Application": { - "target": "com.amazonaws.ssmsap#Application", - "traits": { - "smithy.api#documentation": "

The application registered with AWS Systems Manager for SAP.

" - } - }, - "OperationId": { - "target": "com.amazonaws.ssmsap#OperationId", - "traits": { - "smithy.api#documentation": "

The ID of the operation.

" - } + "com.amazonaws.ssmsap#RuleResultMetadataKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 } } }, - "com.amazonaws.ssmsap#ReplicationMode": { + "com.amazonaws.ssmsap#RuleResultMetadataValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ssmsap#RuleResultStatus": { "type": "enum", "members": { - "PRIMARY": { + "PASSED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PRIMARY" + "smithy.api#enumValue": "PASSED" } }, - "NONE": { + "FAILED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "FAILED" } }, - "SYNC": { + "WARNING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SYNC" + "smithy.api#enumValue": "WARNING" } }, - "SYNCMEM": { + "INFO": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SYNCMEM" + "smithy.api#enumValue": "INFO" } }, - "ASYNC": { + "UNKNOWN": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ASYNC" + "smithy.api#enumValue": "UNKNOWN" } } } }, - "com.amazonaws.ssmsap#Resilience": { + "com.amazonaws.ssmsap#RuleStatusCounts": { "type": "structure", "members": { - "HsrTier": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The tier of the component.

" - } - }, - "HsrReplicationMode": { - "target": "com.amazonaws.ssmsap#ReplicationMode", + "Failed": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The replication mode of the component.

" + "smithy.api#documentation": "

The number of rules that failed.

" } }, - "HsrOperationMode": { - "target": "com.amazonaws.ssmsap#OperationMode", + "Warning": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The operation mode of the component.

" + "smithy.api#documentation": "

The number of rules that returned warnings.

" } }, - "ClusterStatus": { - "target": "com.amazonaws.ssmsap#ClusterStatus", + "Info": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The cluster status of the component.

" + "smithy.api#documentation": "

The number of rules that returned informational results.

" } }, - "EnqueueReplication": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates if or not enqueue replication is enabled for the ASCS component.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details of the SAP HANA system replication for the instance.

" - } - }, - "com.amazonaws.ssmsap#Resource": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.ssmsap#Arn", + "Passed": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source resource.

\n

Example of ResourceArn:\n \"arn:aws:ec2:us-east-1:111111111111:instance/i-abcdefgh987654321\"

" + "smithy.api#documentation": "

The number of rules that passed.

" } }, - "ResourceType": { - "target": "com.amazonaws.ssmsap#OperationEventResourceType", + "Unknown": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The resource type.

\n

Example of ResourceType: \"AWS::SystemsManagerSAP::Component\"\n or \"AWS::EC2::Instance\".

" + "smithy.api#documentation": "

The number of rules with unknown status.

" } } }, "traits": { - "smithy.api#documentation": "

The resource contains a ResourceArn and the\n ResourceType.

" - } - }, - "com.amazonaws.ssmsap#ResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.ssmsap#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "

The resource is not available.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.ssmsap#ResourceType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } + "smithy.api#documentation": "

A summary of rule results, providing counts for each status type.

" } }, "com.amazonaws.ssmsap#SAPInstanceNumber": { @@ -2747,6 +3451,9 @@ { "target": "com.amazonaws.ssmsap#GetComponent" }, + { + "target": "com.amazonaws.ssmsap#GetConfigurationCheckOperation" + }, { "target": "com.amazonaws.ssmsap#GetDatabase" }, @@ -2762,6 +3469,12 @@ { "target": "com.amazonaws.ssmsap#ListComponents" }, + { + "target": "com.amazonaws.ssmsap#ListConfigurationCheckDefinitions" + }, + { + "target": "com.amazonaws.ssmsap#ListConfigurationCheckOperations" + }, { "target": "com.amazonaws.ssmsap#ListDatabases" }, @@ -2771,6 +3484,12 @@ { "target": "com.amazonaws.ssmsap#ListOperations" }, + { + "target": "com.amazonaws.ssmsap#ListSubCheckResults" + }, + { + "target": "com.amazonaws.ssmsap#ListSubCheckRuleResults" + }, { "target": "com.amazonaws.ssmsap#ListTagsForResource" }, @@ -2786,6 +3505,9 @@ { "target": "com.amazonaws.ssmsap#StartApplicationRefresh" }, + { + "target": "com.amazonaws.ssmsap#StartConfigurationChecks" + }, { "target": "com.amazonaws.ssmsap#StopApplication" }, @@ -2822,7 +3544,7 @@ ], "origin": "*" }, - "smithy.api#documentation": "

This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for AWS Systems Manager for SAP. The topic for each action shows\n the API request parameters and responses.

", + "smithy.api#documentation": "

This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Systems Manager for SAP. The topic for each action shows the API request parameters and responses.

", "smithy.api#title": "AWS Systems Manager for SAP", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -3332,17 +4054,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3356,17 +4067,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3380,17 +4080,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3404,17 +4093,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3519,7 +4197,7 @@ } ], "traits": { - "smithy.api#documentation": "

Request is an operation which starts an application.

\n

Parameter ApplicationId is required.

", + "smithy.api#documentation": "

Request is an operation which starts an application.

Parameter ApplicationId is required.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -3619,6 +4297,72 @@ "smithy.api#output": {} } }, + "com.amazonaws.ssmsap#StartConfigurationChecks": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#StartConfigurationChecksInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#StartConfigurationChecksOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#ConflictException" + }, + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Initiates configuration check operations against a specified application.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/start-configuration-checks" + } + } + }, + "com.amazonaws.ssmsap#StartConfigurationChecksInput": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

", + "smithy.api#required": {} + } + }, + "ConfigurationCheckIds": { + "target": "com.amazonaws.ssmsap#ConfigurationCheckTypeList", + "traits": { + "smithy.api#documentation": "

The list of configuration checks to perform.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmsap#StartConfigurationChecksOutput": { + "type": "structure", + "members": { + "ConfigurationCheckOperations": { + "target": "com.amazonaws.ssmsap#ConfigurationCheckOperationList", + "traits": { + "smithy.api#documentation": "

The configuration check operations that were started.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ssmsap#StopApplication": { "type": "operation", "input": { @@ -3642,7 +4386,7 @@ } ], "traits": { - "smithy.api#documentation": "

Request is an operation to stop an application.

\n

Parameter ApplicationId is required. Parameters\n StopConnectedEntity and IncludeEc2InstanceShutdown are\n optional.

", + "smithy.api#documentation": "

Request is an operation to stop an application.

Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -3663,13 +4407,13 @@ "StopConnectedEntity": { "target": "com.amazonaws.ssmsap#ConnectedEntityType", "traits": { - "smithy.api#documentation": "

Specify the ConnectedEntityType. Accepted type is DBMS.

\n

If this parameter is included, the connected DBMS (Database Management System) will be\n stopped.

" + "smithy.api#documentation": "

Specify the ConnectedEntityType. Accepted type is DBMS.

If this parameter is included, the connected DBMS (Database Management System) will be stopped.

" } }, "IncludeEc2InstanceShutdown": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Boolean. If included and if set to True, the StopApplication operation will\n shut down the associated Amazon EC2 instance in addition to the application.

" + "smithy.api#documentation": "

Boolean. If included and if set to True, the StopApplication operation will shut down the associated Amazon EC2 instance in addition to the application.

" } } }, @@ -3691,6 +4435,56 @@ "smithy.api#output": {} } }, + "com.amazonaws.ssmsap#SubCheckReferencesList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.ssmsap#SubCheckResult": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ssmsap#SubCheckResultId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the sub-check result.

" + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the sub-check.

" + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A description of what the sub-check validates.

" + } + }, + "References": { + "target": "com.amazonaws.ssmsap#SubCheckReferencesList", + "traits": { + "smithy.api#documentation": "

A list of references or documentation links related to the sub-check.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the result of a sub-check within a configuration check operation.

" + } + }, + "com.amazonaws.ssmsap#SubCheckResultId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$" + } + }, + "com.amazonaws.ssmsap#SubCheckResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#SubCheckResult" + } + }, "com.amazonaws.ssmsap#TagKey": { "type": "string", "traits": { @@ -3827,7 +4621,7 @@ "tagKeys": { "target": "com.amazonaws.ssmsap#TagKeyList", "traits": { - "smithy.api#documentation": "

Adds/updates or removes credentials for applications registered with AWS Systems\n Manager for SAP.

", + "smithy.api#documentation": "

Adds/updates or removes credentials for applications registered with AWS Systems Manager for SAP.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -3864,7 +4658,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the settings of an application registered with AWS Systems Manager for\n SAP.

", + "smithy.api#documentation": "

Updates the settings of an application registered with AWS Systems Manager for SAP.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -3903,7 +4697,7 @@ "DatabaseArn": { "target": "com.amazonaws.ssmsap#SsmSapArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name of the SAP HANA database that replaces the current SAP HANA\n connection with the SAP_ABAP application.

" + "smithy.api#documentation": "

The Amazon Resource Name of the SAP HANA database that replaces the current SAP HANA connection with the SAP_ABAP application.

" } } } diff --git a/codegen/sdk/aws-models/ssm.json b/codegen/sdk/aws-models/ssm.json index b29405f9a26..b74f286227e 100644 --- a/codegen/sdk/aws-models/ssm.json +++ b/codegen/sdk/aws-models/ssm.json @@ -1828,17 +1828,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1852,17 +1841,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1876,17 +1854,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1900,17 +1867,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -6311,7 +6267,7 @@ "TargetLocations": { "target": "com.amazonaws.ssm#TargetLocations", "traits": { - "smithy.api#documentation": "

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the\n association. Use this action to create an association in multiple Regions and multiple\n accounts.

" + "smithy.api#documentation": "

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the\n association. Use this action to create an association in multiple Regions and multiple\n accounts.

\n \n

The IncludeChildOrganizationUnits parameter is not supported by State Manager.

\n
" } }, "ScheduleOffset": { @@ -6909,7 +6865,7 @@ "RejectedPatchesAction": { "target": "com.amazonaws.ssm#PatchAction", "traits": { - "smithy.api#documentation": "

The action for Patch Manager to take on patches included in the\n RejectedPackages list.

\n
\n
ALLOW_AS_DEPENDENCY
\n
\n

\n Linux and macOS: A package in the rejected patches list\n is installed only if it is a dependency of another package. It is considered compliant with\n the patch baseline, and its status is reported as INSTALLED_OTHER. This is the\n default action if no option is specified.

\n

\n Windows Server: Windows Server doesn't support the\n concept of package dependencies. If a package in the rejected patches list and already\n installed on the node, its status is reported as INSTALLED_OTHER. Any package not\n already installed on the node is skipped. This is the default action if no option is\n specified.

\n
\n
BLOCK
\n
\n

\n All OSs: Packages in the rejected patches list, and\n packages that include them as dependencies, aren't installed by Patch Manager under any\n circumstances. If a package was installed before it was added to the rejected patches list, or\n is installed outside of Patch Manager afterward, it's considered noncompliant with the patch\n baseline and its status is reported as INSTALLED_REJECTED.

\n
\n
" + "smithy.api#documentation": "

The action for Patch Manager to take on patches included in the\n RejectedPackages list.

\n
\n
ALLOW_AS_DEPENDENCY
\n
\n

\n Linux and macOS: A package in the rejected patches list\n is installed only if it is a dependency of another package. It is considered compliant with\n the patch baseline, and its status is reported as INSTALLED_OTHER. This is the\n default action if no option is specified.

\n

\n Windows Server: Windows Server doesn't support the\n concept of package dependencies. If a package in the rejected patches list and already\n installed on the node, its status is reported as INSTALLED_OTHER. Any package not\n already installed on the node is skipped. This is the default action if no option is\n specified.

\n
\n
BLOCK
\n
\n

\n All OSs: Packages in the rejected patches list, and\n packages that include them as dependencies, aren't installed by Patch Manager under any\n circumstances.

\n

State value assignment for patch compliance:

\n
    \n
  • \n

    If a package was installed before it was added to the rejected patches list, or is\n installed outside of Patch Manager afterward, it's considered noncompliant with the patch\n baseline and its status is reported as INSTALLED_REJECTED.

    \n
  • \n
  • \n

    If an update attempts to install a dependency package that is now rejected by the\n baseline, when previous versions of the package were not rejected, the package being updated\n is reported as MISSING for SCAN operations and as\n FAILED for INSTALL operations.

    \n
  • \n
\n
\n
" } }, "Description": { @@ -12913,6 +12869,13 @@ "traits": { "smithy.api#documentation": "

Defines the basic information about a patch baseline override.

" } + }, + "UseS3DualStackEndpoint": { + "target": "com.amazonaws.ssm#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to use S3 dualstack endpoints\n for the patch snapshot download URL. Set to true to receive a presigned URL that\n supports both IPv4 and IPv6 connectivity. Set to false to use standard IPv4-only\n endpoints. Default is false. This parameter is required for managed nodes in\n IPv6-only environments.

" + } } }, "traits": { @@ -30011,13 +29974,13 @@ "TargetLocationMaxConcurrency": { "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation\n concurrently.

" + "smithy.api#documentation": "

The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation\n concurrently. TargetLocationMaxConcurrency has a default value of 1.

" } }, "TargetLocationMaxErrors": { "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "

The maximum number of errors allowed before the system stops queueing additional Automation\n executions for the currently running Automation.

" + "smithy.api#documentation": "

The maximum number of errors allowed before the system stops queueing additional Automation\n executions for the currently running Automation. TargetLocationMaxErrors has a\n default value of 0.

" } }, "ExecutionRoleName": { @@ -30033,7 +29996,7 @@ "target": "com.amazonaws.ssm#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to include child organizational units (OUs) that are children of the\n targeted OUs. The default is false.

" + "smithy.api#documentation": "

Indicates whether to include child organizational units (OUs) that are children of the\n targeted OUs. The default is false.

\n \n

This parameter is not supported by State Manager.

\n
" } }, "ExcludeAccounts": { @@ -30743,7 +30706,7 @@ "TargetLocations": { "target": "com.amazonaws.ssm#TargetLocations", "traits": { - "smithy.api#documentation": "

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the\n association. Use this action to update an association in multiple Regions and multiple\n accounts.

" + "smithy.api#documentation": "

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the\n association. Use this action to update an association in multiple Regions and multiple\n accounts.

\n \n

The IncludeChildOrganizationUnits parameter is not supported by State Manager.

\n
" } }, "ScheduleOffset": { @@ -31983,7 +31946,7 @@ "RejectedPatchesAction": { "target": "com.amazonaws.ssm#PatchAction", "traits": { - "smithy.api#documentation": "

The action for Patch Manager to take on patches included in the\n RejectedPackages list.

\n
\n
ALLOW_AS_DEPENDENCY
\n
\n

\n Linux and macOS: A package in the rejected patches list\n is installed only if it is a dependency of another package. It is considered compliant with\n the patch baseline, and its status is reported as INSTALLED_OTHER. This is the\n default action if no option is specified.

\n

\n Windows Server: Windows Server doesn't support the\n concept of package dependencies. If a package in the rejected patches list and already\n installed on the node, its status is reported as INSTALLED_OTHER. Any package not\n already installed on the node is skipped. This is the default action if no option is\n specified.

\n
\n
BLOCK
\n
\n

\n All OSs: Packages in the rejected patches list, and\n packages that include them as dependencies, aren't installed by Patch Manager under any\n circumstances. If a package was installed before it was added to the rejected patches list, or\n is installed outside of Patch Manager afterward, it's considered noncompliant with the patch\n baseline and its status is reported as INSTALLED_REJECTED.

\n
\n
" + "smithy.api#documentation": "

The action for Patch Manager to take on patches included in the\n RejectedPackages list.

\n
\n
ALLOW_AS_DEPENDENCY
\n
\n

\n Linux and macOS: A package in the rejected patches list\n is installed only if it is a dependency of another package. It is considered compliant with\n the patch baseline, and its status is reported as INSTALLED_OTHER. This is the\n default action if no option is specified.

\n

\n Windows Server: Windows Server doesn't support the\n concept of package dependencies. If a package in the rejected patches list and already\n installed on the node, its status is reported as INSTALLED_OTHER. Any package not\n already installed on the node is skipped. This is the default action if no option is\n specified.

\n
\n
BLOCK
\n
\n

\n All OSs: Packages in the rejected patches list, and\n packages that include them as dependencies, aren't installed by Patch Manager under any\n circumstances.

\n

State value assignment for patch compliance:

\n
    \n
  • \n

    If a package was installed before it was added to the rejected patches list, or is\n installed outside of Patch Manager afterward, it's considered noncompliant with the patch\n baseline and its status is reported as INSTALLED_REJECTED.

    \n
  • \n
  • \n

    If an update attempts to install a dependency package that is now rejected by the\n baseline, when previous versions of the package were not rejected, the package being updated\n is reported as MISSING for SCAN operations and as\n FAILED for INSTALL operations.

    \n
  • \n
\n
\n
" } }, "Description": { diff --git a/codegen/sdk/aws-models/sso-admin.json b/codegen/sdk/aws-models/sso-admin.json index 7752982a45f..20ad6e7f6ee 100644 --- a/codegen/sdk/aws-models/sso-admin.json +++ b/codegen/sdk/aws-models/sso-admin.json @@ -7,7 +7,7 @@ "Key": { "target": "com.amazonaws.ssoadmin#AccessControlAttributeKey", "traits": { - "smithy.api#documentation": "

The name of the attribute associated with your identities in your identity source.\n This is used to map a specified attribute in your identity source with an attribute in\n IAM Identity Center.

", + "smithy.api#documentation": "

The name of the attribute associated with your identities in your identity source. This is used to map a specified attribute in your identity source with an attribute in IAM Identity Center.

", "smithy.api#required": {} } }, @@ -20,7 +20,7 @@ } }, "traits": { - "smithy.api#documentation": "

These are IAM Identity Center identity store attributes that you can configure for use in\n attributes-based access control (ABAC). You can create permissions policies that\n determine who can access your Amazon Web Services resources based upon the configured attribute\n values. When you enable ABAC and specify AccessControlAttributes, IAM Identity Center\n passes the attribute values of the authenticated user into IAM for use in policy\n evaluation.

" + "smithy.api#documentation": "

These are IAM Identity Center identity store attributes that you can configure for use in attributes-based access control (ABAC). You can create permissions policies that determine who can access your Amazon Web Services resources based upon the configured attribute values. When you enable ABAC and specify AccessControlAttributes, IAM Identity Center passes the attribute values of the authenticated user into IAM for use in policy evaluation.

" } }, "com.amazonaws.ssoadmin#AccessControlAttributeKey": { @@ -57,7 +57,7 @@ } }, "traits": { - "smithy.api#documentation": "

The value used for mapping a specified attribute to an identity source. For more\n information, see Attribute\n mappings in the IAM Identity Center User Guide.

" + "smithy.api#documentation": "

The value used for mapping a specified attribute to an identity source. For more information, see Attribute mappings in the IAM Identity Center User Guide.

" } }, "com.amazonaws.ssoadmin#AccessControlAttributeValueSource": { @@ -87,6 +87,12 @@ "members": { "Message": { "target": "com.amazonaws.ssoadmin#AccessDeniedExceptionMessage" + }, + "Reason": { + "target": "com.amazonaws.ssoadmin#AccessDeniedExceptionReason", + "traits": { + "smithy.api#documentation": "

The reason for the access denied exception.

" + } } }, "traits": { @@ -98,6 +104,17 @@ "com.amazonaws.ssoadmin#AccessDeniedExceptionMessage": { "type": "string" }, + "com.amazonaws.ssoadmin#AccessDeniedExceptionReason": { + "type": "enum", + "members": { + "KMS_ACCESS_DENIED_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS_AccessDeniedException" + } + } + } + }, "com.amazonaws.ssoadmin#AccountAssignment": { "type": "structure", "members": { @@ -110,7 +127,7 @@ "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "

The ARN of the permission set. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" } }, "PrincipalType": { @@ -127,7 +144,7 @@ } }, "traits": { - "smithy.api#documentation": "

The assignment that indicates a principal's limited access to a specified Amazon Web Services\n account with a specified permission set.

\n \n

The term principal here refers to a user or group that is\n defined in IAM Identity Center.

\n
" + "smithy.api#documentation": "

The assignment that indicates a principal's limited access to a specified Amazon Web Services account with a specified permission set.

The term principal here refers to a user or group that is defined in IAM Identity Center.

" } }, "com.amazonaws.ssoadmin#AccountAssignmentForPrincipal": { @@ -142,7 +159,7 @@ "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center permission set assigned to this principal for this\n Amazon Web Services account.

" + "smithy.api#documentation": "

The ARN of the IAM Identity Center permission set assigned to this principal for this Amazon Web Services account.

" } }, "PrincipalId": { @@ -159,7 +176,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that describes an assignment of an Amazon Web Services account to a principal and the\n permissions that principal has in the account.

" + "smithy.api#documentation": "

A structure that describes an assignment of an Amazon Web Services account to a principal and the permissions that principal has in the account.

" } }, "com.amazonaws.ssoadmin#AccountAssignmentList": { @@ -186,13 +203,13 @@ "RequestId": { "target": "com.amazonaws.ssoadmin#UUId", "traits": { - "smithy.api#documentation": "

The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.

" + "smithy.api#documentation": "

The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

" } }, "FailureReason": { "target": "com.amazonaws.ssoadmin#Reason", "traits": { - "smithy.api#documentation": "

The message that contains an error or exception in case of an operation\n failure.

" + "smithy.api#documentation": "

The message that contains an error or exception in case of an operation failure.

" } }, "TargetId": { @@ -210,7 +227,7 @@ "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "

The ARN of the permission set. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" } }, "PrincipalType": { @@ -233,7 +250,7 @@ } }, "traits": { - "smithy.api#documentation": "

The status of the creation or deletion operation of an assignment that a principal\n needs to access an account.

" + "smithy.api#documentation": "

The status of the creation or deletion operation of an assignment that a principal needs to access an account.

" } }, "com.amazonaws.ssoadmin#AccountAssignmentOperationStatusList": { @@ -254,7 +271,7 @@ "RequestId": { "target": "com.amazonaws.ssoadmin#UUId", "traits": { - "smithy.api#documentation": "

The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.

" + "smithy.api#documentation": "

The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

" } }, "CreatedDate": { @@ -265,7 +282,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information about the AccountAssignment creation\n request.

" + "smithy.api#documentation": "

Provides information about the AccountAssignment creation request.

" } }, "com.amazonaws.ssoadmin#AccountId": { @@ -303,7 +320,7 @@ } }, "Name": { - "target": "com.amazonaws.ssoadmin#NameType", + "target": "com.amazonaws.ssoadmin#ApplicationNameType", "traits": { "smithy.api#documentation": "

The name of the application.

" } @@ -329,7 +346,7 @@ "PortalOptions": { "target": "com.amazonaws.ssoadmin#PortalOptions", "traits": { - "smithy.api#documentation": "

A structure that describes the options for the access portal associated with this\n application.

" + "smithy.api#documentation": "

A structure that describes the options for the access portal associated with this application.

" } }, "Description": { @@ -346,7 +363,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that describes an application that uses IAM Identity Center for access\n management.

" + "smithy.api#documentation": "

A structure that describes an application that uses IAM Identity Center for access management.

" } }, "com.amazonaws.ssoadmin#ApplicationAccessScopeResource": { @@ -536,7 +553,7 @@ "DisplayData": { "target": "com.amazonaws.ssoadmin#DisplayData", "traits": { - "smithy.api#documentation": "

A structure that describes how IAM Identity Center represents the application provider in the\n portal.

" + "smithy.api#documentation": "

A structure that describes how IAM Identity Center represents the application provider in the portal.

" } }, "ResourceServerConfig": { @@ -547,7 +564,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that describes a provider that can be used to connect an Amazon Web Services managed\n application or customer managed application to IAM Identity Center.

" + "smithy.api#documentation": "

A structure that describes a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.

" } }, "com.amazonaws.ssoadmin#ApplicationProviderArn": { @@ -722,7 +739,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches an Amazon Web Services managed policy ARN to a permission set.

\n \n

If the permission set is already referenced by one or more account assignments,\n you will need to call \n ProvisionPermissionSet\n after\n this operation. Calling ProvisionPermissionSet applies the\n corresponding IAM policy updates to all assigned accounts.

\n
" + "smithy.api#documentation": "

Attaches an Amazon Web Services managed policy ARN to a permission set.

If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this operation. Calling ProvisionPermissionSet applies the corresponding IAM policy updates to all assigned accounts.

" } }, "com.amazonaws.ssoadmin#AttachManagedPolicyToPermissionSetRequest": { @@ -731,14 +748,14 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "

The ARN of the PermissionSet that the managed policy should be\n attached to.

", + "smithy.api#documentation": "

The ARN of the PermissionSet that the managed policy should be attached to.

", "smithy.api#required": {} } }, @@ -773,7 +790,7 @@ "Arn": { "target": "com.amazonaws.ssoadmin#ManagedPolicyArn", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Web Services managed policy. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

The ARN of the Amazon Web Services managed policy. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" } } }, @@ -798,7 +815,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that describes an authentication method that can be used by an\n application.

" + "smithy.api#documentation": "

A structure that describes an authentication method that can be used by an application.

" } }, "com.amazonaws.ssoadmin#AuthenticationMethodItem": { @@ -813,7 +830,7 @@ "AuthenticationMethod": { "target": "com.amazonaws.ssoadmin#AuthenticationMethod", "traits": { - "smithy.api#documentation": "

A structure that describes an authentication method. The contents of this structure is\n determined by the AuthenticationMethodType.

" + "smithy.api#documentation": "

A structure that describes an authentication method. The contents of this structure is determined by the AuthenticationMethodType.

" } } }, @@ -844,12 +861,12 @@ "RedirectUris": { "target": "com.amazonaws.ssoadmin#RedirectUris", "traits": { - "smithy.api#documentation": "

A list of URIs that are valid locations to redirect a user's browser after the user is\n authorized.

\n \n

RedirectUris is required when the grant type is\n authorization_code.

\n
" + "smithy.api#documentation": "

A list of URIs that are valid locations to redirect a user's browser after the user is authorized.

RedirectUris is required when the grant type is authorization_code.

" } } }, "traits": { - "smithy.api#documentation": "

A structure that defines configuration settings for an application that supports the\n OAuth 2.0 Authorization Code Grant.

" + "smithy.api#documentation": "

A structure that defines configuration settings for an application that supports the OAuth 2.0 Authorization Code Grant.

" } }, "com.amazonaws.ssoadmin#AuthorizedTokenIssuer": { @@ -864,12 +881,12 @@ "AuthorizedAudiences": { "target": "com.amazonaws.ssoadmin#TokenIssuerAudiences", "traits": { - "smithy.api#documentation": "

An array list of authorized audiences, or applications, that can consume the tokens\n generated by the associated trusted token issuer.

" + "smithy.api#documentation": "

An array list of authorized audiences, or applications, that can consume the tokens generated by the associated trusted token issuer.

" } } }, "traits": { - "smithy.api#documentation": "

A structure that describes a trusted token issuer and associates it with a set of authorized\n audiences.

" + "smithy.api#documentation": "

A structure that describes a trusted token issuer and associates it with a set of authorized audiences.

" } }, "com.amazonaws.ssoadmin#AuthorizedTokenIssuers": { @@ -912,7 +929,7 @@ } }, "traits": { - "smithy.api#documentation": "

Occurs when a conflict with a previous successful write is detected. This generally\n occurs when the previous write did not have time to propagate to the host serving the\n current request. A retry (with appropriate backoff logic) is the recommended response to\n this exception.

", + "smithy.api#documentation": "

Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -952,7 +969,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns access to a principal for a specified Amazon Web Services account using a specified\n permission set.

\n \n

The term principal here refers to a user or group that is\n defined in IAM Identity Center.

\n
\n \n

As part of a successful CreateAccountAssignment call, the specified\n permission set will automatically be provisioned to the account in the form of an\n IAM policy. That policy is attached to the IAM role created in IAM Identity Center. If the\n permission set is subsequently updated, the corresponding IAM policies attached to\n roles in your accounts will not be updated automatically. In this case, you must\n call \n ProvisionPermissionSet\n to make these\n updates.

\n
\n \n

After a successful response, call\n DescribeAccountAssignmentCreationStatus to describe the status of\n an assignment creation request.

\n
" + "smithy.api#documentation": "

Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.

The term principal here refers to a user or group that is defined in IAM Identity Center.

As part of a successful CreateAccountAssignment call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role created in IAM Identity Center. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you must call ProvisionPermissionSet to make these updates.

After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of an assignment creation request.

" } }, "com.amazonaws.ssoadmin#CreateAccountAssignmentRequest": { @@ -961,7 +978,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -982,7 +999,7 @@ "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "

The ARN of the permission set that the admin wants to grant the principal access\n to.

", + "smithy.api#documentation": "

The ARN of the permission set that the admin wants to grant the principal access to.

", "smithy.api#required": {} } }, @@ -1051,7 +1068,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given\n application provider.

\n \n

This API does not support creating SAML 2.0 customer managed applications or Amazon Web Services\n managed applications. To learn how to create an Amazon Web Services managed application, see the\n application user guide. You can create a SAML 2.0 customer managed application in\n the Amazon Web Services Management Console only. See Setting\n up customer managed SAML 2.0 applications. For more information on these\n application types, see Amazon Web Services managed\n applications.

\n
" + "smithy.api#documentation": "

Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider.

This API does not support creating SAML 2.0 customer managed applications or Amazon Web Services managed applications. To learn how to create an Amazon Web Services managed application, see the application user guide. You can create a SAML 2.0 customer managed application in the Amazon Web Services Management Console only. See Setting up customer managed SAML 2.0 applications. For more information on these application types, see Amazon Web Services managed applications.

" } }, "com.amazonaws.ssoadmin#CreateApplicationAssignment": { @@ -1131,7 +1148,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -1158,7 +1175,7 @@ "PortalOptions": { "target": "com.amazonaws.ssoadmin#PortalOptions", "traits": { - "smithy.api#documentation": "

A structure that describes the options for the portal associated with an\n application.

" + "smithy.api#documentation": "

A structure that describes the options for the portal associated with an application.

" } }, "Tags": { @@ -1176,7 +1193,7 @@ "ClientToken": { "target": "com.amazonaws.ssoadmin#ClientToken", "traits": { - "smithy.api#documentation": "

Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value.

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

\n

If you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.

", + "smithy.api#documentation": "

Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

", "smithy.api#idempotencyToken": {} } } @@ -1228,7 +1245,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an instance of IAM Identity Center for a standalone Amazon Web Services account that is not\n managed by Organizations or a member Amazon Web Services account in an organization. You can create only\n one instance per account and across all Amazon Web Services Regions.

\n

The CreateInstance request is rejected if the following apply:

\n
    \n
  • \n

    The instance is created within the organization management account.

    \n
  • \n
  • \n

    An instance already exists in the same account.

    \n
  • \n
" + "smithy.api#documentation": "

Creates an instance of IAM Identity Center for a standalone Amazon Web Services account that is not managed by Organizations or a member Amazon Web Services account in an organization. You can create only one instance per account and across all Amazon Web Services Regions.

The CreateInstance request is rejected if the following apply:

  • The instance is created within the organization management account.

  • An instance already exists in the same account.

" } }, "com.amazonaws.ssoadmin#CreateInstanceAccessControlAttributeConfiguration": { @@ -1260,7 +1277,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center\n instance. You can also specify new attributes to add to your ABAC configuration during\n the enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

\n \n

After a successful response, call\n DescribeInstanceAccessControlAttributeConfiguration to validate\n that InstanceAccessControlAttributeConfiguration was created.

\n
" + "smithy.api#documentation": "

Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

After a successful response, call DescribeInstanceAccessControlAttributeConfiguration to validate that InstanceAccessControlAttributeConfiguration was created.

" } }, "com.amazonaws.ssoadmin#CreateInstanceAccessControlAttributeConfigurationRequest": { @@ -1276,7 +1293,7 @@ "InstanceAccessControlAttributeConfiguration": { "target": "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfiguration", "traits": { - "smithy.api#documentation": "

Specifies the IAM Identity Center identity store attributes to add to your ABAC configuration. When\n using an external identity provider as an identity source, you can pass attributes\n through the SAML assertion. Doing so provides an alternative to configuring attributes\n from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center\n will replace the attribute value with the value from the IAM Identity Center identity store.

", + "smithy.api#documentation": "

Specifies the IAM Identity Center identity store attributes to add to your ABAC configuration. When using an external identity provider as an identity source, you can pass attributes through the SAML assertion. Doing so provides an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center will replace the attribute value with the value from the IAM Identity Center identity store.

", "smithy.api#required": {} } } @@ -1304,7 +1321,7 @@ "ClientToken": { "target": "com.amazonaws.ssoadmin#ClientToken", "traits": { - "smithy.api#documentation": "

Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value.

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

\n

If you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.

", + "smithy.api#documentation": "

Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

", "smithy.api#idempotencyToken": {} } }, @@ -1325,7 +1342,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the instance of IAM Identity Center under which the operation will run.

\n

For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

The ARN of the instance of IAM Identity Center under which the operation will run.

For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" } } }, @@ -1365,7 +1382,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a permission set within a specified IAM Identity Center instance.

\n \n

To grant users and groups access to Amazon Web Services account resources, use \n CreateAccountAssignment\n .

\n
" + "smithy.api#documentation": "

Creates a permission set within a specified IAM Identity Center instance.

To grant users and groups access to Amazon Web Services account resources, use CreateAccountAssignment .

" } }, "com.amazonaws.ssoadmin#CreatePermissionSetRequest": { @@ -1387,20 +1404,20 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, "SessionDuration": { "target": "com.amazonaws.ssoadmin#Duration", "traits": { - "smithy.api#documentation": "

The length of time that the application user sessions are valid in the ISO-8601\n standard.

" + "smithy.api#documentation": "

The length of time that the application user sessions are valid in the ISO-8601 standard.

" } }, "RelayState": { "target": "com.amazonaws.ssoadmin#RelayState", "traits": { - "smithy.api#documentation": "

Used to redirect users within the application during the federation authentication\n process.

" + "smithy.api#documentation": "

Used to redirect users within the application during the federation authentication process.

" } }, "Tags": { @@ -1457,7 +1474,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a connection to a trusted token issuer in an instance of IAM Identity Center. A trusted token issuer enables trusted\n identity propagation to be used with applications that authenticate outside of\n Amazon Web Services.

\n

This trusted token issuer describes an external identity provider (IdP) that can generate claims or\n assertions in the form of access tokens for a user. Applications enabled for IAM Identity Center\n can use these tokens for authentication.

" + "smithy.api#documentation": "

Creates a connection to a trusted token issuer in an instance of IAM Identity Center. A trusted token issuer enables trusted identity propagation to be used with applications that authenticate outside of Amazon Web Services.

This trusted token issuer describes an external identity provider (IdP) that can generate claims or assertions in the form of access tokens for a user. Applications enabled for IAM Identity Center can use these tokens for authentication.

" } }, "com.amazonaws.ssoadmin#CreateTrustedTokenIssuerRequest": { @@ -1466,7 +1483,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the instance of IAM Identity Center to contain the new trusted token issuer\n configuration.

", + "smithy.api#documentation": "

Specifies the ARN of the instance of IAM Identity Center to contain the new trusted token issuer configuration.

", "smithy.api#required": {} } }, @@ -1487,14 +1504,14 @@ "TrustedTokenIssuerConfiguration": { "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerConfiguration", "traits": { - "smithy.api#documentation": "

Specifies settings that apply to the new trusted token issuer configuration. The settings that are\n available depend on what TrustedTokenIssuerType you specify.

", + "smithy.api#documentation": "

Specifies settings that apply to the new trusted token issuer configuration. The settings that are available depend on what TrustedTokenIssuerType you specify.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.ssoadmin#ClientToken", "traits": { - "smithy.api#documentation": "

Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

\n

If you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.

", + "smithy.api#documentation": "

Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

", "smithy.api#idempotencyToken": {} } }, @@ -1529,14 +1546,14 @@ "Name": { "target": "com.amazonaws.ssoadmin#ManagedPolicyName", "traits": { - "smithy.api#documentation": "

The name of the IAM policy that you have configured in each account where you want\n to deploy your permission set.

", + "smithy.api#documentation": "

The name of the IAM policy that you have configured in each account where you want to deploy your permission set.

", "smithy.api#required": {} } }, "Path": { "target": "com.amazonaws.ssoadmin#ManagedPolicyPath", "traits": { - "smithy.api#documentation": "

The path to the IAM policy that you have configured in each account where you want\n to deploy your permission set. The default is /. For more information, see\n Friendly names and paths in the IAM User\n Guide.

" + "smithy.api#documentation": "

The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is /. For more information, see Friendly names and paths in the IAM User Guide.

" } } }, @@ -1582,7 +1599,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a principal's access from a specified Amazon Web Services account using a specified\n permission set.

\n \n

After a successful response, call\n DescribeAccountAssignmentDeletionStatus to describe the status of\n an assignment deletion request.

\n
" + "smithy.api#documentation": "

Deletes a principal's access from a specified Amazon Web Services account using a specified permission set.

After a successful response, call DescribeAccountAssignmentDeletionStatus to describe the status of an assignment deletion request.

" } }, "com.amazonaws.ssoadmin#DeleteAccountAssignmentRequest": { @@ -1591,7 +1608,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -1678,7 +1695,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the association with the application. The connected service resource still\n exists.

" + "smithy.api#documentation": "

Deletes the association with the application. The connected service resource still exists.

" } }, "com.amazonaws.ssoadmin#DeleteApplicationAccessScope": { @@ -1765,7 +1782,7 @@ } ], "traits": { - "smithy.api#documentation": "

Revoke application access to an application by deleting application assignments for a\n user or group.

", + "smithy.api#documentation": "

Revoke application access to an application by deleting application assignments for a user or group.

", "smithy.api#idempotent": {} } }, @@ -1921,7 +1938,7 @@ "ApplicationArn": { "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } } @@ -1975,7 +1992,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -2024,7 +2041,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the instance of IAM Identity Center. Only the account that owns the instance can\n call this API. Neither the delegated administrator nor member account can delete the\n organization instance, but those roles can delete their own instance.

" + "smithy.api#documentation": "

Deletes the instance of IAM Identity Center. Only the account that owns the instance can call this API. Neither the delegated administrator nor member account can delete the organization instance, but those roles can delete their own instance.

" } }, "com.amazonaws.ssoadmin#DeleteInstanceAccessControlAttributeConfiguration": { @@ -2056,7 +2073,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center\n instance and deletes all of the attribute mappings that have been configured. Once\n deleted, any attributes that are received from an identity source and any custom\n attributes you have previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

" + "smithy.api#documentation": "

Disables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance and deletes all of the attribute mappings that have been configured. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

" } }, "com.amazonaws.ssoadmin#DeleteInstanceAccessControlAttributeConfigurationRequest": { @@ -2141,7 +2158,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -2254,7 +2271,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a trusted token issuer configuration from an instance of IAM Identity Center.

\n \n

Deleting this trusted token issuer configuration will cause users to lose access to any\n applications that are configured to use the trusted token issuer.

\n
" + "smithy.api#documentation": "

Deletes a trusted token issuer configuration from an instance of IAM Identity Center.

Deleting this trusted token issuer configuration will cause users to lose access to any applications that are configured to use the trusted token issuer.

" } }, "com.amazonaws.ssoadmin#DeleteTrustedTokenIssuerRequest": { @@ -2314,7 +2331,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -2379,7 +2396,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -2464,7 +2481,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a direct assignment of a user or group to an application. If the user\n doesn’t have a direct assignment to the application, the user may still have access to\n the application through a group. Therefore, don’t use this API to test access to an\n application for a user. Instead use ListApplicationAssignmentsForPrincipal.

" + "smithy.api#documentation": "

Retrieves a direct assignment of a user or group to an application. If the user doesn’t have a direct assignment to the application, the user may still have access to the application through a group. Therefore, don’t use this API to test access to an application for a user. Instead use ListApplicationAssignmentsForPrincipal.

" } }, "com.amazonaws.ssoadmin#DescribeApplicationAssignmentRequest": { @@ -2473,7 +2490,7 @@ "ApplicationArn": { "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -2514,7 +2531,7 @@ "ApplicationArn": { "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" } } }, @@ -2548,7 +2565,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves details about a provider that can be used to connect an Amazon Web Services managed\n application or customer managed application to IAM Identity Center.

" + "smithy.api#documentation": "

Retrieves details about a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.

" } }, "com.amazonaws.ssoadmin#DescribeApplicationProviderRequest": { @@ -2605,7 +2622,7 @@ "ApplicationArn": { "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } } @@ -2630,7 +2647,7 @@ } }, "Name": { - "target": "com.amazonaws.ssoadmin#NameType", + "target": "com.amazonaws.ssoadmin#ApplicationNameType", "traits": { "smithy.api#documentation": "

The application name.

" } @@ -2644,7 +2661,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" } }, "Status": { @@ -2656,7 +2673,7 @@ "PortalOptions": { "target": "com.amazonaws.ssoadmin#PortalOptions", "traits": { - "smithy.api#documentation": "

A structure that describes the options for the portal associated with an\n application.

" + "smithy.api#documentation": "

A structure that describes the options for the portal associated with an application.

" } }, "Description": { @@ -2699,7 +2716,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the details of an instance of IAM Identity Center. The status can be one of the\n following:

\n
    \n
  • \n

    \n CREATE_IN_PROGRESS - The instance is in the process of being\n created. When the instance is ready for use, DescribeInstance returns the status\n of ACTIVE. While the instance is in the\n CREATE_IN_PROGRESS state, you can call only DescribeInstance\n and DeleteInstance operations.

    \n
  • \n
  • \n

    \n DELETE_IN_PROGRESS - The instance is being deleted. Returns\n AccessDeniedException after the delete operation completes.\n

    \n
  • \n
  • \n

    \n ACTIVE - The instance is active.

    \n
  • \n
" + "smithy.api#documentation": "

Returns the details of an instance of IAM Identity Center. The status can be one of the following:

  • CREATE_IN_PROGRESS - The instance is in the process of being created. When the instance is ready for use, DescribeInstance returns the status of ACTIVE. While the instance is in the CREATE_IN_PROGRESS state, you can call only DescribeInstance and DeleteInstance operations.

  • DELETE_IN_PROGRESS - The instance is being deleted. Returns AccessDeniedException after the delete operation completes.

  • ACTIVE - The instance is active.

" } }, "com.amazonaws.ssoadmin#DescribeInstanceAccessControlAttributeConfiguration": { @@ -2728,7 +2745,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the list of IAM Identity Center identity store attributes that have been configured to work\n with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will\n not return attributes configured and sent by an external identity provider.\n For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

" + "smithy.api#documentation": "

Returns the list of IAM Identity Center identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified IAM Identity Center instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

" } }, "com.amazonaws.ssoadmin#DescribeInstanceAccessControlAttributeConfigurationRequest": { @@ -2764,7 +2781,7 @@ "InstanceAccessControlAttributeConfiguration": { "target": "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfiguration", "traits": { - "smithy.api#documentation": "

Gets the list of IAM Identity Center identity store attributes that have been added to your ABAC\n configuration.

" + "smithy.api#documentation": "

Gets the list of IAM Identity Center identity store attributes that have been added to your ABAC configuration.

" } } }, @@ -2793,13 +2810,13 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" } }, "IdentityStoreId": { "target": "com.amazonaws.ssoadmin#Id", "traits": { - "smithy.api#documentation": "

The identifier of the identity store that is connected to the instance of\n IAM Identity Center.

" + "smithy.api#documentation": "

The identifier of the identity store that is connected to the instance of IAM Identity Center.

" } }, "OwnerAccountId": { @@ -2825,6 +2842,18 @@ "traits": { "smithy.api#documentation": "

The status of the instance.

" } + }, + "StatusReason": { + "target": "com.amazonaws.ssoadmin#Reason", + "traits": { + "smithy.api#documentation": "

Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.

" + } + }, + "EncryptionConfigurationDetails": { + "target": "com.amazonaws.ssoadmin#EncryptionConfigurationDetails", + "traits": { + "smithy.api#documentation": "

Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.

" + } } }, "traits": { @@ -2895,14 +2924,14 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, "ProvisionPermissionSetRequestId": { "target": "com.amazonaws.ssoadmin#UUId", "traits": { - "smithy.api#documentation": "

The identifier that is provided by the ProvisionPermissionSet call\n to retrieve the current status of the provisioning workflow.

", + "smithy.api#documentation": "

The identifier that is provided by the ProvisionPermissionSet call to retrieve the current status of the provisioning workflow.

", "smithy.api#required": {} } } @@ -2931,7 +2960,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -2987,7 +3016,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center. Details\n include the name of the trusted token issuer, the issuer URL, and the path of the source attribute and\n the destination attribute for a trusted token issuer configuration.

" + "smithy.api#documentation": "

Retrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center. Details include the name of the trusted token issuer, the issuer URL, and the path of the source attribute and the destination attribute for a trusted token issuer configuration.

" } }, "com.amazonaws.ssoadmin#DescribeTrustedTokenIssuerRequest": { @@ -3143,7 +3172,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detaches the attached Amazon Web Services managed policy ARN from the specified permission\n set.

" + "smithy.api#documentation": "

Detaches the attached Amazon Web Services managed policy ARN from the specified permission set.

" } }, "com.amazonaws.ssoadmin#DetachManagedPolicyFromPermissionSetRequest": { @@ -3152,14 +3181,14 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "

The ARN of the PermissionSet from which the policy should be\n detached.

", + "smithy.api#documentation": "

The ARN of the PermissionSet from which the policy should be detached.

", "smithy.api#required": {} } }, @@ -3218,6 +3247,59 @@ "smithy.api#pattern": "^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$" } }, + "com.amazonaws.ssoadmin#EncryptionConfiguration": { + "type": "structure", + "members": { + "KeyType": { + "target": "com.amazonaws.ssoadmin#KmsKeyType", + "traits": { + "smithy.api#documentation": "

The type of KMS key used for encryption.

", + "smithy.api#required": {} + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.ssoadmin#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key used to encrypt data. Required when KeyType is CUSTOMER_MANAGED_KEY. Cannot be specified when KeyType is AWS_OWNED_KMS_KEY.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that specifies the KMS key type and KMS key ARN used to encrypt data in your IAM Identity Center instance.

" + } + }, + "com.amazonaws.ssoadmin#EncryptionConfigurationDetails": { + "type": "structure", + "members": { + "KeyType": { + "target": "com.amazonaws.ssoadmin#KmsKeyType", + "traits": { + "smithy.api#documentation": "

The type of KMS key used for encryption.

" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.ssoadmin#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key currently used to encrypt data in your IAM Identity Center instance.

" + } + }, + "EncryptionStatus": { + "target": "com.amazonaws.ssoadmin#KmsKeyStatus", + "traits": { + "smithy.api#documentation": "

The current status of encryption configuration.

" + } + }, + "EncryptionStatusReason": { + "target": "com.amazonaws.ssoadmin#Reason", + "traits": { + "smithy.api#documentation": "

Provides additional context about the current encryption status. This field is particularly useful when the encryption status is UPDATE_FAILED. When encryption configuration update fails, this field contains information about the cause, which may include KMS key access issues, key not found errors, invalid key configuration, key in an invalid state, or a disabled key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The encryption configuration of your IAM Identity Center instance, including the key type, KMS key ARN, and current encryption status.

" + } + }, "com.amazonaws.ssoadmin#FederationProtocol": { "type": "enum", "members": { @@ -3271,14 +3353,14 @@ "ApplicationArn": { "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the application with the access scope that you want to\n retrieve.

", + "smithy.api#documentation": "

Specifies the ARN of the application with the access scope that you want to retrieve.

", "smithy.api#required": {} } }, "Scope": { "target": "com.amazonaws.ssoadmin#Scope", "traits": { - "smithy.api#documentation": "

Specifies the name of the access scope for which you want the authorized\n targets.

", + "smithy.api#documentation": "

Specifies the name of the access scope for which you want the authorized targets.

", "smithy.api#required": {} } } @@ -3344,7 +3426,7 @@ "ApplicationArn": { "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } } @@ -3360,7 +3442,7 @@ "target": "com.amazonaws.ssoadmin#AssignmentRequired", "traits": { "smithy.api#default": true, - "smithy.api#documentation": "

If AssignmentsRequired is true (default value), users don’t\n have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have\n access to the application.

", + "smithy.api#documentation": "

If AssignmentsRequired is true (default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have access to the application.

", "smithy.api#required": {} } } @@ -3502,6 +3584,65 @@ "smithy.api#output": {} } }, + "com.amazonaws.ssoadmin#GetApplicationSessionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#GetApplicationSessionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#GetApplicationSessionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the session configuration for an application in IAM Identity Center.

The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services managed application without having to remain signed in to an active session while the job runs.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssoadmin#GetApplicationSessionConfigurationRequest": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application for which to retrieve the session configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#GetApplicationSessionConfigurationResponse": { + "type": "structure", + "members": { + "UserBackgroundSessionApplicationStatus": { + "target": "com.amazonaws.ssoadmin#UserBackgroundSessionApplicationStatus", + "traits": { + "smithy.api#documentation": "

The status of user background sessions for the application.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSet": { "type": "operation", "input": { @@ -3537,7 +3678,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -3559,7 +3700,7 @@ "InlinePolicy": { "target": "com.amazonaws.ssoadmin#PermissionSetPolicyDocument", "traits": { - "smithy.api#documentation": "

The inline policy that is attached to the permission set.

\n \n

For Length Constraints, if a valid ARN is provided for a permission\n set, it is possible for an empty inline policy to be returned.

\n
" + "smithy.api#documentation": "

The inline policy that is attached to the permission set.

For Length Constraints, if a valid ARN is provided for a permission set, it is possible for an empty inline policy to be returned.

" } } }, @@ -3644,7 +3785,7 @@ "JwtBearer": { "target": "com.amazonaws.ssoadmin#JwtBearerGrant", "traits": { - "smithy.api#documentation": "

Configuration options for the urn:ietf:params:oauth:grant-type:jwt-bearer\n grant type.

" + "smithy.api#documentation": "

Configuration options for the urn:ietf:params:oauth:grant-type:jwt-bearer grant type.

" } }, "RefreshToken": { @@ -3656,12 +3797,12 @@ "TokenExchange": { "target": "com.amazonaws.ssoadmin#TokenExchangeGrant", "traits": { - "smithy.api#documentation": "

Configuration options for the\n urn:ietf:params:oauth:grant-type:token-exchange grant type.

" + "smithy.api#documentation": "

Configuration options for the urn:ietf:params:oauth:grant-type:token-exchange grant type.

" } } }, "traits": { - "smithy.api#documentation": "

The Grant union represents the set of possible configuration options for the selected\n grant type. Exactly one member of the union must be specified, and must match the grant\n type selected.

" + "smithy.api#documentation": "

The Grant union represents the set of possible configuration options for the selected grant type. Exactly one member of the union must be specified, and must match the grant type selected.

" } }, "com.amazonaws.ssoadmin#GrantItem": { @@ -3762,13 +3903,13 @@ "AccessControlAttributes": { "target": "com.amazonaws.ssoadmin#AccessControlAttributeList", "traits": { - "smithy.api#documentation": "

Lists the attributes that are configured for ABAC in the specified IAM Identity Center\n instance.

", + "smithy.api#documentation": "

Lists the attributes that are configured for ABAC in the specified IAM Identity Center instance.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Specifies the attributes to add to your attribute-based access control (ABAC)\n configuration.

" + "smithy.api#documentation": "

Specifies the attributes to add to your attribute-based access control (ABAC) configuration.

" } }, "com.amazonaws.ssoadmin#InstanceAccessControlAttributeConfigurationStatus": { @@ -3825,13 +3966,13 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

The ARN of the Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" } }, "IdentityStoreId": { "target": "com.amazonaws.ssoadmin#Id", "traits": { - "smithy.api#documentation": "

The identifier of the identity store that is connected to the Identity Center\n instance.

" + "smithy.api#documentation": "

The identifier of the identity store that is connected to the Identity Center instance.

" } }, "OwnerAccountId": { @@ -3857,6 +3998,12 @@ "traits": { "smithy.api#documentation": "

The current status of this Identity Center instance.

" } + }, + "StatusReason": { + "target": "com.amazonaws.ssoadmin#Reason", + "traits": { + "smithy.api#documentation": "

Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance creation fails, this field contains information about the cause, which may include issues with KMS key configuration or insufficient permissions.

" + } } }, "traits": { @@ -3872,6 +4019,12 @@ "smithy.api#enumValue": "CREATE_IN_PROGRESS" } }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, "DELETE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { @@ -3897,7 +4050,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception, or failure\n with an internal server.

", + "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception, or failure with an internal server.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -3929,12 +4082,62 @@ "AuthorizedTokenIssuers": { "target": "com.amazonaws.ssoadmin#AuthorizedTokenIssuers", "traits": { - "smithy.api#documentation": "

A list of allowed token issuers trusted by the Identity Center instances for this\n application.

\n \n

\n AuthorizedTokenIssuers is required when the grant type is\n JwtBearerGrant.

\n
" + "smithy.api#documentation": "

A list of allowed token issuers trusted by the Identity Center instances for this application.

AuthorizedTokenIssuers is required when the grant type is JwtBearerGrant.

" } } }, "traits": { - "smithy.api#documentation": "

A structure that defines configuration settings for an application that supports the\n JWT Bearer Token Authorization Grant. The AuthorizedAudience field is the\n aud claim. For more information, see RFC 7523.

" + "smithy.api#documentation": "

A structure that defines configuration settings for an application that supports the JWT Bearer Token Authorization Grant. The AuthorizedAudience field is the aud claim. For more information, see RFC 7523.

" + } + }, + "com.amazonaws.ssoadmin#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-[bcd]):kms:([a-z]{2,}(-[a-z0-9]+)+){1}:[0-9]{12}:key/(mrk-[a-f0-9]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$" + } + }, + "com.amazonaws.ssoadmin#KmsKeyStatus": { + "type": "enum", + "members": { + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } + } + }, + "com.amazonaws.ssoadmin#KmsKeyType": { + "type": "enum", + "members": { + "AWS_OWNED_KMS_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_OWNED_KMS_KEY" + } + }, + "CUSTOMER_MANAGED_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_MANAGED_KEY" + } + } } }, "com.amazonaws.ssoadmin#ListAccountAssignmentCreationStatus": { @@ -3963,7 +4166,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the status of the Amazon Web Services account assignment creation requests for a specified\n IAM Identity Center instance.

", + "smithy.api#documentation": "

Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3978,7 +4181,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -4051,7 +4254,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the status of the Amazon Web Services account assignment deletion requests for a specified\n IAM Identity Center instance.

", + "smithy.api#documentation": "

Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4066,7 +4269,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -4139,7 +4342,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the assignee of the specified Amazon Web Services account with the specified permission\n set.

", + "smithy.api#documentation": "

Lists the assignee of the specified Amazon Web Services account with the specified permission set.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4188,7 +4391,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access\n to. This action must be called from the management account containing your organization\n instance of IAM Identity Center. This action is not valid for account instances of IAM Identity Center.

", + "smithy.api#documentation": "

Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to. This action must be called from the management account containing your organization instance of IAM Identity Center. This action is not valid for account instances of IAM Identity Center.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4210,7 +4413,7 @@ "PrincipalId": { "target": "com.amazonaws.ssoadmin#PrincipalId", "traits": { - "smithy.api#documentation": "

Specifies the principal for which you want to retrieve the list of account\n assignments.

", + "smithy.api#documentation": "

Specifies the principal for which you want to retrieve the list of account assignments.

", "smithy.api#required": {} } }, @@ -4224,20 +4427,20 @@ "Filter": { "target": "com.amazonaws.ssoadmin#ListAccountAssignmentsFilter", "traits": { - "smithy.api#documentation": "

Specifies an Amazon Web Services account ID number. Results are filtered to only those that match\n this ID number.

" + "smithy.api#documentation": "

Specifies an Amazon Web Services account ID number. Results are filtered to only those that match this ID number.

" } }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" + "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.

" } }, "MaxResults": { "target": "com.amazonaws.ssoadmin#MaxResults", "traits": { "smithy.api#default": 100, - "smithy.api#documentation": "

Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" } } }, @@ -4257,7 +4460,7 @@ "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

" } } }, @@ -4271,7 +4474,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -4367,14 +4570,14 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "

The ARN of the PermissionSet from which the associated Amazon Web Services\n accounts will be listed.

", + "smithy.api#documentation": "

The ARN of the PermissionSet from which the associated Amazon Web Services accounts will be listed.

", "smithy.api#required": {} } }, @@ -4471,7 +4674,7 @@ "target": "com.amazonaws.ssoadmin#MaxResults", "traits": { "smithy.api#default": 10, - "smithy.api#documentation": "

Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.

", + "smithy.api#documentation": "

Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

", "smithy.api#range": { "min": 1, "max": 10 @@ -4481,7 +4684,7 @@ "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" + "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.

" } } }, @@ -4495,14 +4698,14 @@ "Scopes": { "target": "com.amazonaws.ssoadmin#Scopes", "traits": { - "smithy.api#documentation": "

An array list of access scopes and their authorized targets that are associated with\n the application.

", + "smithy.api#documentation": "

An array list of access scopes and their authorized targets that are associated with the application.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

" } } }, @@ -4586,7 +4789,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the applications to which a specified principal is assigned. You must provide a\n filter when calling this action from a member account against your organization instance\n of IAM Identity Center. A filter is not required when called from the management account against an\n organization instance of IAM Identity Center, or from a member account against an account instance of\n IAM Identity Center in the same account.

", + "smithy.api#documentation": "

Lists the applications to which a specified principal is assigned. You must provide a filter when calling this action from a member account against your organization instance of IAM Identity Center. A filter is not required when called from the management account against an organization instance of IAM Identity Center, or from a member account against an account instance of IAM Identity Center in the same account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4609,34 +4812,34 @@ "PrincipalId": { "target": "com.amazonaws.ssoadmin#PrincipalId", "traits": { - "smithy.api#documentation": "

Specifies the unique identifier of the principal for which you want to retrieve its\n assignments.

", + "smithy.api#documentation": "

Specifies the unique identifier of the principal for which you want to retrieve its assignments.

", "smithy.api#required": {} } }, "PrincipalType": { "target": "com.amazonaws.ssoadmin#PrincipalType", "traits": { - "smithy.api#documentation": "

Specifies the type of the principal for which you want to retrieve its\n assignments.

", + "smithy.api#documentation": "

Specifies the type of the principal for which you want to retrieve its assignments.

", "smithy.api#required": {} } }, "Filter": { "target": "com.amazonaws.ssoadmin#ListApplicationAssignmentsFilter", "traits": { - "smithy.api#documentation": "

Filters the output to include only assignments associated with the application that\n has the specified ARN.

" + "smithy.api#documentation": "

Filters the output to include only assignments associated with the application that has the specified ARN.

" } }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" + "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.

" } }, "MaxResults": { "target": "com.amazonaws.ssoadmin#MaxResults", "traits": { "smithy.api#default": 100, - "smithy.api#documentation": "

Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" } } }, @@ -4656,7 +4859,7 @@ "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

" } } }, @@ -4677,13 +4880,13 @@ "MaxResults": { "target": "com.amazonaws.ssoadmin#MaxResults", "traits": { - "smithy.api#documentation": "

Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" } }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" + "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.

" } } }, @@ -4703,7 +4906,7 @@ "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

" } } }, @@ -4752,14 +4955,14 @@ "ApplicationArn": { "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the application with the authentication methods you want to\n list.

", + "smithy.api#documentation": "

Specifies the ARN of the application with the authentication methods you want to list.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" + "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.

" } } }, @@ -4779,7 +4982,7 @@ "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

" } } }, @@ -4835,7 +5038,7 @@ "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" + "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.

" } } }, @@ -4856,7 +5059,7 @@ "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

" } } }, @@ -4902,13 +5105,13 @@ "MaxResults": { "target": "com.amazonaws.ssoadmin#MaxResults", "traits": { - "smithy.api#documentation": "

Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" } }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" + "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.

" } } }, @@ -4928,7 +5131,7 @@ "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

" } } }, @@ -4959,7 +5162,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all applications associated with the instance of IAM Identity Center. When listing\n applications for an organization instance in the management account, member accounts\n must use the applicationAccount parameter to filter the list to only\n applications created from that account. When listing applications for an account\n instance in the same member account, a filter is not required.

", + "smithy.api#documentation": "

Lists all applications associated with the instance of IAM Identity Center. When listing applications for an organization instance in the management account, member accounts must use the applicationAccount parameter to filter the list to only applications created from that account. When listing applications for an account instance in the same member account, a filter is not required.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4994,20 +5197,20 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.ssoadmin#MaxResults", "traits": { - "smithy.api#documentation": "

Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" } }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" + "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.

" } }, "Filter": { @@ -5033,7 +5236,7 @@ "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

" } } }, @@ -5102,7 +5305,7 @@ "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

The pagination token for the list API. Initially the value is null. Use the output of\n previous API calls to make subsequent calls.

" + "smithy.api#documentation": "

The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

" } } }, @@ -5116,13 +5319,13 @@ "CustomerManagedPolicyReferences": { "target": "com.amazonaws.ssoadmin#CustomerManagedPolicyReferenceList", "traits": { - "smithy.api#documentation": "

Specifies the names and paths of the customer managed policies that you have attached\n to your permission set.

" + "smithy.api#documentation": "

Specifies the names and paths of the customer managed policies that you have attached to your permission set.

" } }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

The pagination token for the list API. Initially the value is null. Use the output of\n previous API calls to make subsequent calls.

" + "smithy.api#documentation": "

The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

" } } }, @@ -5153,7 +5356,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the details of the organization and account instances of IAM Identity Center that\n were created in or visible to the account calling this API.

", + "smithy.api#documentation": "

Lists the details of the organization and account instances of IAM Identity Center that were created in or visible to the account calling this API.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5243,14 +5446,14 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "

The ARN of the PermissionSet whose managed policies will be\n listed.

", + "smithy.api#documentation": "

The ARN of the PermissionSet whose managed policies will be listed.

", "smithy.api#required": {} } }, @@ -5317,7 +5520,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the status of the permission set provisioning requests for a specified IAM Identity Center\n instance.

", + "smithy.api#documentation": "

Lists the status of the permission set provisioning requests for a specified IAM Identity Center instance.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5332,7 +5535,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -5440,7 +5643,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the permission sets that are provisioned to a specified Amazon Web Services\n account.

", + "smithy.api#documentation": "

Lists all the permission sets that are provisioned to a specified Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5455,7 +5658,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -5515,7 +5718,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -5596,7 +5799,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" } }, "ResourceArn": { @@ -5675,20 +5878,20 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the instance of IAM Identity Center with the trusted token issuer configurations that you want\n to list.

", + "smithy.api#documentation": "

Specifies the ARN of the instance of IAM Identity Center with the trusted token issuer configurations that you want to list.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.ssoadmin#MaxResults", "traits": { - "smithy.api#documentation": "

Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" } }, "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" + "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.

" } } }, @@ -5708,7 +5911,7 @@ "NextToken": { "target": "com.amazonaws.ssoadmin#Token", "traits": { - "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

" } } }, @@ -5780,34 +5983,34 @@ "IssuerUrl": { "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerUrl", "traits": { - "smithy.api#documentation": "

The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain\n the information required to verify the tokens that the trusted token issuer generates.

", + "smithy.api#documentation": "

The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain the information required to verify the tokens that the trusted token issuer generates.

", "smithy.api#required": {} } }, "ClaimAttributePath": { "target": "com.amazonaws.ssoadmin#ClaimAttributePath", "traits": { - "smithy.api#documentation": "

The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by\n this JMESPath expression is compared against the attribute mapped by\n IdentityStoreAttributePath when a trusted token issuer token is exchanged for an\n IAM Identity Center token.

", + "smithy.api#documentation": "

The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by IdentityStoreAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

", "smithy.api#required": {} } }, "IdentityStoreAttributePath": { "target": "com.amazonaws.ssoadmin#JMESPath", "traits": { - "smithy.api#documentation": "

The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by\n this JMESPath expression is compared against the attribute mapped by\n ClaimAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center\n token.

", + "smithy.api#documentation": "

The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by ClaimAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

", "smithy.api#required": {} } }, "JwksRetrievalOption": { "target": "com.amazonaws.ssoadmin#JwksRetrievalOption", "traits": { - "smithy.api#documentation": "

The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a\n JWT.

", + "smithy.api#documentation": "

The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A structure that describes configuration settings for a trusted token issuer that supports OpenID\n Connect (OIDC) and JSON Web Tokens (JWTs).

" + "smithy.api#documentation": "

A structure that describes configuration settings for a trusted token issuer that supports OpenID Connect (OIDC) and JSON Web Tokens (JWTs).

" } }, "com.amazonaws.ssoadmin#OidcJwtUpdateConfiguration": { @@ -5816,24 +6019,24 @@ "ClaimAttributePath": { "target": "com.amazonaws.ssoadmin#ClaimAttributePath", "traits": { - "smithy.api#documentation": "

The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by\n this JMESPath expression is compared against the attribute mapped by\n IdentityStoreAttributePath when a trusted token issuer token is exchanged for an\n IAM Identity Center token.

" + "smithy.api#documentation": "

The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by IdentityStoreAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

" } }, "IdentityStoreAttributePath": { "target": "com.amazonaws.ssoadmin#JMESPath", "traits": { - "smithy.api#documentation": "

The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by\n this JMESPath expression is compared against the attribute mapped by\n ClaimAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center\n token.

" + "smithy.api#documentation": "

The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by ClaimAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

" } }, "JwksRetrievalOption": { "target": "com.amazonaws.ssoadmin#JwksRetrievalOption", "traits": { - "smithy.api#documentation": "

The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a\n JWT.

" + "smithy.api#documentation": "

The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.

" } } }, "traits": { - "smithy.api#documentation": "

A structure that describes updated configuration settings for a trusted token issuer that supports\n OpenID Connect (OIDC) and JSON Web Tokens (JWTs).

" + "smithy.api#documentation": "

A structure that describes updated configuration settings for a trusted token issuer that supports OpenID Connect (OIDC) and JSON Web Tokens (JWTs).

" } }, "com.amazonaws.ssoadmin#OperationStatusFilter": { @@ -5862,7 +6065,7 @@ "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "

The ARN of the permission set. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" } }, "Description": { @@ -5880,13 +6083,13 @@ "SessionDuration": { "target": "com.amazonaws.ssoadmin#Duration", "traits": { - "smithy.api#documentation": "

The length of time that the application user sessions are valid for in the ISO-8601\n standard.

" + "smithy.api#documentation": "

The length of time that the application user sessions are valid for in the ISO-8601 standard.

" } }, "RelayState": { "target": "com.amazonaws.ssoadmin#RelayState", "traits": { - "smithy.api#documentation": "

Used to redirect users within the application during the federation authentication\n process.

" + "smithy.api#documentation": "

Used to redirect users within the application during the federation authentication process.

" } } }, @@ -5952,7 +6155,7 @@ "RequestId": { "target": "com.amazonaws.ssoadmin#UUId", "traits": { - "smithy.api#documentation": "

The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.

" + "smithy.api#documentation": "

The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

" } }, "AccountId": { @@ -5964,13 +6167,13 @@ "PermissionSetArn": { "target": "com.amazonaws.ssoadmin#PermissionSetArn", "traits": { - "smithy.api#documentation": "

The ARN of the permission set that is being provisioned. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

The ARN of the permission set that is being provisioned. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" } }, "FailureReason": { "target": "com.amazonaws.ssoadmin#Reason", "traits": { - "smithy.api#documentation": "

The message that contains an error or exception in case of an operation\n failure.

" + "smithy.api#documentation": "

The message that contains an error or exception in case of an operation failure.

" } }, "CreatedDate": { @@ -5981,7 +6184,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that is used to provide the status of the provisioning operation for a\n specified permission set.

" + "smithy.api#documentation": "

A structure that is used to provide the status of the provisioning operation for a specified permission set.

" } }, "com.amazonaws.ssoadmin#PermissionSetProvisioningStatusList": { @@ -6002,7 +6205,7 @@ "RequestId": { "target": "com.amazonaws.ssoadmin#UUId", "traits": { - "smithy.api#documentation": "

The identifier for tracking the request operation that is generated by the universally\n unique identifier (UUID) workflow.

" + "smithy.api#documentation": "

The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

" } }, "CreatedDate": { @@ -6028,12 +6231,12 @@ "ManagedPolicyArn": { "target": "com.amazonaws.ssoadmin#ManagedPolicyArn", "traits": { - "smithy.api#documentation": "

The Amazon Web Services managed policy ARN that you want to attach to a permission set as a\n permissions boundary.

" + "smithy.api#documentation": "

The Amazon Web Services managed policy ARN that you want to attach to a permission set as a permissions boundary.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies the configuration of the Amazon Web Services managed or customer managed policy that you\n want to set as a permissions boundary. Specify either\n CustomerManagedPolicyReference to use the name and path of a customer\n managed policy, or ManagedPolicyArn to use the ARN of an Amazon Web Services managed\n policy. A permissions boundary represents the maximum permissions that any policy can\n grant your role. For more information, see Permissions boundaries\n for IAM entities in the IAM User Guide.

\n \n

Policies used as permissions boundaries don't provide permissions. You must also\n attach an IAM policy to the role. To learn how the effective permissions for a\n role are evaluated, see IAM JSON\n policy evaluation logic in the IAM User\n Guide.

\n
" + "smithy.api#documentation": "

Specifies the configuration of the Amazon Web Services managed or customer managed policy that you want to set as a permissions boundary. Specify either CustomerManagedPolicyReference to use the name and path of a customer managed policy, or ManagedPolicyArn to use the ARN of an Amazon Web Services managed policy. A permissions boundary represents the maximum permissions that any policy can grant your role. For more information, see Permissions boundaries for IAM entities in the IAM User Guide.

Policies used as permissions boundaries don't provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.

" } }, "com.amazonaws.ssoadmin#PortalOptions": { @@ -6054,7 +6257,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that describes the options for the access portal associated with an\n application.

" + "smithy.api#documentation": "

A structure that describes the options for the access portal associated with an application.

" } }, "com.amazonaws.ssoadmin#PrincipalId": { @@ -6113,7 +6316,7 @@ } ], "traits": { - "smithy.api#documentation": "

The process by which a specified permission set is provisioned to the specified\n target.

" + "smithy.api#documentation": "

The process by which a specified permission set is provisioned to the specified target.

" } }, "com.amazonaws.ssoadmin#ProvisionPermissionSetRequest": { @@ -6122,7 +6325,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -6228,7 +6431,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or updates the list of authorized targets for an IAM Identity Center access scope for an\n application.

", + "smithy.api#documentation": "

Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.

", "smithy.api#idempotent": {} } }, @@ -6238,20 +6441,20 @@ "Scope": { "target": "com.amazonaws.ssoadmin#Scope", "traits": { - "smithy.api#documentation": "

Specifies the name of the access scope to be associated with the specified\n targets.

", + "smithy.api#documentation": "

Specifies the name of the access scope to be associated with the specified targets.

", "smithy.api#required": {} } }, "AuthorizedTargets": { "target": "com.amazonaws.ssoadmin#ScopeTargets", "traits": { - "smithy.api#documentation": "

Specifies an array list of ARNs that represent the authorized targets for this access\n scope.

" + "smithy.api#documentation": "

Specifies an array list of ARNs that represent the authorized targets for this access scope.

" } }, "ApplicationArn": { "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the application with the access scope with the targets to add or\n update.

", + "smithy.api#documentation": "

Specifies the ARN of the application with the access scope with the targets to add or update.

", "smithy.api#required": {} } } @@ -6289,7 +6492,7 @@ } ], "traits": { - "smithy.api#documentation": "

Configure how users gain access to an application. If AssignmentsRequired\n is true (default value), users don’t have access to the application unless\n an assignment is created using the CreateApplicationAssignment API. If false, all users have\n access to the application. If an assignment is created using CreateApplicationAssignment., the user retains access if\n AssignmentsRequired is set to true.

", + "smithy.api#documentation": "

Configure how users gain access to an application. If AssignmentsRequired is true (default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have access to the application. If an assignment is created using CreateApplicationAssignment., the user retains access if AssignmentsRequired is set to true.

", "smithy.api#idempotent": {} } }, @@ -6299,7 +6502,7 @@ "ApplicationArn": { "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -6307,7 +6510,7 @@ "target": "com.amazonaws.ssoadmin#AssignmentRequired", "traits": { "smithy.api#default": true, - "smithy.api#documentation": "

If AssignmentsRequired is true (default value), users don’t\n have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have\n access to the application.

", + "smithy.api#documentation": "

If AssignmentsRequired is true (default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have access to the application.

", "smithy.api#required": {} } } @@ -6362,7 +6565,7 @@ "ApplicationArn": { "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the application with the authentication method to add or\n update.

", + "smithy.api#documentation": "

Specifies the ARN of the application with the authentication method to add or update.

", "smithy.api#required": {} } }, @@ -6376,7 +6579,7 @@ "AuthenticationMethod": { "target": "com.amazonaws.ssoadmin#AuthenticationMethod", "traits": { - "smithy.api#documentation": "

Specifies a structure that describes the authentication method to add or update. The\n structure type you provide is determined by the AuthenticationMethodType\n parameter.

", + "smithy.api#documentation": "

Specifies a structure that describes the authentication method to add or update. The structure type you provide is determined by the AuthenticationMethodType parameter.

", "smithy.api#required": {} } } @@ -6414,7 +6617,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a configuration for an application to use grants. Conceptually grants are\n authorization to request actions related to tokens. This configuration will be used when\n parties are requesting and receiving tokens during the trusted identity propagation\n process. For more information on the IAM Identity Center supported grant workflows, see SAML 2.0\n and OAuth 2.0.

\n

A grant is created between your applications and Identity Center instance which\n enables an application to use specified mechanisms to obtain tokens. These tokens are\n used by your applications to gain access to Amazon Web Services resources on behalf of users. The\n following elements are within these exchanges:

\n
    \n
  • \n

    \n Requester - The application requesting access\n to Amazon Web Services resources.

    \n
  • \n
  • \n

    \n Subject - Typically the user that is\n requesting access to Amazon Web Services resources.

    \n
  • \n
  • \n

    \n Grant - Conceptually, a grant is\n authorization to access Amazon Web Services resources. These grants authorize token generation\n for authenticating access to the requester and for the request to make requests\n on behalf of the subjects. There are four types of grants:

    \n
      \n
    • \n

      \n AuthorizationCode - Allows an\n application to request authorization through a series of user-agent\n redirects.

      \n
    • \n
    • \n

      \n JWT bearer - Authorizes an\n application to exchange a JSON Web Token that came from an external\n identity provider. To learn more, see RFC\n 6479.

      \n
    • \n
    • \n

      \n Refresh token - Enables application\n to request new access tokens to replace expiring or expired access\n tokens.

      \n
    • \n
    • \n

      \n Exchange token - A grant that\n requests tokens from the authorization server by providing a ‘subject’\n token with access scope authorizing trusted identity propagation to this\n application. To learn more, see RFC\n 8693.

      \n
    • \n
    \n
  • \n
  • \n

    \n Authorization server - IAM Identity Center requests\n tokens.

    \n
  • \n
\n

User credentials are never shared directly within these exchanges. Instead,\n applications use grants to request access tokens from IAM Identity Center. For more\n information, see RFC\n 6479.

\n

\n Use cases\n

\n
    \n
  • \n

    Connecting to custom applications.

    \n
  • \n
  • \n

    Configuring an Amazon Web Services service to make calls to another Amazon Web Services services using JWT\n tokens.

    \n
  • \n
", + "smithy.api#documentation": "

Creates a configuration for an application to use grants. Conceptually grants are authorization to request actions related to tokens. This configuration will be used when parties are requesting and receiving tokens during the trusted identity propagation process. For more information on the IAM Identity Center supported grant workflows, see SAML 2.0 and OAuth 2.0.

A grant is created between your applications and Identity Center instance which enables an application to use specified mechanisms to obtain tokens. These tokens are used by your applications to gain access to Amazon Web Services resources on behalf of users. The following elements are within these exchanges:

  • Requester - The application requesting access to Amazon Web Services resources.

  • Subject - Typically the user that is requesting access to Amazon Web Services resources.

  • Grant - Conceptually, a grant is authorization to access Amazon Web Services resources. These grants authorize token generation for authenticating access to the requester and for the request to make requests on behalf of the subjects. There are four types of grants:

    • AuthorizationCode - Allows an application to request authorization through a series of user-agent redirects.

    • JWT bearer - Authorizes an application to exchange a JSON Web Token that came from an external identity provider. To learn more, see RFC 6479.

    • Refresh token - Enables application to request new access tokens to replace expiring or expired access tokens.

    • Exchange token - A grant that requests tokens from the authorization server by providing a ‘subject’ token with access scope authorizing trusted identity propagation to this application. To learn more, see RFC 8693.

  • Authorization server - IAM Identity Center requests tokens.

User credentials are never shared directly within these exchanges. Instead, applications use grants to request access tokens from IAM Identity Center. For more information, see RFC 6479.

Use cases

  • Connecting to custom applications.

  • Configuring an Amazon Web Services service to make calls to another Amazon Web Services services using JWT tokens.

", "smithy.api#idempotent": {} } }, @@ -6447,6 +6650,67 @@ "smithy.api#input": {} } }, + "com.amazonaws.ssoadmin#PutApplicationSessionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssoadmin#PutApplicationSessionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.ssoadmin#PutApplicationSessionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssoadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssoadmin#ConflictException" + }, + { + "target": "com.amazonaws.ssoadmin#InternalServerException" + }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssoadmin#ThrottlingException" + }, + { + "target": "com.amazonaws.ssoadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the session configuration for an application in IAM Identity Center.

The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services managed application without having to remain signed in to an active session while the job runs.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssoadmin#PutApplicationSessionConfigurationRequest": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.ssoadmin#ApplicationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application for which to update the session configuration.

", + "smithy.api#required": {} + } + }, + "UserBackgroundSessionApplicationStatus": { + "target": "com.amazonaws.ssoadmin#UserBackgroundSessionApplicationStatus", + "traits": { + "smithy.api#documentation": "

The status of user background sessions for the application.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssoadmin#PutApplicationSessionConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ssoadmin#PutInlinePolicyToPermissionSet": { "type": "operation", "input": { @@ -6479,7 +6743,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches an inline policy to a permission set.

\n \n

If the permission set is already referenced by one or more account assignments,\n you will need to call \n ProvisionPermissionSet\n after\n this action to apply the corresponding IAM policy updates to all assigned\n accounts.

\n
" + "smithy.api#documentation": "

Attaches an inline policy to a permission set.

If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this action to apply the corresponding IAM policy updates to all assigned accounts.

" } }, "com.amazonaws.ssoadmin#PutInlinePolicyToPermissionSetRequest": { @@ -6488,7 +6752,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -6570,7 +6834,7 @@ "PermissionsBoundary": { "target": "com.amazonaws.ssoadmin#PermissionsBoundary", "traits": { - "smithy.api#documentation": "

The permissions boundary that you want to attach to a\n PermissionSet.

", + "smithy.api#documentation": "

The permissions boundary that you want to attach to a PermissionSet.

", "smithy.api#required": {} } } @@ -6608,7 +6872,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

A structure that defines configuration settings for an application that supports the\n OAuth 2.0 Refresh Token Grant. For more, see RFC\n 6749.

" + "smithy.api#documentation": "

A structure that defines configuration settings for an application that supports the OAuth 2.0 Refresh Token Grant. For more, see RFC 6749.

" } }, "com.amazonaws.ssoadmin#RelayState": { @@ -6626,6 +6890,12 @@ "members": { "Message": { "target": "com.amazonaws.ssoadmin#ResourceNotFoundMessage" + }, + "Reason": { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundExceptionReason", + "traits": { + "smithy.api#documentation": "

The reason for the resource not found exception.

" + } } }, "traits": { @@ -6634,6 +6904,17 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.ssoadmin#ResourceNotFoundExceptionReason": { + "type": "enum", + "members": { + "KMS_NOT_FOUND_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS_NotFoundException" + } + } + } + }, "com.amazonaws.ssoadmin#ResourceNotFoundMessage": { "type": "string" }, @@ -6643,7 +6924,7 @@ "Scopes": { "target": "com.amazonaws.ssoadmin#ResourceServerScopes", "traits": { - "smithy.api#documentation": "

A list of the IAM Identity Center access scopes that are associated with this resource\n server.

" + "smithy.api#documentation": "

A list of the IAM Identity Center access scopes that are associated with this resource server.

" } } }, @@ -6678,7 +6959,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that describes details for an IAM Identity Center access scope that is associated with a\n resource server.

" + "smithy.api#documentation": "

A structure that describes details for an IAM Identity Center access scope that is associated with a resource server.

" } }, "com.amazonaws.ssoadmin#ResourceServerScopes": { @@ -6787,6 +7068,9 @@ { "target": "com.amazonaws.ssoadmin#GetApplicationAssignmentConfiguration" }, + { + "target": "com.amazonaws.ssoadmin#GetApplicationSessionConfiguration" + }, { "target": "com.amazonaws.ssoadmin#GetInlinePolicyForPermissionSet" }, @@ -6850,6 +7134,9 @@ { "target": "com.amazonaws.ssoadmin#PutApplicationAssignmentConfiguration" }, + { + "target": "com.amazonaws.ssoadmin#PutApplicationSessionConfiguration" + }, { "target": "com.amazonaws.ssoadmin#PutInlinePolicyToPermissionSet" }, @@ -6901,7 +7188,7 @@ "name": "sso" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

IAM Identity Center is the Amazon Web Services solution for connecting your workforce users to Amazon Web Services managed\n applications and other Amazon Web Services resources. You can connect your existing identity provider\n and synchronize users and groups from your directory, or create and manage your users\n directly in IAM Identity Center. You can then use IAM Identity Center for either or both of the following:

\n
    \n
  • \n

    User access to applications

    \n
  • \n
  • \n

    User access to Amazon Web Services accounts

    \n
  • \n
\n

This guide provides information about single sign-on operations that you can use for access to applications and \n Amazon Web Services accounts. For information about IAM Identity Center features, see the\n IAM Identity Center\n User Guide.

\n \n

IAM Identity Center uses the sso and identitystore API\n namespaces.

\n
\n

Many API operations for IAM Identity Center rely on identifiers for users and groups, known as\n principals. For more information about how to work with principals and principal IDs in\n IAM Identity Center, see the Identity Store API\n Reference.

\n \n

Amazon Web Services provides SDKs that consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The\n SDKs provide a convenient way to create programmatic access to IAM Identity Center and other Amazon Web Services\n services. For more information about the Amazon Web Services SDKs, including how to download and\n install them, see Tools for Amazon Web\n Services.

\n
", + "smithy.api#documentation": "

IAM Identity Center is the Amazon Web Services solution for connecting your workforce users to Amazon Web Services managed applications and other Amazon Web Services resources. You can connect your existing identity provider and synchronize users and groups from your directory, or create and manage your users directly in IAM Identity Center. You can then use IAM Identity Center for either or both of the following:

  • User access to applications

  • User access to Amazon Web Services accounts

This guide provides information about single sign-on operations that you can use for access to applications and Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.

IAM Identity Center uses the sso and identitystore API namespaces.

Many API operations for IAM Identity Center rely on identifiers for users and groups, known as principals. For more information about how to work with principals and principal IDs in IAM Identity Center, see the Identity Store API Reference.

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.

", "smithy.api#suppress": [ "DeprecatedShape" ], @@ -7663,17 +7950,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -7687,17 +7963,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -7711,17 +7976,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -7735,17 +7989,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -7890,7 +8133,7 @@ } }, "traits": { - "smithy.api#documentation": "

Indicates that the principal has crossed the permitted number of resources that can be\n created.

", + "smithy.api#documentation": "

Indicates that the principal has crossed the permitted number of resources that can be created.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -7904,14 +8147,14 @@ "Origin": { "target": "com.amazonaws.ssoadmin#SignInOrigin", "traits": { - "smithy.api#documentation": "

This determines how IAM Identity Center navigates the user to the target application. It can be one\n of the following values:

\n
    \n
  • \n

    \n APPLICATION: IAM Identity Center redirects the customer to the configured\n ApplicationUrl.

    \n
  • \n
  • \n

    \n IDENTITY_CENTER: IAM Identity Center uses SAML identity-provider initiated\n authentication to sign the customer directly into a SAML-based\n application.

    \n
  • \n
", + "smithy.api#documentation": "

This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values:

  • APPLICATION: IAM Identity Center redirects the customer to the configured ApplicationUrl.

  • IDENTITY_CENTER: IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.

", "smithy.api#required": {} } }, "ApplicationUrl": { "target": "com.amazonaws.ssoadmin#ApplicationUrl", "traits": { - "smithy.api#documentation": "

The URL that accepts authentication requests for an application. This is a required\n parameter if the Origin parameter is APPLICATION.

" + "smithy.api#documentation": "

The URL that accepts authentication requests for an application. This is a required parameter if the Origin parameter is APPLICATION.

" } } }, @@ -7978,7 +8221,7 @@ } }, "traits": { - "smithy.api#documentation": "

A set of key-value pairs that are used to manage the resource. Tags can only be\n applied to permission sets and cannot be applied to corresponding roles that IAM Identity Center\n creates in Amazon Web Services accounts.

" + "smithy.api#documentation": "

A set of key-value pairs that are used to manage the resource. Tags can only be applied to permission sets and cannot be applied to corresponding roles that IAM Identity Center creates in Amazon Web Services accounts.

" } }, "com.amazonaws.ssoadmin#TagKey": { @@ -8056,7 +8299,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" } }, "ResourceArn": { @@ -8131,10 +8374,16 @@ "members": { "Message": { "target": "com.amazonaws.ssoadmin#ThrottlingExceptionMessage" + }, + "Reason": { + "target": "com.amazonaws.ssoadmin#ThrottlingExceptionReason", + "traits": { + "smithy.api#documentation": "

The reason for the throttling exception.

" + } } }, "traits": { - "smithy.api#documentation": "

Indicates that the principal has crossed the throttling limits of the API\n operations.

", + "smithy.api#documentation": "

Indicates that the principal has crossed the throttling limits of the API operations.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -8142,6 +8391,17 @@ "com.amazonaws.ssoadmin#ThrottlingExceptionMessage": { "type": "string" }, + "com.amazonaws.ssoadmin#ThrottlingExceptionReason": { + "type": "enum", + "members": { + "KMS_THROTTLING_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS_ThrottlingException" + } + } + } + }, "com.amazonaws.ssoadmin#Token": { "type": "string", "traits": { @@ -8156,7 +8416,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

A structure that defines configuration settings for an application that supports the\n OAuth 2.0 Token Exchange Grant. For more information, see RFC 8693.

" + "smithy.api#documentation": "

A structure that defines configuration settings for an application that supports the OAuth 2.0 Token Exchange Grant. For more information, see RFC 8693.

" } }, "com.amazonaws.ssoadmin#TokenIssuerAudience": { @@ -8196,12 +8456,12 @@ "OidcJwtConfiguration": { "target": "com.amazonaws.ssoadmin#OidcJwtConfiguration", "traits": { - "smithy.api#documentation": "

A structure that describes the settings for a trusted token issuer that works with OpenID Connect\n (OIDC) by using JSON Web Tokens (JWT).

" + "smithy.api#documentation": "

A structure that describes the settings for a trusted token issuer that works with OpenID Connect (OIDC) by using JSON Web Tokens (JWT).

" } } }, "traits": { - "smithy.api#documentation": "

A structure that describes the configuration of a trusted token issuer. The structure and available\n settings are determined by the type of the trusted token issuer.

" + "smithy.api#documentation": "

A structure that describes the configuration of a trusted token issuer. The structure and available settings are determined by the type of the trusted token issuer.

" } }, "com.amazonaws.ssoadmin#TrustedTokenIssuerList": { @@ -8263,12 +8523,12 @@ "OidcJwtConfiguration": { "target": "com.amazonaws.ssoadmin#OidcJwtUpdateConfiguration", "traits": { - "smithy.api#documentation": "

A structure that describes an updated configuration for a trusted token issuer that uses OpenID\n Connect (OIDC) with JSON web tokens (JWT).

" + "smithy.api#documentation": "

A structure that describes an updated configuration for a trusted token issuer that uses OpenID Connect (OIDC) with JSON web tokens (JWT).

" } } }, "traits": { - "smithy.api#documentation": "

A structure that contains details to be updated for a trusted token issuer configuration. The\n structure and settings that you can include depend on the type of the trusted token issuer being\n updated.

" + "smithy.api#documentation": "

A structure that contains details to be updated for a trusted token issuer configuration. The structure and settings that you can include depend on the type of the trusted token issuer being updated.

" } }, "com.amazonaws.ssoadmin#TrustedTokenIssuerUrl": { @@ -8332,7 +8592,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

" } }, "ResourceArn": { @@ -8401,7 +8661,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that describes the options for the access portal associated with an\n application that can be updated.

" + "smithy.api#documentation": "

A structure that describes the options for the access portal associated with an application that can be updated.

" } }, "com.amazonaws.ssoadmin#UpdateApplicationRequest": { @@ -8410,7 +8670,7 @@ "ApplicationArn": { "target": "com.amazonaws.ssoadmin#ApplicationArn", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -8435,7 +8695,7 @@ "PortalOptions": { "target": "com.amazonaws.ssoadmin#UpdateApplicationPortalOptions", "traits": { - "smithy.api#documentation": "

A structure that describes the options for the portal associated with an\n application.

" + "smithy.api#documentation": "

A structure that describes the options for the portal associated with an application.

" } } }, @@ -8468,6 +8728,9 @@ { "target": "com.amazonaws.ssoadmin#InternalServerException" }, + { + "target": "com.amazonaws.ssoadmin#ResourceNotFoundException" + }, { "target": "com.amazonaws.ssoadmin#ThrottlingException" }, @@ -8476,7 +8739,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update the details for the instance of IAM Identity Center that is owned by the\n Amazon Web Services account.

" + "smithy.api#documentation": "

Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.

" } }, "com.amazonaws.ssoadmin#UpdateInstanceAccessControlAttributeConfiguration": { @@ -8508,7 +8771,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance\n for attributes-based access control (ABAC). When using an external identity provider as\n an identity source, you can pass attributes through the SAML assertion as an alternative\n to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any\n of these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center\n identity store. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

" + "smithy.api#documentation": "

Updates the IAM Identity Center identity store attributes that you can use with the IAM Identity Center instance for attributes-based access control (ABAC). When using an external identity provider as an identity source, you can pass attributes through the SAML assertion as an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center replaces the attribute value with the value from the IAM Identity Center identity store. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.

" } }, "com.amazonaws.ssoadmin#UpdateInstanceAccessControlAttributeConfigurationRequest": { @@ -8546,16 +8809,21 @@ "Name": { "target": "com.amazonaws.ssoadmin#NameType", "traits": { - "smithy.api#documentation": "

Updates the instance name.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Updates the instance name.

" } }, "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.ssoadmin#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the encryption configuration for your IAM Identity Center instance. You can use this to configure customer managed KMS keys (CMK) or Amazon Web Services owned KMS keys for encrypting your instance data.

" + } } }, "traits": { @@ -8607,7 +8875,7 @@ "InstanceArn": { "target": "com.amazonaws.ssoadmin#InstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed.\n For more information about ARNs, see Amazon Resource\nNames (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -8627,13 +8895,13 @@ "SessionDuration": { "target": "com.amazonaws.ssoadmin#Duration", "traits": { - "smithy.api#documentation": "

The length of time that the application user sessions are valid for in the ISO-8601\n standard.

" + "smithy.api#documentation": "

The length of time that the application user sessions are valid for in the ISO-8601 standard.

" } }, "RelayState": { "target": "com.amazonaws.ssoadmin#RelayState", "traits": { - "smithy.api#documentation": "

Used to redirect users within the application during the federation authentication\n process.

" + "smithy.api#documentation": "

Used to redirect users within the application during the federation authentication process.

" } } }, @@ -8677,7 +8945,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the name of the trusted token issuer, or the path of a source attribute or destination\n attribute for a trusted token issuer configuration.

\n \n

Updating this trusted token issuer configuration might cause users to lose access to any\n applications that are configured to use the trusted token issuer.

\n
" + "smithy.api#documentation": "

Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.

Updating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issuer.

" } }, "com.amazonaws.ssoadmin#UpdateTrustedTokenIssuerRequest": { @@ -8699,7 +8967,7 @@ "TrustedTokenIssuerConfiguration": { "target": "com.amazonaws.ssoadmin#TrustedTokenIssuerUpdateConfiguration", "traits": { - "smithy.api#documentation": "

Specifies a structure with settings to apply to the specified trusted token issuer. The settings that\n you can provide are determined by the type of the trusted token issuer that you are updating.

" + "smithy.api#documentation": "

Specifies a structure with settings to apply to the specified trusted token issuer. The settings that you can provide are determined by the type of the trusted token issuer that you are updating.

" } } }, @@ -8714,11 +8982,34 @@ "smithy.api#output": {} } }, + "com.amazonaws.ssoadmin#UserBackgroundSessionApplicationStatus": { + "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.ssoadmin#ValidationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.ssoadmin#ValidationExceptionMessage" + }, + "Reason": { + "target": "com.amazonaws.ssoadmin#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

The reason for the validation exception.

" + } } }, "traits": { @@ -8729,6 +9020,29 @@ }, "com.amazonaws.ssoadmin#ValidationExceptionMessage": { "type": "string" + }, + "com.amazonaws.ssoadmin#ValidationExceptionReason": { + "type": "enum", + "members": { + "KMS_INVALID_KEY_USAGE_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS_InvalidKeyUsageException" + } + }, + "KMS_INVALID_STATE_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS_InvalidStateException" + } + }, + "KMS_DISABLED_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS_DisabledException" + } + } + } } } } \ No newline at end of file diff --git a/codegen/sdk/aws-models/sso-oidc.json b/codegen/sdk/aws-models/sso-oidc.json index 6befd215c17..f3283f25f0a 100644 --- a/codegen/sdk/aws-models/sso-oidc.json +++ b/codegen/sdk/aws-models/sso-oidc.json @@ -58,7 +58,7 @@ "name": "sso-oauth" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a\n native application) to register with IAM Identity Center. The service also enables the client to fetch the\n user’s access token upon successful authentication and authorization with IAM Identity Center.

\n

\n API namespaces\n

\n

IAM Identity Center uses the sso and identitystore API namespaces. IAM Identity Center\n OpenID Connect uses the sso-oidc namespace.

\n

\n Considerations for using this guide\n

\n

Before you begin using this guide, we recommend that you first review the following\n important information about how the IAM Identity Center OIDC service works.

\n
    \n
  • \n

    The IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0 Device\n Authorization Grant standard (https://tools.ietf.org/html/rfc8628) that are necessary to enable single\n sign-on authentication with the CLI.

    \n
  • \n
  • \n

    With older versions of the CLI, the service only emits OIDC access tokens, so to\n obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that\n supports token refresh and doesn’t require re-authentication, update to the latest CLI\n version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh\n and configurable IAM Identity Center session durations. For more information, see Configure Amazon Web Services access portal session duration .

    \n
  • \n
  • \n

    The access tokens provided by this service grant access to all Amazon Web Services account\n entitlements assigned to an IAM Identity Center user, not just a particular application.

    \n
  • \n
  • \n

    The documentation in this guide does not describe the mechanism to convert the access\n token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service\n endpoints. For more information, see GetRoleCredentials in the IAM Identity Center Portal API Reference\n Guide.

    \n
  • \n
\n

For general information about IAM Identity Center, see What is\n IAM Identity Center? in the IAM Identity Center User Guide.

", + "smithy.api#documentation": "

IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a\n native application) to register with IAM Identity Center. The service also enables the client to fetch the\n user’s access token upon successful authentication and authorization with IAM Identity Center.

\n

\n API namespaces\n

\n

IAM Identity Center uses the sso and identitystore API namespaces. IAM Identity Center\n OpenID Connect uses the sso-oauth namespace.

\n

\n Considerations for using this guide\n

\n

Before you begin using this guide, we recommend that you first review the following\n important information about how the IAM Identity Center OIDC service works.

\n
    \n
  • \n

    The IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0 Device\n Authorization Grant standard (https://tools.ietf.org/html/rfc8628) that are necessary to enable single\n sign-on authentication with the CLI.

    \n
  • \n
  • \n

    With older versions of the CLI, the service only emits OIDC access tokens, so to\n obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that\n supports token refresh and doesn’t require re-authentication, update to the latest CLI\n version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh\n and configurable IAM Identity Center session durations. For more information, see Configure Amazon Web Services access portal session duration .

    \n
  • \n
  • \n

    The access tokens provided by this service grant access to all Amazon Web Services account\n entitlements assigned to an IAM Identity Center user, not just a particular application.

    \n
  • \n
  • \n

    The documentation in this guide does not describe the mechanism to convert the access\n token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service\n endpoints. For more information, see GetRoleCredentials in the IAM Identity Center Portal API Reference\n Guide.

    \n
  • \n
\n

For general information about IAM Identity Center, see What is\n IAM Identity Center? in the IAM Identity Center User Guide.

", "smithy.api#title": "AWS SSO OIDC", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -804,17 +804,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -828,17 +817,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -852,17 +830,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -876,17 +843,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -971,6 +927,12 @@ "smithy.api#documentation": "

Single error code. For this exception the value will be access_denied.

" } }, + "reason": { + "target": "com.amazonaws.ssooidc#AccessDeniedExceptionReason", + "traits": { + "smithy.api#documentation": "

A string that uniquely identifies a reason for the error.

" + } + }, "error_description": { "target": "com.amazonaws.ssooidc#ErrorDescription", "traits": { @@ -984,6 +946,17 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.ssooidc#AccessDeniedExceptionReason": { + "type": "enum", + "members": { + "KMS_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS_AccessDeniedException" + } + } + } + }, "com.amazonaws.ssooidc#AccessToken": { "type": "string", "traits": { @@ -1030,12 +1003,12 @@ "identityContext": { "target": "com.amazonaws.ssooidc#IdentityContext", "traits": { - "smithy.api#documentation": "

STS context assertion that carries a user identifier to the Amazon Web Services service that it calls\n and can be used to obtain an identity-enhanced IAM role session. This value corresponds to\n the sts:identity_context claim in the ID token.

" + "smithy.api#documentation": "

The trusted context assertion is signed and encrypted by STS. It provides access to\n sts:identity_context claim in the idToken without JWT\n parsing

\n

Identity context comprises information that Amazon Web Services services use to make authorization\n decisions when they receive requests.

" } } }, "traits": { - "smithy.api#documentation": "

This structure contains Amazon Web Services-specific parameter extensions for the token endpoint\n responses and includes the identity context.

" + "smithy.api#documentation": "

This structure contains Amazon Web Services-specific parameter extensions and the identity context.

" } }, "com.amazonaws.ssooidc#ClientId": { @@ -1195,7 +1168,7 @@ "scope": { "target": "com.amazonaws.ssooidc#Scopes", "traits": { - "smithy.api#documentation": "

The list of scopes for which authorization is requested. The access token that is issued\n is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes\n all scopes that are configured for the client during the call to RegisterClient.

" + "smithy.api#documentation": "

The list of scopes for which authorization is requested. This parameter has no effect; the access token will always include all scopes configured during client registration.

" } }, "redirectUri": { @@ -1301,7 +1274,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates and returns access and refresh tokens for clients and applications that are\n authenticated using IAM entities. The access token can be used to fetch short-lived\n credentials for the assigned Amazon Web Services accounts or to access application APIs using\n bearer authentication.

", + "smithy.api#documentation": "

Creates and returns access and refresh tokens for authorized client applications that are\n authenticated using any IAM entity, such as a service\n role or user. These tokens might contain defined scopes that specify permissions such as read:profile or write:data. Through downscoping, you can use the scopes parameter to request tokens with reduced permissions compared to the original client application's permissions or, if applicable, the refresh token's scopes. The access token can be used to fetch short-lived credentials for the assigned\n Amazon Web Services accounts or to access application APIs using bearer authentication.

\n \n

This API is used with Signature Version 4. For more information, see Amazon Web Services Signature\n Version 4 for API Requests.

\n
", "smithy.api#examples": [ { "title": "Call OAuth/OIDC /token endpoint for Authorization Code grant with IAM authentication", @@ -1539,7 +1512,7 @@ "awsAdditionalDetails": { "target": "com.amazonaws.ssooidc#AwsAdditionalDetails", "traits": { - "smithy.api#documentation": "

A structure containing information from the idToken. Only the\n identityContext is in it, which is a value extracted from the\n idToken. This provides direct access to identity information without requiring\n JWT parsing.

" + "smithy.api#documentation": "

A structure containing information from IAM Identity Center managed user and group\n information.

" } } }, @@ -1727,6 +1700,12 @@ "smithy.api#documentation": "

Single error code. For this exception the value will be\n invalid_request.

" } }, + "reason": { + "target": "com.amazonaws.ssooidc#InvalidRequestExceptionReason", + "traits": { + "smithy.api#documentation": "

A string that uniquely identifies a reason for the error.

" + } + }, "error_description": { "target": "com.amazonaws.ssooidc#ErrorDescription", "traits": { @@ -1740,6 +1719,35 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.ssooidc#InvalidRequestExceptionReason": { + "type": "enum", + "members": { + "KMS_KEY_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS_NotFoundException" + } + }, + "KMS_INVALID_KEY_USAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS_InvalidKeyUsageException" + } + }, + "KMS_INVALID_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS_InvalidStateException" + } + }, + "KMS_DISABLED_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS_DisabledException" + } + } + } + }, "com.amazonaws.ssooidc#InvalidRequestRegionException": { "type": "structure", "members": { @@ -1844,6 +1852,9 @@ { "target": "com.amazonaws.ssooidc#InvalidScopeException" }, + { + "target": "com.amazonaws.ssooidc#SlowDownException" + }, { "target": "com.amazonaws.ssooidc#UnsupportedGrantTypeException" } diff --git a/codegen/sdk/aws-models/sso.json b/codegen/sdk/aws-models/sso.json index ab26fa26700..0cdb54058e2 100644 --- a/codegen/sdk/aws-models/sso.json +++ b/codegen/sdk/aws-models/sso.json @@ -1280,17 +1280,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1304,17 +1293,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1328,17 +1306,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1352,17 +1319,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/storage-gateway.json b/codegen/sdk/aws-models/storage-gateway.json index 6930051b54d..19c6c6e0c4c 100644 --- a/codegen/sdk/aws-models/storage-gateway.json +++ b/codegen/sdk/aws-models/storage-gateway.json @@ -10512,17 +10512,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -10536,17 +10525,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -10560,17 +10538,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -10584,17 +10551,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/sts.json b/codegen/sdk/aws-models/sts.json index 49dfd5d99ab..f81e9c9cf3d 100644 --- a/codegen/sdk/aws-models/sts.json +++ b/codegen/sdk/aws-models/sts.json @@ -1521,17 +1521,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1545,17 +1534,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1569,17 +1547,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1593,17 +1560,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/supplychain.json b/codegen/sdk/aws-models/supplychain.json index 7f847ffdb8e..7d32e91e940 100644 --- a/codegen/sdk/aws-models/supplychain.json +++ b/codegen/sdk/aws-models/supplychain.json @@ -3914,17 +3914,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3938,17 +3927,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3962,17 +3940,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3986,17 +3953,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/support-app.json b/codegen/sdk/aws-models/support-app.json index c636d368760..2e500936f40 100644 --- a/codegen/sdk/aws-models/support-app.json +++ b/codegen/sdk/aws-models/support-app.json @@ -1238,17 +1238,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1262,17 +1251,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1286,17 +1264,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1310,17 +1277,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/support.json b/codegen/sdk/aws-models/support.json index 90099d61b5f..413ef9ad772 100644 --- a/codegen/sdk/aws-models/support.json +++ b/codegen/sdk/aws-models/support.json @@ -94,7 +94,7 @@ "name": "support" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Web Services Support\n

The Amazon Web Services Support API Reference is intended for programmers who need detailed\n information about the Amazon Web Services Support operations and data types. You can use the API to manage\n your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return\n results in JSON format.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    If you call the Amazon Web Services Support API from an account that doesn't have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
\n

You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of\n checks and their descriptions, get check results, specify checks to refresh, and get the\n refresh status of checks.

\n

You can manage your support cases with the following Amazon Web Services Support API operations:

\n \n

You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more\n information, see Trusted Advisor in the\n Amazon Web Services Support User Guide.

\n

For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing\n Process.

\n

For more information about this service and the endpoints to use, see About the\n Amazon Web Services Support API in the Amazon Web Services Support User Guide.

", + "smithy.api#documentation": "Amazon Web Services Support\n

The Amazon Web Services Support API Reference is intended for programmers who need detailed\n information about the Amazon Web Services Support operations and data types. You can use the API to manage\n your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return\n results in JSON format.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    If you call the Amazon Web Services Support API from an account that doesn't have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
\n

You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of\n checks and their descriptions, get check results, specify checks to refresh, and get the\n refresh status of checks.

\n

You can manage your support cases with the following Amazon Web Services Support API operations:

\n \n

You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more\n information, see Trusted Advisor in the\n Amazon Web Services Support User Guide.

\n

For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing\n Process.

\n

For more information about this service and the endpoints to use, see About the\n Amazon Web Services Support API in the Amazon Web Services Support User Guide.

", "smithy.api#title": "AWS Support", "smithy.api#xmlNamespace": { "uri": "http://support.amazonaws.com/doc/2013-04-15/" @@ -1023,17 +1023,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1047,17 +1036,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1102,17 +1080,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1126,17 +1093,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/swf.json b/codegen/sdk/aws-models/swf.json index be786921950..f372ce5e355 100644 --- a/codegen/sdk/aws-models/swf.json +++ b/codegen/sdk/aws-models/swf.json @@ -6682,17 +6682,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6706,17 +6695,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -6730,17 +6708,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6754,17 +6721,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/synthetics.json b/codegen/sdk/aws-models/synthetics.json index 1f3851de98e..9a6ef09ca6d 100644 --- a/codegen/sdk/aws-models/synthetics.json +++ b/codegen/sdk/aws-models/synthetics.json @@ -201,6 +201,49 @@ } } }, + "com.amazonaws.synthetics#BrowserConfig": { + "type": "structure", + "members": { + "BrowserType": { + "target": "com.amazonaws.synthetics#BrowserType", + "traits": { + "smithy.api#documentation": "

The browser type associated with this browser configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that specifies the browser type to use for a canary run.

" + } + }, + "com.amazonaws.synthetics#BrowserConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.synthetics#BrowserConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.synthetics#BrowserType": { + "type": "enum", + "members": { + "CHROME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHROME" + } + }, + "FIREFOX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIREFOX" + } + } + } + }, "com.amazonaws.synthetics#Canaries": { "type": "list", "member": { @@ -303,6 +346,24 @@ "smithy.api#documentation": "

Specifies whether to also delete the Lambda functions and layers used by this canary\n when the canary is deleted. If it is AUTOMATIC, the Lambda functions and layers will be deleted\n when the canary is deleted.

\n

If the value of this parameter is OFF, then the value of the DeleteLambda parameter\n of the DeleteCanary operation\n determines whether the Lambda functions and layers will be deleted.

" } }, + "BrowserConfigs": { + "target": "com.amazonaws.synthetics#BrowserConfigs", + "traits": { + "smithy.api#documentation": "

A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers.

\n \n

If not specified, browserConfigs defaults to Chrome.

\n
" + } + }, + "EngineConfigs": { + "target": "com.amazonaws.synthetics#EngineConfigs", + "traits": { + "smithy.api#documentation": "

A list of engine configurations for the canary, one for each browser type that the canary is configured to run on.

\n

All runtime versions syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, use engineConfigs only. \n You can no longer use engineArn in these versions.

\n

Runtime versions older than syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 continue to support engineArn to ensure backward compatibility.

" + } + }, + "VisualReferences": { + "target": "com.amazonaws.synthetics#VisualReferencesOutput", + "traits": { + "smithy.api#documentation": "

A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons.

\n

\n syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, only supports visualReferences. visualReference field is not supported.

\n

Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences\n for consistency and future compatibility.

" + } + }, "Tags": { "target": "com.amazonaws.synthetics#TagMap", "traits": { @@ -501,6 +562,12 @@ "traits": { "smithy.api#documentation": "

Returns the dry run configurations for a canary.

" } + }, + "BrowserType": { + "target": "com.amazonaws.synthetics#BrowserType", + "traits": { + "smithy.api#documentation": "

The browser type associated with this canary run.

" + } } }, "traits": { @@ -1083,6 +1150,12 @@ "smithy.api#documentation": "

Specifies whether to also delete the Lambda functions and layers used by this canary\n when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means\n that the Lambda functions and layers will be deleted when the canary is deleted.

\n

If the value of this parameter is OFF, then the value of the DeleteLambda parameter\n of the DeleteCanary operation\n determines whether the Lambda functions and layers will be deleted.

" } }, + "BrowserConfigs": { + "target": "com.amazonaws.synthetics#BrowserConfigs", + "traits": { + "smithy.api#documentation": "

CloudWatch Synthetics now supports multibrowser canaries for syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 runtimes. This feature allows you to run your canaries on both \n Firefox and Chrome browsers. To create a multibrowser canary, you need to specify the BrowserConfigs with a list of browsers you want to use.

\n \n

If not specified, browserConfigs defaults to Chrome.

\n
" + } + }, "Tags": { "target": "com.amazonaws.synthetics#TagMap", "traits": { @@ -1432,6 +1505,12 @@ "traits": { "smithy.api#documentation": "

Use this parameter to return only canaries that match the names that you specify here. You can\n specify as many as five canary names.

\n

If you specify this parameter, the operation is successful only if you have authorization to view\n all the canaries that you specify in your request. If you do not have permission to view any of \n the canaries, the request fails with a 403 response.

\n

You are required to use the Names parameter if you are logged on to a user or role that has an \n IAM policy that restricts which canaries that you are allowed to view. For more information, \n see \n Limiting a user to viewing specific canaries.

" } + }, + "BrowserType": { + "target": "com.amazonaws.synthetics#BrowserType", + "traits": { + "smithy.api#documentation": "

The type of browser to use for the canary run.

" + } } }, "traits": { @@ -1684,6 +1763,32 @@ } } }, + "com.amazonaws.synthetics#EngineConfig": { + "type": "structure", + "members": { + "EngineArn": { + "target": "com.amazonaws.synthetics#FunctionArn", + "traits": { + "smithy.api#documentation": "

Each engine configuration contains the ARN of the Lambda function that is used as the canary's engine for a specific browser type.\n

" + } + }, + "BrowserType": { + "target": "com.amazonaws.synthetics#BrowserType", + "traits": { + "smithy.api#documentation": "

The browser type associated with this engine configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure of engine configurations for the canary, one for each browser type that the canary is configured to run on.

" + } + }, + "com.amazonaws.synthetics#EngineConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.synthetics#EngineConfig" + } + }, "com.amazonaws.synthetics#EnvironmentVariableName": { "type": "string", "traits": { @@ -1707,7 +1812,7 @@ "traits": { "smithy.api#range": { "min": 1024, - "max": 5120 + "max": 10240 } } }, @@ -2830,6 +2935,18 @@ "traits": { "smithy.api#documentation": "

Specifies whether to also delete the Lambda functions and layers used by this canary\n when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means\n\n that the Lambda functions and layers will be deleted when the canary is deleted.

\n

If the value of this parameter is OFF, then the value of the DeleteLambda parameter\n of the DeleteCanary operation\n determines whether the Lambda functions and layers will be deleted.

" } + }, + "BrowserConfigs": { + "target": "com.amazonaws.synthetics#BrowserConfigs", + "traits": { + "smithy.api#documentation": "

A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers.

\n \n

If not specified, browserConfigs defaults to Chrome.

\n
" + } + }, + "VisualReferences": { + "target": "com.amazonaws.synthetics#VisualReferences", + "traits": { + "smithy.api#documentation": "

A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons.

\n

\n syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, only supports visualReferences. visualReference field is not supported.

\n

Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences\n for consistency and future compatibility.

" + } } }, "traits": { @@ -3878,17 +3995,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3902,17 +4008,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3926,17 +4021,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3950,17 +4034,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -4258,7 +4331,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the configuration of a canary that has \n already been created.

\n

You can't use this operation to update the tags of an existing canary. To \n change the tags of an existing canary, use\n TagResource.

\n \n

When you use the dryRunId field when updating a canary, the only other field you can provide is the Schedule. Adding any other field will thrown an exception.

\n
", + "smithy.api#documentation": "

Updates the configuration of a canary that has already been created.

\n

For multibrowser canaries, you can add or remove browsers by updating the browserConfig list in the update call. For example:

\n
    \n
  • \n

    To add Firefox to a canary that currently uses Chrome, specify browserConfigs as [CHROME, FIREFOX]

    \n
  • \n
  • \n

    To remove Firefox and keep only Chrome, specify browserConfigs as [CHROME]

    \n
  • \n
\n

You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use\n TagResource.

\n \n

When you use the dryRunId field when updating a canary, the only other field you can provide is the Schedule. Adding any other field will thrown an exception.

\n
", "smithy.api#http": { "method": "PATCH", "uri": "/canary/{Name}", @@ -4354,6 +4427,18 @@ "traits": { "smithy.api#documentation": "

Update the existing canary using the updated configurations from the DryRun associated with the DryRunId.

\n \n

When you use the dryRunId field when updating a canary, the only other field you can provide is the Schedule. Adding any other field will thrown an exception.

\n
" } + }, + "VisualReferences": { + "target": "com.amazonaws.synthetics#VisualReferences", + "traits": { + "smithy.api#documentation": "

A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons.

\n

\n syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and above, only supports visualReferences. visualReference field is not supported.

\n

Versions older than syn-nodejs-puppeteer-11.0 supports both visualReference and visualReferences for backward compatibility. It is recommended to use visualReferences\n for consistency and future compatibility.

\n

For multibrowser visual monitoring, you can update the baseline for all configured browsers in a single update call by specifying a list of VisualReference objects, one per browser. \n Each VisualReference object maps to a specific browser configuration, allowing you to manage visual baselines for multiple browsers simultaneously.

\n

For single configuration canaries using Chrome browser (default browser), use visualReferences for syn-nodejs-puppeteer-11.0 and above, and syn-nodejs-playwright-3.0 and \n above canaries. The browserType in the visualReference object is not mandatory.

" + } + }, + "BrowserConfigs": { + "target": "com.amazonaws.synthetics#BrowserConfigs", + "traits": { + "smithy.api#documentation": "

A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both CHROME and FIREFOX browsers.

\n \n

If not specified, browserConfigs defaults to Chrome.

\n
" + } } }, "traits": { @@ -4395,6 +4480,12 @@ "smithy.api#documentation": "

Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are \n nextrun to use the screenshots from the next run after this update is made, lastrun to use the screenshots from the most recent run \n before this update was made, or the value of Id in the \n CanaryRun from a run of this a canary in the past 31 days. If you specify the Id of a canary run older than 31 days, \n the operation returns a 400 validation exception error..

", "smithy.api#required": {} } + }, + "BrowserType": { + "target": "com.amazonaws.synthetics#BrowserType", + "traits": { + "smithy.api#documentation": "

The browser type associated with this visual reference.

" + } } }, "traits": { @@ -4415,12 +4506,42 @@ "traits": { "smithy.api#documentation": "

The ID of the canary run that produced the baseline screenshots \n that are used for visual monitoring comparisons by this canary.

" } + }, + "BrowserType": { + "target": "com.amazonaws.synthetics#BrowserType", + "traits": { + "smithy.api#documentation": "

The browser type associated with this visual reference.

" + } } }, "traits": { "smithy.api#documentation": "

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run that is used as the baseline for screenshots, and the coordinates\n of any parts of those screenshots that are ignored during visual monitoring comparison.

\n

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later.

" } }, + "com.amazonaws.synthetics#VisualReferences": { + "type": "list", + "member": { + "target": "com.amazonaws.synthetics#VisualReferenceInput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.synthetics#VisualReferencesOutput": { + "type": "list", + "member": { + "target": "com.amazonaws.synthetics#VisualReferenceOutput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, "com.amazonaws.synthetics#VpcConfigInput": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/taxsettings.json b/codegen/sdk/aws-models/taxsettings.json index ee8971938c6..b61c67fc486 100644 --- a/codegen/sdk/aws-models/taxsettings.json +++ b/codegen/sdk/aws-models/taxsettings.json @@ -4285,17 +4285,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4317,17 +4306,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4349,17 +4327,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4381,17 +4348,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4413,17 +4369,6 @@ "UseDualStack": false } }, - { - "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": { @@ -4445,17 +4390,6 @@ "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": true - } - }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4478,18 +4412,28 @@ } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://tax-fips.us-isof-south-1.csp.hci.ic.gov" + } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -4500,43 +4444,53 @@ } ] }, - "url": "https://tax-fips.us-isof-south-1.csp.hci.ic.gov" + "url": "https://tax.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", - "UseFIPS": true, + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eusc-de-east-1" + } + ] + }, + "url": "https://tax-fips.eusc-de-east-1.amazonaws.eu" + } }, "params": { - "Region": "us-isof-south-1", - "UseFIPS": false, - "UseDualStack": true + "Region": "eusc-de-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingRegion": "us-isof-south-1" + "signingRegion": "eusc-de-east-1" } ] }, - "url": "https://tax.us-isof-south-1.csp.hci.ic.gov" + "url": "https://tax.eusc-de-east-1.amazonaws.eu" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } diff --git a/codegen/sdk/aws-models/textract.json b/codegen/sdk/aws-models/textract.json index e0b72e30f7a..2c3e1ace8e9 100644 --- a/codegen/sdk/aws-models/textract.json +++ b/codegen/sdk/aws-models/textract.json @@ -5489,17 +5489,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5513,17 +5502,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5537,17 +5515,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5561,17 +5528,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/timestream-influxdb.json b/codegen/sdk/aws-models/timestream-influxdb.json index d21181c31ed..051ade18100 100644 --- a/codegen/sdk/aws-models/timestream-influxdb.json +++ b/codegen/sdk/aws-models/timestream-influxdb.json @@ -599,17 +599,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -623,17 +612,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -647,17 +625,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -671,17 +638,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -826,6 +782,12 @@ "traits": { "smithy.api#enumValue": "DELETED" } + }, + "MAINTENANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAINTENANCE" + } } } }, @@ -3859,6 +3821,12 @@ "traits": { "smithy.api#enumValue": "UPDATING_INSTANCE_TYPE" } + }, + "MAINTENANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAINTENANCE" + } } } }, diff --git a/codegen/sdk/aws-models/timestream-query.json b/codegen/sdk/aws-models/timestream-query.json index e756f1cf11e..4fe0dc8c7ed 100644 --- a/codegen/sdk/aws-models/timestream-query.json +++ b/codegen/sdk/aws-models/timestream-query.json @@ -3786,17 +3786,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3810,17 +3799,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3834,17 +3812,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3858,17 +3825,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/timestream-write.json b/codegen/sdk/aws-models/timestream-write.json index d3d074c1a0f..5ab7fc9efca 100644 --- a/codegen/sdk/aws-models/timestream-write.json +++ b/codegen/sdk/aws-models/timestream-write.json @@ -3676,17 +3676,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3700,17 +3689,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3724,17 +3702,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3748,17 +3715,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/tnb.json b/codegen/sdk/aws-models/tnb.json index a0c77f0f061..b24da2ee066 100644 --- a/codegen/sdk/aws-models/tnb.json +++ b/codegen/sdk/aws-models/tnb.json @@ -5116,17 +5116,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5140,17 +5129,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -5164,17 +5142,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -5188,17 +5155,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/transcribe-streaming.json b/codegen/sdk/aws-models/transcribe-streaming.json index 72305791044..1a4da25544a 100644 --- a/codegen/sdk/aws-models/transcribe-streaming.json +++ b/codegen/sdk/aws-models/transcribe-streaming.json @@ -295,6 +295,33 @@ } } }, + "com.amazonaws.transcribestreaming#CallAnalyticsLanguageIdentification": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribestreaming#CallAnalyticsLanguageWithScore" + } + }, + "com.amazonaws.transcribestreaming#CallAnalyticsLanguageWithScore": { + "type": "structure", + "members": { + "LanguageCode": { + "target": "com.amazonaws.transcribestreaming#CallAnalyticsLanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the identified language.

" + } + }, + "Score": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The confidence score associated with the identified language code. Confidence scores are values between zero and one; larger values indicate a higher confidence in the identified language.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The language code that represents the language identified in your audio, including the associated\n confidence score.

" + } + }, "com.amazonaws.transcribestreaming#CallAnalyticsTranscriptResultStream": { "type": "union", "members": { @@ -1566,12 +1593,32 @@ "smithy.api#documentation": "

Specify settings for post-stream analytics.

", "smithy.api#required": {} } + }, + "MedicalScribeContext": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeContext", + "traits": { + "smithy.api#documentation": "

The MedicalScribeContext object that contains contextual information used to generate\n customized clinical notes.

" + } } }, "traits": { "smithy.api#documentation": "

Specify details to configure the streaming session, including channel definitions, encryption settings, post-stream analytics\n settings, resource access role ARN and vocabulary settings.\n

\n

Whether you are starting a new session or resuming an existing session, \n your first event must be a MedicalScribeConfigurationEvent.\n If you are resuming a session, then this event must have the same configurations that you provided to start the session.\n

" } }, + "com.amazonaws.transcribestreaming#MedicalScribeContext": { + "type": "structure", + "members": { + "PatientContext": { + "target": "com.amazonaws.transcribestreaming#MedicalScribePatientContext", + "traits": { + "smithy.api#documentation": "

Contains patient-specific information used to customize the clinical note generation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The MedicalScribeContext object that contains contextual information which is used during clinical note generation\n to add relevant context to the note.

" + } + }, "com.amazonaws.transcribestreaming#MedicalScribeEncryptionSettings": { "type": "structure", "members": { @@ -1724,6 +1771,20 @@ } } }, + "com.amazonaws.transcribestreaming#MedicalScribePatientContext": { + "type": "structure", + "members": { + "Pronouns": { + "target": "com.amazonaws.transcribestreaming#Pronouns", + "traits": { + "smithy.api#documentation": "

The patient's preferred pronouns that the user wants to provide as a context for clinical note generation .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains patient-specific information.

" + } + }, "com.amazonaws.transcribestreaming#MedicalScribePostStreamAnalyticsResult": { "type": "structure", "members": { @@ -1901,6 +1962,12 @@ "traits": { "smithy.api#documentation": "

The result of post-stream analytics for the HealthScribe streaming session.

" } + }, + "MedicalScribeContextProvided": { + "target": "com.amazonaws.transcribestreaming#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the MedicalScribeContext object was provided when the stream was started.

" + } } }, "traits": { @@ -2282,6 +2349,32 @@ "smithy.api#documentation": "

Allows you to specify additional settings for your Call Analytics post-call request, \n including output locations for your redacted transcript, which IAM role to use, \n and which encryption key to use.

\n

\n DataAccessRoleArn and OutputLocation are required \n fields.

\n

\n PostCallAnalyticsSettings provides you with the same insights as a \n Call Analytics post-call transcription. Refer to Post-call analytics for more information \n on this feature.

" } }, + "com.amazonaws.transcribestreaming#Pronouns": { + "type": "enum", + "members": { + "HE_HIM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HE_HIM" + } + }, + "SHE_HER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHE_HER" + } + }, + "THEY_THEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THEY_THEM" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.transcribestreaming#RequestId": { "type": "string" }, @@ -2485,7 +2578,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to \n Amazon Transcribe and the transcription results are streamed to your application. Use this operation\n for Call Analytics transcriptions.

\n

The following parameters are required:

\n
    \n
  • \n

    \n language-code\n

    \n
  • \n
  • \n

    \n media-encoding\n

    \n
  • \n
  • \n

    \n sample-rate\n

    \n
  • \n
\n

For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.

", + "smithy.api#documentation": "

Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to \n Amazon Transcribe and the transcription results are streamed to your application. Use this operation\n for Call Analytics transcriptions.

\n

The following parameters are required:

\n
    \n
  • \n

    \n language-code or identify-language\n

    \n
  • \n
  • \n

    \n media-encoding\n

    \n
  • \n
  • \n

    \n sample-rate\n

    \n
  • \n
\n

For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.

", "smithy.api#http": { "method": "POST", "uri": "/call-analytics-stream-transcription", @@ -2500,8 +2593,7 @@ "target": "com.amazonaws.transcribestreaming#CallAnalyticsLanguageCode", "traits": { "smithy.api#documentation": "

Specify the language code that represents the language spoken in your audio.

\n

For a list of languages supported with real-time Call Analytics, refer to the \n Supported \n languages table.

", - "smithy.api#httpHeader": "x-amzn-transcribe-language-code", - "smithy.api#required": {} + "smithy.api#httpHeader": "x-amzn-transcribe-language-code" } }, "MediaSampleRateHertz": { @@ -2563,6 +2655,42 @@ "smithy.api#httpHeader": "x-amzn-transcribe-language-model-name" } }, + "IdentifyLanguage": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Enables automatic language identification for your Call Analytics transcription.

\n

If you include IdentifyLanguage, you must include a list of\n language codes, using LanguageOptions, that you think may be present in \n your audio stream. You must provide a minimum of two language selections.

\n

You can also include a preferred language using PreferredLanguage. Adding a \n preferred language can help Amazon Transcribe identify the language faster than if you omit this \n parameter.

\n

Note that you must include either LanguageCode or \n IdentifyLanguage in your request. If you include both parameters, your transcription job\n fails.

", + "smithy.api#httpHeader": "x-amzn-transcribe-identify-language" + } + }, + "LanguageOptions": { + "target": "com.amazonaws.transcribestreaming#LanguageOptions", + "traits": { + "smithy.api#documentation": "

Specify two or more language codes that represent the languages you think may be present \n in your media.

\n

Including language options can improve the accuracy of language identification.

\n

If you include LanguageOptions in your request, you must also include \n IdentifyLanguage.

\n

For a list of languages supported with Call Analytics streaming, refer to the \n Supported \n languages table.

\n \n

You can only include one language dialect per language per stream. For example, you\n cannot include en-US and en-AU in the same request.

\n
", + "smithy.api#httpHeader": "x-amzn-transcribe-language-options" + } + }, + "PreferredLanguage": { + "target": "com.amazonaws.transcribestreaming#CallAnalyticsLanguageCode", + "traits": { + "smithy.api#documentation": "

Specify a preferred language from the subset of languages codes you specified in \n LanguageOptions.

\n

You can only use this parameter if you've included IdentifyLanguage and\n LanguageOptions in your request.

", + "smithy.api#httpHeader": "x-amzn-transcribe-preferred-language" + } + }, + "VocabularyNames": { + "target": "com.amazonaws.transcribestreaming#VocabularyNames", + "traits": { + "smithy.api#documentation": "

Specify the names of the custom vocabularies that you want to use when processing your\n Call Analytics transcription. Note that vocabulary names are case sensitive.

\n

If the custom vocabulary's language doesn't match the identified media language, it won't be applied to the transcription.

\n \n

This parameter is only intended for use with the\n IdentifyLanguage parameter. If you're not\n including IdentifyLanguage in your request and want to use a custom vocabulary\n with your transcription, use the VocabularyName parameter instead.

\n
\n

For more information, see Custom vocabularies.

", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-names" + } + }, + "VocabularyFilterNames": { + "target": "com.amazonaws.transcribestreaming#VocabularyFilterNames", + "traits": { + "smithy.api#documentation": "

Specify the names of the custom vocabulary filters that you want to use when processing\n your Call Analytics transcription. Note that vocabulary filter names are case sensitive.

\n

These filters serve to customize the transcript output.

\n \n

This parameter is only intended for use with \n the IdentifyLanguage parameter. If you're not \n including IdentifyLanguage in your request and want to use a custom vocabulary filter \n with your transcription, use the VocabularyFilterName parameter instead.

\n
\n

For more information, see Using vocabulary filtering with unwanted \n words.

", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-names" + } + }, "EnablePartialResultsStabilization": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { @@ -2677,6 +2805,42 @@ "smithy.api#httpHeader": "x-amzn-transcribe-language-model-name" } }, + "IdentifyLanguage": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Shows whether automatic language identification was enabled for your Call Analytics transcription.

", + "smithy.api#httpHeader": "x-amzn-transcribe-identify-language" + } + }, + "LanguageOptions": { + "target": "com.amazonaws.transcribestreaming#LanguageOptions", + "traits": { + "smithy.api#documentation": "

Provides the language codes that you specified in your Call Analytics request.

", + "smithy.api#httpHeader": "x-amzn-transcribe-language-options" + } + }, + "PreferredLanguage": { + "target": "com.amazonaws.transcribestreaming#CallAnalyticsLanguageCode", + "traits": { + "smithy.api#documentation": "

Provides the preferred language that you specified in your Call Analytics request.

", + "smithy.api#httpHeader": "x-amzn-transcribe-preferred-language" + } + }, + "VocabularyNames": { + "target": "com.amazonaws.transcribestreaming#VocabularyNames", + "traits": { + "smithy.api#documentation": "

Provides the names of the custom vocabularies that you specified in your Call Analytics request.

", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-names" + } + }, + "VocabularyFilterNames": { + "target": "com.amazonaws.transcribestreaming#VocabularyFilterNames", + "traits": { + "smithy.api#documentation": "

Provides the names of the custom vocabulary filters that you specified in your Call Analytics request.

", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-names" + } + }, "EnablePartialResultsStabilization": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { @@ -2744,7 +2908,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a bidirectional HTTP/2 stream, where audio is streamed to\n Amazon Web Services HealthScribe\n and the transcription results are streamed to your application.

\n

When you start a stream, you first specify the stream configuration in a MedicalScribeConfigurationEvent. \n This event includes channel definitions, encryption settings, and post-stream analytics settings, such as the output configuration for aggregated transcript and clinical note generation. These are additional\n streaming session configurations beyond those provided in your initial start request headers. Whether you are starting a new session or resuming an existing session, \n your first event must be a MedicalScribeConfigurationEvent.

\n

\n After you send a MedicalScribeConfigurationEvent, you start AudioEvents and Amazon Web Services HealthScribe \n responds with real-time transcription results. When you are finished, to start processing the results with the post-stream analytics, send a MedicalScribeSessionControlEvent with a Type of \n END_OF_SESSION and Amazon Web Services HealthScribe starts the analytics.\n

\n

You can pause or resume streaming.\n To pause streaming, complete the input stream without sending the\n MedicalScribeSessionControlEvent.\n To resume streaming, call the StartMedicalScribeStream and specify the same SessionId you used to start the stream.\n

\n

The following parameters are required:

\n
    \n
  • \n

    \n language-code\n

    \n
  • \n
  • \n

    \n media-encoding\n

    \n
  • \n
  • \n

    \n media-sample-rate-hertz\n

    \n
  • \n
\n

\n

For more information on streaming with\n Amazon Web Services HealthScribe,\n see Amazon Web Services HealthScribe.\n

", + "smithy.api#documentation": "

Starts a bidirectional HTTP/2 stream, where audio is streamed to\n Amazon Web Services HealthScribe\n and the transcription results are streamed to your application.

\n

When you start a stream, you first specify the stream configuration in a MedicalScribeConfigurationEvent. \n This event includes channel definitions, encryption settings, medical scribe context, and post-stream analytics settings, such as the output configuration for aggregated transcript and clinical note generation. These are additional\n streaming session configurations beyond those provided in your initial start request headers. Whether you are starting a new session or resuming an existing session, \n your first event must be a MedicalScribeConfigurationEvent.

\n

\n After you send a MedicalScribeConfigurationEvent, you start AudioEvents and Amazon Web Services HealthScribe \n responds with real-time transcription results. When you are finished, to start processing the results with the post-stream analytics, send a MedicalScribeSessionControlEvent with a Type of \n END_OF_SESSION and Amazon Web Services HealthScribe starts the analytics.\n

\n

You can pause or resume streaming.\n To pause streaming, complete the input stream without sending the\n MedicalScribeSessionControlEvent.\n To resume streaming, call the StartMedicalScribeStream and specify the same SessionId you used to start the stream.\n

\n

The following parameters are required:

\n
    \n
  • \n

    \n language-code\n

    \n
  • \n
  • \n

    \n media-encoding\n

    \n
  • \n
  • \n

    \n media-sample-rate-hertz\n

    \n
  • \n
\n

\n

For more information on streaming with\n Amazon Web Services HealthScribe,\n see Amazon Web Services HealthScribe.\n

", "smithy.api#http": { "method": "POST", "uri": "/medical-scribe-stream", @@ -4193,17 +4357,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4217,28 +4370,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4252,17 +4383,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4501,6 +4621,18 @@ "traits": { "smithy.api#documentation": "

Provides the issue that was detected in the specified segment.

" } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribestreaming#CallAnalyticsLanguageCode", + "traits": { + "smithy.api#documentation": "

The language code that represents the language spoken in your audio stream.

" + } + }, + "LanguageIdentification": { + "target": "com.amazonaws.transcribestreaming#CallAnalyticsLanguageIdentification", + "traits": { + "smithy.api#documentation": "

The language code of the dominant language identified in your stream.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/transcribe.json b/codegen/sdk/aws-models/transcribe.json index deeec7a4f54..00265a5279e 100644 --- a/codegen/sdk/aws-models/transcribe.json +++ b/codegen/sdk/aws-models/transcribe.json @@ -4208,6 +4208,20 @@ } } }, + "com.amazonaws.transcribe#MedicalScribeContext": { + "type": "structure", + "members": { + "PatientContext": { + "target": "com.amazonaws.transcribe#MedicalScribePatientContext", + "traits": { + "smithy.api#documentation": "

Contains patient-specific information.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The MedicalScribeContext object that contains contextual information used to generate\n customized clinical notes.

" + } + }, "com.amazonaws.transcribe#MedicalScribeJob": { "type": "structure", "members": { @@ -4280,10 +4294,16 @@ "smithy.api#documentation": "

Makes it possible to specify which speaker is on which channel. For example, if the clinician\n is the first participant to speak, you would set ChannelId of the first ChannelDefinition \n in the list to 0 (to indicate the first channel) and ParticipantRole to\n CLINICIAN (to indicate that it's the clinician speaking).\n Then you would set the ChannelId of the second ChannelDefinition in the list to\n 1 (to indicate the second channel) and ParticipantRole to\n PATIENT (to indicate that it's the patient speaking).\n

" } }, + "MedicalScribeContextProvided": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the MedicalScribeContext object was provided when the Medical Scribe job was started.

" + } + }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to the Medical Scribe job.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" } } }, @@ -4473,6 +4493,20 @@ } } }, + "com.amazonaws.transcribe#MedicalScribePatientContext": { + "type": "structure", + "members": { + "Pronouns": { + "target": "com.amazonaws.transcribe#Pronouns", + "traits": { + "smithy.api#documentation": "

The patient's preferred pronouns that the user wants to provide as a context for clinical note generation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains patient-specific information used to customize the clinical note generation.

" + } + }, "com.amazonaws.transcribe#MedicalScribeSettings": { "type": "structure", "members": { @@ -5048,6 +5082,32 @@ } } }, + "com.amazonaws.transcribe#Pronouns": { + "type": "enum", + "members": { + "HE_HIM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HE_HIM" + } + }, + "SHE_HER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHE_HER" + } + }, + "THEY_THEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THEY_THEM" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.transcribe#RedactionOutput": { "type": "enum", "members": { @@ -5426,7 +5486,7 @@ } ], "traits": { - "smithy.api#documentation": "

Transcribes patient-clinician conversations and generates clinical notes.

\n

Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, \n classifies dialogues, extracts medical terms, and generates preliminary clinical notes.\n To learn more about these features, refer to Amazon Web Services HealthScribe.

\n

To make a StartMedicalScribeJob request, you must first upload\n your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location\n of the file using the Media parameter.

\n

You must include the following parameters in your\n StartMedicalTranscriptionJob request:

\n
    \n
  • \n

    \n DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified in Media,\n write permission on the Amazon S3 bucket specified in OutputBucketName, and full permissions on the KMS key specified in OutputEncryptionKMSKeyId (if set).\n The role should also allow transcribe.amazonaws.com to assume it.\n

    \n
  • \n
  • \n

    \n Media (MediaFileUri): The Amazon S3 location\n of your media file.

    \n
  • \n
  • \n

    \n MedicalScribeJobName: A custom name you create for your\n MedicalScribe job that is unique within your Amazon Web Services account.

    \n
  • \n
  • \n

    \n OutputBucketName: The Amazon S3 bucket where you want\n your output files stored.

    \n
  • \n
  • \n

    \n Settings: A MedicalScribeSettings obect \n that must set exactly one of ShowSpeakerLabels or ChannelIdentification to true.\n If ShowSpeakerLabels is true, MaxSpeakerLabels must also be set.\n

    \n
  • \n
  • \n

    \n ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only if the ChannelIdentification\n value of Settings is set to true. \n

    \n
  • \n
", + "smithy.api#documentation": "

Transcribes patient-clinician conversations and generates clinical notes.

\n

Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, \n classifies dialogues, extracts medical terms, and generates preliminary clinical notes.\n To learn more about these features, refer to Amazon Web Services HealthScribe.

\n

To make a StartMedicalScribeJob request, you must first upload\n your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location\n of the file using the Media parameter.

\n

You must include the following parameters in your\n StartMedicalTranscriptionJob request:

\n
    \n
  • \n

    \n DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified in Media,\n write permission on the Amazon S3 bucket specified in OutputBucketName, and full permissions on the KMS key specified in OutputEncryptionKMSKeyId (if set).\n The role should also allow transcribe.amazonaws.com to assume it.\n

    \n
  • \n
  • \n

    \n Media (MediaFileUri): The Amazon S3 location\n of your media file.

    \n
  • \n
  • \n

    \n MedicalScribeJobName: A custom name you create for your\n MedicalScribe job that is unique within your Amazon Web Services account.

    \n
  • \n
  • \n

    \n OutputBucketName: The Amazon S3 bucket where you want\n your output files stored.

    \n
  • \n
  • \n

    \n Settings: A MedicalScribeSettings object\n that must set exactly one of ShowSpeakerLabels or ChannelIdentification to true.\n If ShowSpeakerLabels is true, MaxSpeakerLabels must also be set.\n

    \n
  • \n
  • \n

    \n ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only if the ChannelIdentification\n value of Settings is set to true. \n

    \n
  • \n
", "smithy.api#http": { "method": "PUT", "uri": "/medicalscribejobs/{MedicalScribeJobName}", @@ -5493,7 +5553,13 @@ "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to the Medical Scribe job.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" + } + }, + "MedicalScribeContext": { + "target": "com.amazonaws.transcribe#MedicalScribeContext", + "traits": { + "smithy.api#documentation": "

The MedicalScribeContext object that contains contextual information which is used during\n clinical note generation to add relevant context to the note.

" } } }, @@ -7180,17 +7246,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -7204,28 +7259,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -7239,17 +7272,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/transfer.json b/codegen/sdk/aws-models/transfer.json index 3245b004f2c..42c052b9063 100644 --- a/codegen/sdk/aws-models/transfer.json +++ b/codegen/sdk/aws-models/transfer.json @@ -1163,7 +1163,7 @@ "S3StorageOptions": { "target": "com.amazonaws.transfer#S3StorageOptions", "traits": { - "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

" + "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized.

  • If using the console, this is enabled by default.

  • If using the API or CLI, this is disabled by default.

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

" } }, "IpAddressType": { @@ -2454,7 +2454,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the certificate that's identified by the CertificateId.

", + "smithy.api#documentation": "

Describes the certificate that's identified by the CertificateId.

Transfer Family automatically publishes a Amazon CloudWatch metric called DaysUntilExpiry for imported certificates. This metric tracks the number of days until the certificate expires based on the InactiveDate. The metric is available in the AWS/Transfer namespace and includes the CertificateId as a dimension.

", "smithy.api#readonly": {} } }, @@ -3878,7 +3878,7 @@ "target": "com.amazonaws.transfer#S3StorageOptions", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

" + "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized.

  • If using the console, this is enabled by default.

  • If using the API or CLI, this is disabled by default.

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

" } }, "As2ServiceManagedEgressIpAddresses": { @@ -4315,7 +4315,7 @@ "SecurityGroupIds": { "target": "com.amazonaws.transfer#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

A list of security groups IDs that are available to attach to your server's endpoint.

This property can only be set when EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

" + "smithy.api#documentation": "

A list of security groups IDs that are available to attach to your server's endpoint.

While SecurityGroupIds appears in the response syntax for consistency with CreateServer and UpdateServer operations, this field is not populated in DescribeServer responses. Security groups are managed at the VPC endpoint level and can be modified outside of the Transfer Family service. To retrieve current security group information, use the EC2 DescribeVpcEndpoints API with the VpcEndpointId returned in the response.

This property can only be set when EndpointType is set to VPC.

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

" } } }, @@ -4847,7 +4847,7 @@ "transfer:TagResource" ] }, - "smithy.api#documentation": "

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

You can import both the certificate and its chain in the Certificate parameter.

If you use the Certificate parameter to upload both the certificate and its chain, don't use the CertificateChain parameter.

" + "smithy.api#documentation": "

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

You can import both the certificate and its chain in the Certificate parameter.

After importing a certificate, Transfer Family automatically creates a Amazon CloudWatch metric called DaysUntilExpiry that tracks the number of days until the certificate expires. The metric is based on the InactiveDate parameter and is published daily in the AWS/Transfer namespace.

It can take up to a full day after importing a certificate for Transfer Family to emit the DaysUntilExpiry metric to your account.

If you use the Certificate parameter to upload both the certificate and its chain, don't use the CertificateChain parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

  • Units: Count (days)

  • Dimensions: CertificateId (always present), Description (if provided during certificate import)

  • Statistics: Minimum, Maximum, Average

  • Frequency: Published daily

" } }, "com.amazonaws.transfer#ImportCertificateRequest": { @@ -7538,7 +7538,7 @@ "DirectoryListingOptimization": { "target": "com.amazonaws.transfer#DirectoryListingOptimization", "traits": { - "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

" + "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized.

  • If using the console, this is enabled by default.

  • If using the API or CLI, this is disabled by default.

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

" } } }, @@ -7971,7 +7971,7 @@ "target": "com.amazonaws.transfer#MaxConcurrentConnections", "traits": { "smithy.api#default": 1, - "smithy.api#documentation": "

Specify the number of concurrent connections that your connector creates to the remote server. The default value is 5 (this is also the maximum value allowed).

This parameter specifies the number of active connections that your connector can establish with the remote server at the same time. Increasing this value can enhance connector performance when transferring large file batches by enabling parallel operations.

" + "smithy.api#documentation": "

Specify the number of concurrent connections that your connector creates to the remote server. The default value is 1. The maximum values is 5.

If you are using the Amazon Web Services Management Console, the default value is 5.

This parameter specifies the number of active connections that your connector can establish with the remote server at the same time. Increasing this value can enhance connector performance when transferring large file batches by enabling parallel operations.

" } } }, @@ -9949,17 +9949,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -9973,17 +9962,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -9997,17 +9975,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -10021,17 +9988,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -10920,7 +10876,7 @@ "S3StorageOptions": { "target": "com.amazonaws.transfer#S3StorageOptions", "traits": { - "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

" + "smithy.api#documentation": "

Specifies whether or not performance for your Amazon S3 directories is optimized.

  • If using the console, this is enabled by default.

  • If using the API or CLI, this is disabled by default.

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

" } }, "IpAddressType": { @@ -10928,6 +10884,12 @@ "traits": { "smithy.api#documentation": "

Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is IPV4.

The IpAddressType parameter has the following limitations:

  • It cannot be changed while the server is online. You must stop the server before modifying this parameter.

  • It cannot be updated to DUALSTACK if the server has AddressAllocationIds specified.

When using DUALSTACK as the IpAddressType, you cannot set the AddressAllocationIds parameter for the EndpointDetails for the server.

" } + }, + "IdentityProviderType": { + "target": "com.amazonaws.transfer#IdentityProviderType", + "traits": { + "smithy.api#documentation": "

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/translate.json b/codegen/sdk/aws-models/translate.json index e004c45e013..9d92a38d828 100644 --- a/codegen/sdk/aws-models/translate.json +++ b/codegen/sdk/aws-models/translate.json @@ -837,17 +837,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -861,28 +850,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -896,17 +863,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/trustedadvisor.json b/codegen/sdk/aws-models/trustedadvisor.json index 03d3ad81b54..af0afda632b 100644 --- a/codegen/sdk/aws-models/trustedadvisor.json +++ b/codegen/sdk/aws-models/trustedadvisor.json @@ -3625,17 +3625,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3649,17 +3638,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -3673,17 +3651,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -3697,17 +3664,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/verifiedpermissions.json b/codegen/sdk/aws-models/verifiedpermissions.json index 6b26bb088e1..92931a58a91 100644 --- a/codegen/sdk/aws-models/verifiedpermissions.json +++ b/codegen/sdk/aws-models/verifiedpermissions.json @@ -127,6 +127,18 @@ "traits": { "smithy.api#documentation": "

An attribute value of decimal type.

Example: {\"decimal\": \"1.1\"}

" } + }, + "datetime": { + "target": "com.amazonaws.verifiedpermissions#DatetimeAttribute", + "traits": { + "smithy.api#documentation": "

An attribute value of datetime type.

Example: {\"datetime\": \"2024-10-15T11:35:00Z\"}

" + } + }, + "duration": { + "target": "com.amazonaws.verifiedpermissions#Duration", + "traits": { + "smithy.api#documentation": "

An attribute value of duration type.

Example: {\"duration\": \"1h30m\"}

" + } } }, "traits": { @@ -164,7 +176,14 @@ }, "traits": { "aws.iam#iamAction": { - "name": "GetPolicy" + "name": "GetPolicy", + "documentation": "Grants permission to retrieve information about the specified policy", + "relativeDocumentation": "API_GetPolicy.html", + "resources": { + "required": { + "policy-store": {} + } + } }, "smithy.api#documentation": "

Retrieves information about a group (batch) of policies.

The BatchGetPolicy operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission verifiedpermissions:GetPolicy in their IAM policies.

", "smithy.api#examples": [ @@ -445,8 +464,14 @@ ], "traits": { "aws.iam#iamAction": { - "documentation": "Grants permission to make a batch authorization decision about a service request described in the parameters", - "name": "IsAuthorized" + "documentation": "Grants permission to make authorization decisions about the service requests described in the parameters", + "name": "IsAuthorized", + "relativeDocumentation": "API_IsAuthorized.html", + "resources": { + "required": { + "policy-store": {} + } + } }, "smithy.api#documentation": "

Makes a series of decisions about multiple authorization requests for one principal or resource. Each request contains the equivalent content of an IsAuthorized request: principal, action, resource, and context. Either the principal or the resource parameter must be identical across all requests. For example, Verified Permissions won't evaluate a pair of requests where bob views photo1 and alice views photo2. Authorization of bob to view photo1 and photo2, or bob and alice to view photo1, are valid batches.

The request is evaluated against all policies in the specified policy store that match the entities that you declare. The result of the decisions is a series of Allow or Deny responses, along with the IDs of the policies that produced each decision.

The entities of a BatchIsAuthorized API request can contain up to 100 principals and up to 100 resources. The requests of a BatchIsAuthorized API request can contain up to 30 requests.

The BatchIsAuthorized operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission verifiedpermissions:IsAuthorized in their IAM policies.

", "smithy.api#examples": [ @@ -752,8 +777,14 @@ ], "traits": { "aws.iam#iamAction": { - "documentation": "Grants permission to make a batch authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source", - "name": "IsAuthorizedWithToken" + "documentation": "Grants permission to make authorization decisions about the service requests described in the parameters. The principal in this request comes from an external identity source", + "name": "IsAuthorizedWithToken", + "relativeDocumentation": "API_IsAuthorizedWithToken.html", + "resources": { + "required": { + "policy-store": {} + } + } }, "smithy.api#documentation": "

Makes a series of decisions about multiple authorization requests for one token. The principal in this request comes from an external identity source in the form of an identity or access token, formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluations.

The request is evaluated against all policies in the specified policy store that match the entities that you provide in the entities declaration and in the token. The result of the decisions is a series of Allow or Deny responses, along with the IDs of the policies that produced each decision.

The entities of a BatchIsAuthorizedWithToken API request can contain up to 100 resources and up to 99 user groups. The requests of a BatchIsAuthorizedWithToken API request can contain up to 30 requests.

The BatchIsAuthorizedWithToken operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission verifiedpermissions:IsAuthorizedWithToken in their IAM policies.

", "smithy.api#examples": [ @@ -1918,6 +1949,17 @@ "smithy.api#output": {} } }, + "com.amazonaws.verifiedpermissions#DatetimeAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 28 + }, + "smithy.api#pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?(Z|[+-]\\d{4}))?$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.verifiedpermissions#Decimal": { "type": "string", "traits": { @@ -2242,6 +2284,17 @@ "smithy.api#pattern": "^https://.*$" } }, + "com.amazonaws.verifiedpermissions#Duration": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 100 + }, + "smithy.api#pattern": "^-?(\\d+d)?(\\d+h)?(\\d+m)?(\\d+s)?(\\d+ms)?$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.verifiedpermissions#EntitiesDefinition": { "type": "union", "members": { @@ -2547,7 +2600,14 @@ ], "traits": { "aws.iam#iamAction": { - "documentation": "Grants permission to retrieve information about the specified policy" + "name": "GetPolicy", + "documentation": "Grants permission to retrieve information about the specified policy", + "relativeDocumentation": "API_GetPolicy.html", + "resources": { + "required": { + "policy-store": {} + } + } }, "smithy.api#documentation": "

Retrieves information about the specified policy.

", "smithy.api#examples": [ @@ -3323,7 +3383,7 @@ ], "traits": { "aws.iam#iamAction": { - "documentation": "Grants permission to make an authorization decision about a service request described in the parameters" + "documentation": "Grants permission to make authorization decisions about the service requests described in the parameters" }, "smithy.api#documentation": "

Makes an authorization decision about a service request described in the parameters. The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow or Deny, along with a list of the policies that resulted in the decision.

", "smithy.api#examples": [ @@ -3472,7 +3532,7 @@ ], "traits": { "aws.iam#iamAction": { - "documentation": "Grants permission to make an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source" + "documentation": "Grants permission to make authorization decisions about the service requests described in the parameters. The principal in this request comes from an external identity source" }, "smithy.api#documentation": "

Makes an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source in the form of an identity token formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow or Deny, along with a list of the policies that resulted in the decision.

Verified Permissions validates each token that is specified in a request by checking its expiration date and its signature.

Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store

", "smithy.api#examples": [ @@ -5700,7 +5760,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about a policy created by instantiating a policy template.

This

" + "smithy.api#documentation": "

Contains information about a policy created by instantiating a policy template.

" } }, "com.amazonaws.verifiedpermissions#ThrottlingException": { @@ -7226,17 +7286,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -7250,17 +7299,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -7274,17 +7312,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -7298,17 +7325,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/voice-id.json b/codegen/sdk/aws-models/voice-id.json index 0d24326a563..5d764abf80c 100644 --- a/codegen/sdk/aws-models/voice-id.json +++ b/codegen/sdk/aws-models/voice-id.json @@ -4436,17 +4436,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4460,17 +4449,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -4484,17 +4462,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -4508,17 +4475,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/vpc-lattice.json b/codegen/sdk/aws-models/vpc-lattice.json index c5bd898cb70..5fe97514639 100644 --- a/codegen/sdk/aws-models/vpc-lattice.json +++ b/codegen/sdk/aws-models/vpc-lattice.json @@ -201,7 +201,7 @@ "type": "string", "traits": { "smithy.api#length": { - "max": 10000 + "max": 36864 } } }, @@ -249,7 +249,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the listener rules in a batch. You can use this operation to change the priority of\n listener rules. This can be useful when bulk updating or swapping rule priority.

\n

\n Required permissions:\n vpc-lattice:UpdateRule\n

\n

For more information, see How Amazon VPC Lattice works with\n IAM in the Amazon VPC Lattice User Guide.

", + "smithy.api#documentation": "

Updates the listener rules in a batch. You can use this operation to change the priority of listener rules. This can be useful when bulk updating or swapping rule priority.

Required permissions: vpc-lattice:UpdateRule

For more information, see How Amazon VPC Lattice works with IAM in the Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 200, "method": "PATCH", @@ -350,7 +350,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request conflicts with the current state of the resource. Updating or deleting a\n resource can cause an inconsistent state.

", + "smithy.api#documentation": "

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -384,7 +384,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner\n can use the access logs to audit the services in the network. The service network owner can only\n see access logs from clients and services that are associated with their service network. Access\n log entries represent traffic originated from VPCs associated with that network. For more\n information, see Access logs in the\n Amazon VPC Lattice User Guide.

", + "smithy.api#documentation": "

Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner can only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network. For more information, see Access logs in the Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -399,7 +399,7 @@ "clientToken": { "target": "com.amazonaws.vpclattice#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\n the idempotency of the request. If you retry a request that completed successfully using\n the same client token and parameters, the retry succeeds without performing any actions.\n If the parameters aren't identical, the retry fails.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

", "smithy.api#idempotencyToken": {} } }, @@ -413,7 +413,7 @@ "destinationArn": { "target": "com.amazonaws.vpclattice#AccessLogDestinationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination. The supported destination types are\n CloudWatch Log groups, Kinesis Data Firehose delivery streams, and Amazon S3 buckets.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination. The supported destination types are CloudWatch Log groups, Kinesis Data Firehose delivery streams, and Amazon S3 buckets.

", "smithy.api#required": {} } }, @@ -509,7 +509,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must\n add one or more listeners. A listener is a process that checks for connection requests to your\n services. For more information, see Listeners in the\n Amazon VPC Lattice User Guide.

", + "smithy.api#documentation": "

Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -532,7 +532,7 @@ "name": { "target": "com.amazonaws.vpclattice#ListenerName", "traits": { - "smithy.api#documentation": "

The name of the listener. A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can't use a \n hyphen as the first or last character, or immediately after another hyphen.

", + "smithy.api#documentation": "

The name of the listener. A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

", "smithy.api#required": {} } }, @@ -546,20 +546,20 @@ "port": { "target": "com.amazonaws.vpclattice#Port", "traits": { - "smithy.api#documentation": "

The listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For\n HTTPS, the default is 443.

" + "smithy.api#documentation": "

The listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443.

" } }, "defaultAction": { "target": "com.amazonaws.vpclattice#RuleAction", "traits": { - "smithy.api#documentation": "

The action for the default rule. Each listener has a default rule. The default rule is used\n if no other rules match.

", + "smithy.api#documentation": "

The action for the default rule. Each listener has a default rule. The default rule is used if no other rules match.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.vpclattice#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\n the idempotency of the request. If you retry a request that completed successfully using\n the same client token and parameters, the retry succeeds without performing any actions.\n If the parameters aren't identical, the retry fails.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

", "smithy.api#idempotencyToken": {} } }, @@ -656,7 +656,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a resource configuration. A resource configuration defines a specific resource. You\n can associate a resource configuration with a service network or a VPC endpoint.

", + "smithy.api#documentation": "

Creates a resource configuration. A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a VPC endpoint.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -671,21 +671,21 @@ "name": { "target": "com.amazonaws.vpclattice#ResourceConfigurationName", "traits": { - "smithy.api#documentation": "

The name of the resource configuration. The name must be unique within the account. The\n valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last\n character, or immediately after another hyphen.

", + "smithy.api#documentation": "

The name of the resource configuration. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.vpclattice#ResourceConfigurationType", "traits": { - "smithy.api#documentation": "

The type of resource configuration.

\n
    \n
  • \n

    \n SINGLE - A single resource.

    \n
  • \n
  • \n

    \n GROUP - A group of resources. You must create a group resource\n configuration before you create a child resource configuration.

    \n
  • \n
  • \n

    \n CHILD - A single resource that is part of a group resource configuration.

    \n
  • \n
  • \n

    \n ARN - An Amazon Web Services resource.

    \n
  • \n
", + "smithy.api#documentation": "

The type of resource configuration. A resource configuration can be one of the following types:

  • SINGLE - A single resource.

  • GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.

  • CHILD - A single resource that is part of a group resource configuration.

  • ARN - An Amazon Web Services resource.

", "smithy.api#required": {} } }, "portRanges": { "target": "com.amazonaws.vpclattice#PortRangeList", "traits": { - "smithy.api#documentation": "

(SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration \n (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30).

" + "smithy.api#documentation": "

(SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30).

" } }, "protocol": { @@ -697,31 +697,31 @@ "resourceGatewayIdentifier": { "target": "com.amazonaws.vpclattice#ResourceGatewayIdentifier", "traits": { - "smithy.api#documentation": "

(SINGLE, GROUP, ARN) The ID or ARN of the resource gateway used to connect to the resource configuration.\n For a child resource configuration, this value is inherited from the parent resource configuration.

" + "smithy.api#documentation": "

(SINGLE, GROUP, ARN) The ID or ARN of the resource gateway used to connect to the resource configuration. For a child resource configuration, this value is inherited from the parent resource configuration.

" } }, "resourceConfigurationGroupIdentifier": { "target": "com.amazonaws.vpclattice#ResourceConfigurationIdentifier", "traits": { - "smithy.api#documentation": "

(CHILD) The ID or ARN of the parent resource configuration (type is GROUP). \n This is used to associate a child resource configuration with a group resource configuration.

" + "smithy.api#documentation": "

(CHILD) The ID or ARN of the parent resource configuration of type GROUP. This is used to associate a child resource configuration with a group resource configuration.

" } }, "resourceConfigurationDefinition": { "target": "com.amazonaws.vpclattice#ResourceConfigurationDefinition", "traits": { - "smithy.api#documentation": "

(SINGLE, CHILD, ARN) The resource configuration.

" + "smithy.api#documentation": "

Identifies the resource configuration in one of the following ways:

  • Amazon Resource Name (ARN) - Supported resource-types that are provisioned by Amazon Web Services services, such as RDS databases, can be identified by their ARN.

  • Domain name - Any domain name that is publicly resolvable.

  • IP address - For IPv4 and IPv6, only IP addresses in the VPC are supported.

" } }, "allowAssociationToShareableServiceNetwork": { "target": "com.amazonaws.vpclattice#Boolean", "traits": { - "smithy.api#documentation": "

(SINGLE, GROUP, ARN) Specifies whether the resource configuration can be associated with \n a sharable service network. The default is false.

" + "smithy.api#documentation": "

(SINGLE, GROUP, ARN) Specifies whether the resource configuration can be associated with a sharable service network. The default is false.

" } }, "clientToken": { "target": "com.amazonaws.vpclattice#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\n the idempotency of the request. If you retry a request that completed successfully using\n the same client token and parameters, the retry succeeds without performing any actions.\n If the parameters aren't identical, the retry fails.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

", "smithy.api#idempotencyToken": {} } }, @@ -766,13 +766,13 @@ "resourceConfigurationGroupId": { "target": "com.amazonaws.vpclattice#ResourceConfigurationId", "traits": { - "smithy.api#documentation": "

The ID of the parent resource configuration (type is GROUP).

" + "smithy.api#documentation": "

The ID of the parent resource configuration of type GROUP.

" } }, "type": { "target": "com.amazonaws.vpclattice#ResourceConfigurationType", "traits": { - "smithy.api#documentation": "

The type of resource configuration.

" + "smithy.api#documentation": "

The type of resource configuration. A resource configuration can be one of the following types:

  • SINGLE - A single resource.

  • GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.

  • CHILD - A single resource that is part of a group resource configuration.

  • ARN - An Amazon Web Services resource.

" } }, "portRanges": { @@ -796,13 +796,13 @@ "resourceConfigurationDefinition": { "target": "com.amazonaws.vpclattice#ResourceConfigurationDefinition", "traits": { - "smithy.api#documentation": "

The resource configuration.

" + "smithy.api#documentation": "

Identifies the resource configuration in one of the following ways:

  • Amazon Resource Name (ARN) - Supported resource-types that are provisioned by Amazon Web Services services, such as RDS databases, can be identified by their ARN.

  • Domain name - Any domain name that is publicly resolvable.

  • IP address - For IPv4 and IPv6, only IP addresses in the VPC are supported.

" } }, "allowAssociationToShareableServiceNetwork": { "target": "com.amazonaws.vpclattice#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the resource configuration can be associated with a sharable service\n network.

" + "smithy.api#documentation": "

Specifies whether the resource configuration can be associated with a sharable service network.

" } }, "createdAt": { @@ -854,7 +854,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a resource gateway.

", + "smithy.api#documentation": "

A resource gateway is a point of ingress into the VPC where a resource resides. It spans multiple Availability Zones. For your resource to be accessible from all Availability Zones, you should create your resource gateways to span as many Availability Zones as possible. A VPC can have multiple resource gateways.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -869,7 +869,7 @@ "clientToken": { "target": "com.amazonaws.vpclattice#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\n the idempotency of the request. If you retry a request that completed successfully using\n the same client token and parameters, the retry succeeds without performing any actions.\n If the parameters aren't identical, the retry fails.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

", "smithy.api#idempotencyToken": {} } }, @@ -883,21 +883,19 @@ "vpcIdentifier": { "target": "com.amazonaws.vpclattice#VpcId", "traits": { - "smithy.api#documentation": "

The ID of the VPC for the resource gateway.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the VPC for the resource gateway.

" } }, "subnetIds": { "target": "com.amazonaws.vpclattice#SubnetList", "traits": { - "smithy.api#documentation": "

The IDs of the VPC subnets in which to create the resource gateway.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The IDs of the VPC subnets in which to create the resource gateway.

" } }, "securityGroupIds": { "target": "com.amazonaws.vpclattice#SecurityGroupList", "traits": { - "smithy.api#documentation": "

The IDs of the security groups to apply to the resource gateway. The security groups must be\n in the same VPC.

", + "smithy.api#documentation": "

The IDs of the security groups to apply to the resource gateway. The security groups must be in the same VPC.

", "smithy.api#length": { "min": 0, "max": 5 @@ -907,7 +905,13 @@ "ipAddressType": { "target": "com.amazonaws.vpclattice#ResourceGatewayIpAddressType", "traits": { - "smithy.api#documentation": "

The type of IP address used by the resource gateway.

" + "smithy.api#documentation": "

A resource gateway can have IPv4, IPv6 or dualstack addresses. The IP address type of a resource gateway must be compatible with the subnets of the resource gateway and the IP address type of the resource, as described here:

  • IPv4Assign IPv4 addresses to your resource gateway network interfaces. This option is supported only if all selected subnets have IPv4 address ranges, and the resource also has an IPv4 address.

  • IPv6Assign IPv6 addresses to your resource gateway network interfaces. This option is supported only if all selected subnets are IPv6 only subnets, and the resource also has an IPv6 address.

  • DualstackAssign both IPv4 and IPv6 addresses to your resource gateway network interfaces. This option is supported only if all selected subnets have both IPv4 and IPv6 address ranges, and the resource either has an IPv4 or IPv6 address.

The IP address type of the resource gateway is independent of the IP address type of the client or the VPC endpoint through which the resource is accessed.

" + } + }, + "ipv4AddressesPerEni": { + "target": "com.amazonaws.vpclattice#Ipv4AddressesPerEni", + "traits": { + "smithy.api#documentation": "

The number of IPv4 addresses in each ENI for the resource gateway.

" } }, "tags": { @@ -971,6 +975,12 @@ "traits": { "smithy.api#documentation": "

The type of IP address for the resource gateway.

" } + }, + "ipv4AddressesPerEni": { + "target": "com.amazonaws.vpclattice#Ipv4AddressesPerEni", + "traits": { + "smithy.api#documentation": "

The number of IPv4 addresses in each ENI for the resource gateway.

" + } } }, "traits": { @@ -1009,7 +1019,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a listener rule. Each listener has a default rule for checking connection requests,\n but you can define additional rules. Each rule consists of a priority, one or more actions, and\n one or more conditions. For more information, see Listener rules in the\n Amazon VPC Lattice User Guide.

", + "smithy.api#documentation": "

Creates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -1040,7 +1050,7 @@ "name": { "target": "com.amazonaws.vpclattice#RuleName", "traits": { - "smithy.api#documentation": "

The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a \n hyphen as the first or last character, or immediately after another hyphen.

", + "smithy.api#documentation": "

The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

", "smithy.api#required": {} } }, @@ -1054,7 +1064,7 @@ "priority": { "target": "com.amazonaws.vpclattice#RulePriority", "traits": { - "smithy.api#documentation": "

The priority assigned to the rule. Each rule for a specific listener must have a unique\n priority. The lower the priority number the higher the priority.

", + "smithy.api#documentation": "

The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.

", "smithy.api#required": {} } }, @@ -1068,7 +1078,7 @@ "clientToken": { "target": "com.amazonaws.vpclattice#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\n the idempotency of the request. If you retry a request that completed successfully using\n the same client token and parameters, the retry succeeds without performing any actions.\n If the parameters aren't identical, the retry fails.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

", "smithy.api#idempotencyToken": {} } }, @@ -1104,13 +1114,13 @@ "match": { "target": "com.amazonaws.vpclattice#RuleMatch", "traits": { - "smithy.api#documentation": "

The rule match. The RuleMatch must be an HttpMatch. This means\n that the rule should be an exact match on HTTP constraints which are made up of the HTTP method,\n path, and header.

" + "smithy.api#documentation": "

The rule match. The RuleMatch must be an HttpMatch. This means that the rule should be an exact match on HTTP constraints which are made up of the HTTP method, path, and header.

" } }, "priority": { "target": "com.amazonaws.vpclattice#RulePriority", "traits": { - "smithy.api#documentation": "

The priority assigned to the rule. The lower the priority number the higher the\n priority.

" + "smithy.api#documentation": "

The priority assigned to the rule. The lower the priority number the higher the priority.

" } }, "action": { @@ -1153,7 +1163,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a service. A service is any software application that can run on instances\n containers, or serverless functions within an account or virtual private cloud (VPC).

\n

For more information, see Services in the\n Amazon VPC Lattice User Guide.

", + "smithy.api#documentation": "

Creates a service. A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).

For more information, see Services in the Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -1194,7 +1204,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a service network. A service network is a logical boundary for a collection of\n services. You can associate services and VPCs with a service network.

\n

For more information, see Service networks in the\n Amazon VPC Lattice User Guide.

", + "smithy.api#documentation": "

Creates a service network. A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.

For more information, see Service networks in the Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 201, "method": "POST", @@ -1209,21 +1219,21 @@ "clientToken": { "target": "com.amazonaws.vpclattice#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\n the idempotency of the request. If you retry a request that completed successfully using\n the same client token and parameters, the retry succeeds without performing any actions.\n If the parameters aren't identical, the retry fails.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

", "smithy.api#idempotencyToken": {} } }, "name": { "target": "com.amazonaws.vpclattice#ServiceNetworkName", "traits": { - "smithy.api#documentation": "

The name of the service network. The name must be unique to the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a \n hyphen as the first or last character, or immediately after another hyphen.

", + "smithy.api#documentation": "

The name of the service network. The name must be unique to the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

", "smithy.api#required": {} } }, "authType": { "target": "com.amazonaws.vpclattice#AuthType", "traits": { - "smithy.api#documentation": "

The type of IAM policy.

\n
    \n
  • \n

    \n NONE: The resource does not use an IAM policy. This is the default.

    \n
  • \n
  • \n

    \n AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

    \n
  • \n
" + "smithy.api#documentation": "

The type of IAM policy.

  • NONE: The resource does not use an IAM policy. This is the default.

  • AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

" } }, "tags": { @@ -1272,7 +1282,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates the specified service network with the specified resource configuration.\n This allows the resource configuration to receive connections through the service network,\n including through a service network VPC endpoint.

", + "smithy.api#documentation": "

Associates the specified service network with the specified resource configuration. This allows the resource configuration to receive connections through the service network, including through a service network VPC endpoint.

", "smithy.api#http": { "code": 201, "uri": "/servicenetworkresourceassociations", @@ -1287,7 +1297,7 @@ "clientToken": { "target": "com.amazonaws.vpclattice#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\n the idempotency of the request. If you retry a request that completed successfully using\n the same client token and parameters, the retry succeeds without performing any actions.\n If the parameters aren't identical, the retry fails.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

", "smithy.api#idempotencyToken": {} } }, @@ -1308,7 +1318,7 @@ "tags": { "target": "com.amazonaws.vpclattice#TagMap", "traits": { - "smithy.api#documentation": "

The tags for the association.

" + "smithy.api#documentation": "

A key-value pair to associate with a resource.

" } } }, @@ -1415,7 +1425,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates the specified service with the specified service network. For more information, see \n Manage service associations in the Amazon VPC Lattice User Guide.

\n

You can't use this operation if the service and service network are already associated or if\n there is a disassociation or deletion in progress. If the association fails, you can retry the\n operation by deleting the association and recreating it.

\n

You cannot associate a service and service network that are shared with a caller. The caller\n must own either the service or the service network.

\n

As a result of this operation, the association is created in the service network account and\n the association owner account.

", + "smithy.api#documentation": "

Associates the specified service with the specified service network. For more information, see Manage service associations in the Amazon VPC Lattice User Guide.

You can't use this operation if the service and service network are already associated or if there is a disassociation or deletion in progress. If the association fails, you can retry the operation by deleting the association and recreating it.

You cannot associate a service and service network that are shared with a caller. The caller must own either the service or the service network.

As a result of this operation, the association is created in the service network account and the association owner account.

", "smithy.api#http": { "code": 200, "uri": "/servicenetworkserviceassociations", @@ -1430,7 +1440,7 @@ "clientToken": { "target": "com.amazonaws.vpclattice#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\n the idempotency of the request. If you retry a request that completed successfully using\n the same client token and parameters, the retry succeeds without performing any actions.\n If the parameters aren't identical, the retry fails.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

", "smithy.api#idempotencyToken": {} } }, @@ -1529,7 +1539,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a VPC with a service network. When you associate a VPC with the service network,\n it enables all the resources within that VPC to be clients and communicate with other services in\n the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide.

\n

You can't use this operation if there is a disassociation in progress. If the association\n fails, retry by deleting the association and recreating it.

\n

As a result of this operation, the association gets created in the service network account\n and the VPC owner account.

\n

If you add a security group to the service network and VPC association, the association must\n continue to always have at least one security group. You can add or edit security groups at any\n time. However, to remove all security groups, you must first delete the association and recreate\n it without security groups.

", + "smithy.api#documentation": "

Associates a VPC with a service network. When you associate a VPC with the service network, it enables all the resources within that VPC to be clients and communicate with other services in the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide.

You can't use this operation if there is a disassociation in progress. If the association fails, retry by deleting the association and recreating it.

As a result of this operation, the association gets created in the service network account and the VPC owner account.

If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.

", "smithy.api#http": { "code": 200, "uri": "/servicenetworkvpcassociations", @@ -1544,7 +1554,7 @@ "clientToken": { "target": "com.amazonaws.vpclattice#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\n the idempotency of the request. If you retry a request that completed successfully using\n the same client token and parameters, the retry succeeds without performing any actions.\n If the parameters aren't identical, the retry fails.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

", "smithy.api#idempotencyToken": {} } }, @@ -1565,7 +1575,7 @@ "securityGroupIds": { "target": "com.amazonaws.vpclattice#SecurityGroupList", "traits": { - "smithy.api#documentation": "

The IDs of the security groups. Security groups aren't added by default. You can add a\n security group to apply network level controls to control which resources in a VPC are allowed to\n access the service network and its services. For more information, see Control traffic to\n resources using security groups in the Amazon VPC User\n Guide.

", + "smithy.api#documentation": "

The IDs of the security groups. Security groups aren't added by default. You can add a security group to apply network level controls to control which resources in a VPC are allowed to access the service network and its services. For more information, see Control traffic to resources using security groups in the Amazon VPC User Guide.

", "smithy.api#length": { "min": 0, "max": 5 @@ -1621,14 +1631,14 @@ "clientToken": { "target": "com.amazonaws.vpclattice#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\n the idempotency of the request. If you retry a request that completed successfully using\n the same client token and parameters, the retry succeeds without performing any actions.\n If the parameters aren't identical, the retry fails.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

", "smithy.api#idempotencyToken": {} } }, "name": { "target": "com.amazonaws.vpclattice#ServiceName", "traits": { - "smithy.api#documentation": "

The name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a \n hyphen as the first or last character, or immediately after another hyphen.

", + "smithy.api#documentation": "

The name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

", "smithy.api#required": {} } }, @@ -1653,7 +1663,7 @@ "authType": { "target": "com.amazonaws.vpclattice#AuthType", "traits": { - "smithy.api#documentation": "

The type of IAM policy.

\n
    \n
  • \n

    \n NONE: The resource does not use an IAM policy. This is the default.

    \n
  • \n
  • \n

    \n AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

    \n
  • \n
" + "smithy.api#documentation": "

The type of IAM policy.

  • NONE: The resource does not use an IAM policy. This is the default.

  • AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

" } } } @@ -1694,7 +1704,7 @@ "status": { "target": "com.amazonaws.vpclattice#ServiceStatus", "traits": { - "smithy.api#documentation": "

The status. If the status is CREATE_FAILED, you must delete and recreate the\n service.

" + "smithy.api#documentation": "

The status. If the status is CREATE_FAILED, you must delete and recreate the service.

" } }, "authType": { @@ -1743,7 +1753,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a target group. A target group is a collection of targets, or compute resources,\n that run your application or service. A target group can only be used by a single service.

\n

For more information, see Target groups in the\n Amazon VPC Lattice User Guide.

", + "smithy.api#documentation": "

Creates a target group. A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.

For more information, see Target groups in the Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 201, "uri": "/targetgroups", @@ -1758,7 +1768,7 @@ "name": { "target": "com.amazonaws.vpclattice#TargetGroupName", "traits": { - "smithy.api#documentation": "

The name of the target group. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a \n hyphen as the first or last character, or immediately after another hyphen.

", + "smithy.api#documentation": "

The name of the target group. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

", "smithy.api#required": {} } }, @@ -1778,7 +1788,7 @@ "clientToken": { "target": "com.amazonaws.vpclattice#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure\n the idempotency of the request. If you retry a request that completed successfully using\n the same client token and parameters, the retry succeeds without performing any actions.\n If the parameters aren't identical, the retry fails.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

", "smithy.api#idempotencyToken": {} } }, @@ -1826,7 +1836,7 @@ "status": { "target": "com.amazonaws.vpclattice#TargetGroupStatus", "traits": { - "smithy.api#documentation": "

The status. You can retry the operation if the status is CREATE_FAILED.\n However, if you retry it while the status is CREATE_IN_PROGRESS, there is no change\n in the status.

" + "smithy.api#documentation": "

The status. You can retry the operation if the status is CREATE_FAILED. However, if you retry it while the status is CREATE_IN_PROGRESS, there is no change in the status.

" } } } @@ -1909,7 +1919,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified auth policy. If an auth is set to AWS_IAM and the auth\n policy is deleted, all requests are denied. If you are trying to remove the auth policy\n completely, you must set the auth type to NONE. If auth is enabled on the resource,\n but no auth policy is set, all requests are denied.

", + "smithy.api#documentation": "

Deletes the specified auth policy. If an auth is set to AWS_IAM and the auth policy is deleted, all requests are denied. If you are trying to remove the auth policy completely, you must set the auth type to NONE. If auth is enabled on the resource, but no auth policy is set, all requests are denied.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -2134,7 +2144,7 @@ "resourceConfigurationArn": { "target": "com.amazonaws.vpclattice#ResourceConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource configuration associated with the VPC\n endpoint of type resource.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource configuration associated with the VPC endpoint of type resource.

" } }, "vpcEndpointId": { @@ -2315,7 +2325,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a listener rule. Each listener has a default rule for checking connection requests,\n but you can define additional rules. Each rule consists of a priority, one or more actions, and\n one or more conditions. You can delete additional listener rules, but you cannot delete the\n default rule.

\n

For more information, see Listener rules in the\n Amazon VPC Lattice User Guide.

", + "smithy.api#documentation": "

Deletes a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. You can delete additional listener rules, but you cannot delete the default rule.

For more information, see Listener rules in the Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -2386,7 +2396,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a service. A service can't be deleted if it's associated with a service network. If\n you delete a service, all resources related to the service, such as the resource policy, auth\n policy, listeners, listener rules, and access log subscriptions, are also deleted. For more\n information, see Delete a service in the\n Amazon VPC Lattice User Guide.

", + "smithy.api#documentation": "

Deletes a service. A service can't be deleted if it's associated with a service network. If you delete a service, all resources related to the service, such as the resource policy, auth policy, listeners, listener rules, and access log subscriptions, are also deleted. For more information, see Delete a service in the Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 200, "uri": "/services/{serviceIdentifier}", @@ -2424,7 +2434,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a service network. You can only delete the service network if there is no service or\n VPC associated with it. If you delete a service network, all resources related to the service\n network, such as the resource policy, auth policy, and access log subscriptions, are also\n deleted. For more information, see Delete a service\n network in the Amazon VPC Lattice User Guide.

", + "smithy.api#documentation": "

Deletes a service network. You can only delete the service network if there is no service or VPC associated with it. If you delete a service network, all resources related to the service network, such as the resource policy, auth policy, and access log subscriptions, are also deleted. For more information, see Delete a service network in the Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 204, "uri": "/servicenetworks/{serviceNetworkIdentifier}", @@ -2559,7 +2569,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the association between a service and a service network. This\n operation fails if an association is still in progress.

", + "smithy.api#documentation": "

Deletes the association between a service and a service network. This operation fails if an association is still in progress.

", "smithy.api#http": { "code": 200, "uri": "/servicenetworkserviceassociations/{serviceNetworkServiceAssociationIdentifier}", @@ -2593,7 +2603,7 @@ "status": { "target": "com.amazonaws.vpclattice#ServiceNetworkServiceAssociationStatus", "traits": { - "smithy.api#documentation": "

The status. You can retry the operation if the status is DELETE_FAILED.\n However, if you retry it when the status is DELETE_IN_PROGRESS, there is no change\n in the status.

" + "smithy.api#documentation": "

The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it when the status is DELETE_IN_PROGRESS, there is no change in the status.

" } }, "arn": { @@ -2633,7 +2643,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates the VPC from the service network. You can't disassociate the VPC if there is a\n create or update association in progress.

", + "smithy.api#documentation": "

Disassociates the VPC from the service network. You can't disassociate the VPC if there is a create or update association in progress.

", "smithy.api#http": { "code": 200, "uri": "/servicenetworkvpcassociations/{serviceNetworkVpcAssociationIdentifier}", @@ -2667,7 +2677,7 @@ "status": { "target": "com.amazonaws.vpclattice#ServiceNetworkVpcAssociationStatus", "traits": { - "smithy.api#documentation": "

The status. You can retry the operation if the status is DELETE_FAILED.\n However, if you retry it while the status is DELETE_IN_PROGRESS, there is no change\n in the status.

" + "smithy.api#documentation": "

The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it while the status is DELETE_IN_PROGRESS, there is no change in the status.

" } }, "arn": { @@ -2715,7 +2725,7 @@ "status": { "target": "com.amazonaws.vpclattice#ServiceStatus", "traits": { - "smithy.api#documentation": "

The status. You can retry the operation if the status is DELETE_FAILED.\n However, if you retry it while the status is DELETE_IN_PROGRESS, the status doesn't\n change.

" + "smithy.api#documentation": "

The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it while the status is DELETE_IN_PROGRESS, the status doesn't change.

" } } } @@ -2746,7 +2756,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a target group. You can't delete a target group if it is used in a listener rule or\n if the target group creation is in progress.

", + "smithy.api#documentation": "

Deletes a target group. You can't delete a target group if it is used in a listener rule or if the target group creation is in progress.

", "smithy.api#http": { "code": 200, "uri": "/targetgroups/{targetGroupIdentifier}", @@ -2786,7 +2796,7 @@ "status": { "target": "com.amazonaws.vpclattice#TargetGroupStatus", "traits": { - "smithy.api#documentation": "

The status. You can retry the operation if the status is DELETE_FAILED.\n However, if you retry it while the status is DELETE_IN_PROGRESS, the status doesn't\n change.

" + "smithy.api#documentation": "

The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it while the status is DELETE_IN_PROGRESS, the status doesn't change.

" } } } @@ -2902,7 +2912,7 @@ "ipAddressType": { "target": "com.amazonaws.vpclattice#ResourceConfigurationIpAddressType", "traits": { - "smithy.api#documentation": "

The type of IP address.

" + "smithy.api#documentation": "

The type of IP address. Dualstack is currently not supported.

" } } }, @@ -2931,7 +2941,7 @@ "statusCode": { "target": "com.amazonaws.vpclattice#HttpStatusCode", "traits": { - "smithy.api#documentation": "

The HTTP response code.

", + "smithy.api#documentation": "

The HTTP response code. Only 404 and 500 status codes are supported.

", "smithy.api#required": {} } } @@ -2946,13 +2956,13 @@ "targetGroups": { "target": "com.amazonaws.vpclattice#WeightedTargetGroupList", "traits": { - "smithy.api#documentation": "

The target groups. Traffic matching the rule is forwarded to the specified target groups.\n With forward actions, you can assign a weight that controls the prioritization and selection of\n each target group. This means that requests are distributed to individual target groups based on\n their weights. For example, if two target groups have the same weight, each target group receives\n half of the traffic.

\n

The default value is 1. This means that if only one target group is provided, there is no\n need to set the weight; 100% of the traffic goes to that target group.

", + "smithy.api#documentation": "

The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Describes a forward action. You can use forward actions to route requests to one or more\n target groups.\n

" + "smithy.api#documentation": "

Describes a forward action. You can use forward actions to route requests to one or more target groups.

" } }, "com.amazonaws.vpclattice#GetAccessLogSubscription": { @@ -3089,7 +3099,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about the auth policy for the specified service or service\n network.

", + "smithy.api#documentation": "

Retrieves information about the auth policy for the specified service or service network.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -3123,7 +3133,7 @@ "state": { "target": "com.amazonaws.vpclattice#AuthPolicyState", "traits": { - "smithy.api#documentation": "

The state of the auth policy. The auth policy is only active when the auth type is set to\n AWS_IAM. If you provide a policy, then authentication and authorization decisions\n are made based on this policy and the client's IAM policy. If the auth type is NONE,\n then any auth policy that you provide remains inactive. For more information, see Create a service network in the Amazon VPC Lattice User Guide.

" + "smithy.api#documentation": "

The state of the auth policy. The auth policy is only active when the auth type is set to AWS_IAM. If you provide a policy, then authentication and authorization decisions are made based on this policy and the client's IAM policy. If the auth type is NONE, then any auth policy that you provide remains inactive. For more information, see Create a service network in the Amazon VPC Lattice User Guide.

" } }, "createdAt": { @@ -3348,13 +3358,13 @@ "type": { "target": "com.amazonaws.vpclattice#ResourceConfigurationType", "traits": { - "smithy.api#documentation": "

The type of resource configuration.

\n
    \n
  • \n

    \n SINGLE - A single resource.

    \n
  • \n
  • \n

    \n GROUP - A group of resources.

    \n
  • \n
  • \n

    \n CHILD - A single resource that is part of a group resource configuration.

    \n
  • \n
  • \n

    \n ARN - An Amazon Web Services resource.

    \n
  • \n
" + "smithy.api#documentation": "

The type of resource configuration.

  • SINGLE - A single resource.

  • GROUP - A group of resources.

  • CHILD - A single resource that is part of a group resource configuration.

  • ARN - An Amazon Web Services resource.

" } }, "allowAssociationToShareableServiceNetwork": { "target": "com.amazonaws.vpclattice#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the resource configuration is associated with a sharable service\n network.

" + "smithy.api#documentation": "

Specifies whether the resource configuration is associated with a sharable service network.

" } }, "portRanges": { @@ -3518,6 +3528,12 @@ "smithy.api#documentation": "

The type of IP address for the resource gateway.

" } }, + "ipv4AddressesPerEni": { + "target": "com.amazonaws.vpclattice#Ipv4AddressesPerEni", + "traits": { + "smithy.api#documentation": "

The number of IPv4 addresses in each ENI for the resource gateway.

" + } + }, "createdAt": { "target": "com.amazonaws.vpclattice#Timestamp", "traits": { @@ -3561,7 +3577,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about the specified resource policy. The resource policy is an IAM policy\n created on behalf of the resource owner when they share a resource.

", + "smithy.api#documentation": "

Retrieves information about the specified resource policy. The resource policy is an IAM policy created on behalf of the resource owner when they share a resource.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -3620,7 +3636,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about the specified listener rules. You can also retrieve information about the\n default listener rule. For more information, see Listener rules in the\n Amazon VPC Lattice User Guide.

", + "smithy.api#documentation": "

Retrieves information about the specified listener rules. You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -4528,7 +4544,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the constraints for a header match. Matches incoming requests with rule based on\n request header value before applying rule action.

" + "smithy.api#documentation": "

Describes the constraints for a header match. Matches incoming requests with rule based on request header value before applying rule action.

" } }, "com.amazonaws.vpclattice#HeaderMatchContains": { @@ -4617,49 +4633,49 @@ "protocol": { "target": "com.amazonaws.vpclattice#TargetGroupProtocol", "traits": { - "smithy.api#documentation": "

The protocol used when performing health checks on targets. The possible protocols are\n HTTP and HTTPS. The default is HTTP.

" + "smithy.api#documentation": "

The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

" } }, "protocolVersion": { "target": "com.amazonaws.vpclattice#HealthCheckProtocolVersion", "traits": { - "smithy.api#documentation": "

The protocol version used when performing health checks on targets. The possible protocol\n versions are HTTP1 and HTTP2.

" + "smithy.api#documentation": "

The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

" } }, "port": { "target": "com.amazonaws.vpclattice#HealthCheckPort", "traits": { - "smithy.api#documentation": "

The port used when performing health checks on targets. The default setting is the port that\n a target receives traffic on.

" + "smithy.api#documentation": "

The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

" } }, "path": { "target": "com.amazonaws.vpclattice#HealthCheckPath", "traits": { - "smithy.api#documentation": "

The destination for health checks on the targets. If the protocol version is\n HTTP/1.1 or HTTP/2, specify a valid URI (for example,\n /path?query). The default path is /. Health checks are not supported\n if the protocol version is gRPC, however, you can choose HTTP/1.1 or\n HTTP/2 and specify a valid URI.

" + "smithy.api#documentation": "

The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

" } }, "healthCheckIntervalSeconds": { "target": "com.amazonaws.vpclattice#HealthCheckIntervalSeconds", "traits": { - "smithy.api#documentation": "

The approximate amount of time, in seconds, between health checks of an individual target.\n The range is 5–300 seconds. The default is 30 seconds.

" + "smithy.api#documentation": "

The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

" } }, "healthCheckTimeoutSeconds": { "target": "com.amazonaws.vpclattice#HealthCheckTimeoutSeconds", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is\n 1–120 seconds. The default is 5 seconds.

" + "smithy.api#documentation": "

The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

" } }, "healthyThresholdCount": { "target": "com.amazonaws.vpclattice#HealthyThresholdCount", "traits": { - "smithy.api#documentation": "

The number of consecutive successful health checks required before considering an unhealthy\n target healthy. The range is 2–10. The default is 5.

" + "smithy.api#documentation": "

The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

" } }, "unhealthyThresholdCount": { "target": "com.amazonaws.vpclattice#UnhealthyThresholdCount", "traits": { - "smithy.api#documentation": "

The number of consecutive failed health checks required before considering a target\n unhealthy. The range is 2–10. The default is 2.

" + "smithy.api#documentation": "

The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

" } }, "matcher": { @@ -4670,7 +4686,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the health check configuration of a target group. Health check configurations\n aren't used for target groups of type LAMBDA or ALB.

" + "smithy.api#documentation": "

Describes the health check configuration of a target group. Health check configurations aren't used for target groups of type LAMBDA or ALB.

" } }, "com.amazonaws.vpclattice#HealthCheckIntervalSeconds": { @@ -4764,7 +4780,7 @@ "headerMatches": { "target": "com.amazonaws.vpclattice#HeaderMatchList", "traits": { - "smithy.api#documentation": "

The header matches. Matches incoming requests with rule based on request header value before\n applying rule action.

" + "smithy.api#documentation": "

The header matches. Matches incoming requests with rule based on request header value before applying rule action.

" } } }, @@ -4853,6 +4869,15 @@ "smithy.api#documentation": "

Describes an IP resource.

" } }, + "com.amazonaws.vpclattice#Ipv4AddressesPerEni": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 62 + } + } + }, "com.amazonaws.vpclattice#LambdaEventStructureVersion": { "type": "string", "traits": { @@ -5090,7 +5115,7 @@ "resourceConfigurationGroupIdentifier": { "target": "com.amazonaws.vpclattice#ResourceConfigurationIdentifier", "traits": { - "smithy.api#documentation": "

The ID of the group resource configuration.

", + "smithy.api#documentation": "

The ID of the resource configuration of type Group.

", "smithy.api#httpQuery": "resourceConfigurationGroupIdentifier" } }, @@ -5468,7 +5493,7 @@ "resourceConfigurationIdentifier": { "target": "com.amazonaws.vpclattice#ResourceConfigurationIdentifier", "traits": { - "smithy.api#documentation": "

The ID of the resource configurationk.

", + "smithy.api#documentation": "

The ID of the resource configuration.

", "smithy.api#httpQuery": "resourceConfigurationIdentifier" } }, @@ -5485,6 +5510,13 @@ "smithy.api#documentation": "

If there are additional results, a pagination token for the next page of results.

", "smithy.api#httpQuery": "nextToken" } + }, + "includeChildren": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include service network resource associations of the child resource configuration with the grouped resource configuration.

The type is boolean and the default value is false.

", + "smithy.api#httpQuery": "includeChildren" + } } }, "traits": { @@ -5535,7 +5567,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the associations between a service network and a service. You can filter the list\n either by service or service network. You must provide either the service network identifier or\n the service identifier.

\n

Every association in Amazon VPC Lattice has a unique Amazon Resource Name (ARN), such as when a\n service network is associated with a VPC or when a service is associated with a service network.\n If the association is for a resource is shared with another account, the association\n includes the local account ID as the prefix in the ARN.

", + "smithy.api#documentation": "

Lists the associations between a service network and a service. You can filter the list either by service or service network. You must provide either the service network identifier or the service identifier.

Every association in Amazon VPC Lattice has a unique Amazon Resource Name (ARN), such as when a service network is associated with a VPC or when a service is associated with a service network. If the association is for a resource is shared with another account, the association includes the local account ID as the prefix in the ARN.

", "smithy.api#http": { "code": 200, "uri": "/servicenetworkserviceassociations", @@ -5624,7 +5656,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the associations between a service network and a VPC. You can filter the list either by VPC or\n service network. You must provide either the ID of the service network identifier or the ID of the VPC.

", + "smithy.api#documentation": "

Lists the associations between a service network and a VPC. You can filter the list either by VPC or service network. You must provide either the ID of the service network identifier or the ID of the VPC.

", "smithy.api#http": { "code": 200, "uri": "/servicenetworkvpcassociations", @@ -5802,7 +5834,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the service networks owned by or shared with this account. The account ID in the ARN\n shows which account owns the service network.

", + "smithy.api#documentation": "

Lists the service networks owned by or shared with this account. The account ID in the ARN shows which account owns the service network.

", "smithy.api#http": { "code": 200, "uri": "/servicenetworks", @@ -6006,7 +6038,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists your target groups. You can narrow your search by using the filters below in your\n request.

", + "smithy.api#documentation": "

Lists your target groups. You can narrow your search by using the filters below in your request.

", "smithy.api#http": { "code": 200, "uri": "/targetgroups", @@ -6097,7 +6129,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the targets for the target group. By default, all targets are included. You can use\n this API to check the health status of targets. You can also filter the results by target.

", + "smithy.api#documentation": "

Lists the targets for the target group. By default, all targets are included. You can use this API to check the health status of targets. You can also filter the results by target.

", "smithy.api#http": { "code": 200, "uri": "/targetgroups/{targetGroupIdentifier}/listtargets", @@ -6322,7 +6354,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the codes to use when checking for a successful response from a target for health\n checks.

" + "smithy.api#documentation": "

Describes the codes to use when checking for a successful response from a target for health checks.

" } }, "com.amazonaws.vpclattice#MaxResults": { @@ -6439,7 +6471,7 @@ "x-amzn-trace-id" ] }, - "smithy.api#documentation": "

Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure,\n and monitor all of your services across multiple accounts and virtual private clouds (VPCs).\n Amazon VPC Lattice interconnects your microservices and legacy services within a logical boundary, so that\n you can discover and manage them more efficiently. For more information, see the Amazon VPC Lattice User Guide\n

", + "smithy.api#documentation": "

Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure, and monitor all of your services across multiple accounts and virtual private clouds (VPCs). Amazon VPC Lattice interconnects your microservices and legacy services within a logical boundary, so that you can discover and manage them more efficiently. For more information, see the Amazon VPC Lattice User Guide

", "smithy.api#title": "Amazon VPC Lattice", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -6949,17 +6981,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6973,17 +6994,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -6997,17 +7007,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -7021,17 +7020,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -7134,7 +7122,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the conditions that can be applied when matching a path for incoming\n requests.

" + "smithy.api#documentation": "

Describes the conditions that can be applied when matching a path for incoming requests.

" } }, "com.amazonaws.vpclattice#PathMatchExact": { @@ -7174,7 +7162,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a path match type. Each rule can include only one of the following types of\n paths.

" + "smithy.api#documentation": "

Describes a path match type. Each rule can include only one of the following types of paths.

" } }, "com.amazonaws.vpclattice#PolicyString": { @@ -7250,7 +7238,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates the auth policy. The policy string in JSON must not contain newlines or\n blank lines.

\n

For more information, see Auth policies in the Amazon VPC\n Lattice User Guide.

", + "smithy.api#documentation": "

Creates or updates the auth policy. The policy string in JSON must not contain newlines or blank lines.

For more information, see Auth policies in the Amazon VPC Lattice User Guide.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -7264,7 +7252,7 @@ "resourceIdentifier": { "target": "com.amazonaws.vpclattice#ResourceIdentifier", "traits": { - "smithy.api#documentation": "

The ID or ARN of the service network or service for which the policy\n is created.

", + "smithy.api#documentation": "

The ID or ARN of the service network or service for which the policy is created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7290,7 +7278,7 @@ "state": { "target": "com.amazonaws.vpclattice#AuthPolicyState", "traits": { - "smithy.api#documentation": "

The state of the auth policy. The auth policy is only active when the auth type is set to\n AWS_IAM. If you provide a policy, then authentication and authorization decisions\n are made based on this policy and the client's IAM policy. If the Auth type is NONE,\n then, any auth policy that you provide remains inactive. For more information, see Create a service network in the Amazon VPC Lattice User Guide.

" + "smithy.api#documentation": "

The state of the auth policy. The auth policy is only active when the auth type is set to AWS_IAM. If you provide a policy, then authentication and authorization decisions are made based on this policy and the client's IAM policy. If the Auth type is NONE, then, any auth policy that you provide remains inactive. For more information, see Create a service network in the Amazon VPC Lattice User Guide.

" } } } @@ -7321,7 +7309,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches a resource-based permission policy to a service or service network. The policy must\n contain the same actions and condition statements as the Amazon Web Services Resource Access\n Manager permission for sharing services and service networks.

", + "smithy.api#documentation": "

Attaches a resource-based permission policy to a service or service network. The policy must contain the same actions and condition statements as the Amazon Web Services Resource Access Manager permission for sharing services and service networks.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -7336,7 +7324,7 @@ "resourceArn": { "target": "com.amazonaws.vpclattice#ResourceArn", "traits": { - "smithy.api#documentation": "

The ID or ARN of the service network or service for which the policy\n is created.

", + "smithy.api#documentation": "

The ID or ARN of the service network or service for which the policy is created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7344,7 +7332,7 @@ "policy": { "target": "com.amazonaws.vpclattice#PolicyString", "traits": { - "smithy.api#documentation": "

An IAM policy. The policy string in JSON must not contain newlines or blank\n lines.

", + "smithy.api#documentation": "

An IAM policy. The policy string in JSON must not contain newlines or blank lines.

", "smithy.api#required": {} } } @@ -7386,7 +7374,7 @@ } ], "traits": { - "smithy.api#documentation": "

Registers the targets with the target group. If it's a Lambda target, you can only have one\n target in a target group.

", + "smithy.api#documentation": "

Registers the targets with the target group. If it's a Lambda target, you can only have one target in a target group.

", "smithy.api#http": { "code": 200, "uri": "/targetgroups/{targetGroupIdentifier}/registertargets", @@ -7634,7 +7622,7 @@ "type": { "target": "com.amazonaws.vpclattice#ResourceConfigurationType", "traits": { - "smithy.api#documentation": "

The type of resource configuration.

\n
    \n
  • \n

    \n SINGLE - A single resource.

    \n
  • \n
  • \n

    \n GROUP - A group of resources.

    \n
  • \n
  • \n

    \n CHILD - A single resource that is part of a group resource configuration.

    \n
  • \n
  • \n

    \n ARN - An Amazon Web Services resource.

    \n
  • \n
" + "smithy.api#documentation": "

The type of resource configuration.

  • SINGLE - A single resource.

  • GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.

  • CHILD - A single resource that is part of a group resource configuration.

  • ARN - An Amazon Web Services resource.

" } }, "status": { @@ -7995,6 +7983,12 @@ "smithy.api#documentation": "

The type of IP address used by the resource gateway.

" } }, + "ipv4AddressesPerEni": { + "target": "com.amazonaws.vpclattice#Ipv4AddressesPerEni", + "traits": { + "smithy.api#documentation": "

The number of IPv4 addresses in each ENI for the resource gateway.

" + } + }, "createdAt": { "target": "com.amazonaws.vpclattice#Timestamp", "traits": { @@ -8097,7 +8091,7 @@ "forward": { "target": "com.amazonaws.vpclattice#ForwardAction", "traits": { - "smithy.api#documentation": "

The forward action. Traffic that matches the rule is forwarded to the specified target\n groups.

" + "smithy.api#documentation": "

The forward action. Traffic that matches the rule is forwarded to the specified target groups.

" } }, "fixedResponse": { @@ -8170,7 +8164,7 @@ "traits": { "smithy.api#range": { "min": 1, - "max": 100 + "max": 2000 } } }, @@ -8303,7 +8297,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 5 + "max": 10 } } }, @@ -8755,7 +8749,7 @@ "status": { "target": "com.amazonaws.vpclattice#ServiceNetworkResourceAssociationStatus", "traits": { - "smithy.api#documentation": "

The status of the service network associated with the resource configuration.

" + "smithy.api#documentation": "

The status of the service network’s association with the resource configuration. If the deletion fails, try to delete again.

" } }, "createdBy": { @@ -8925,7 +8919,7 @@ "status": { "target": "com.amazonaws.vpclattice#ServiceNetworkServiceAssociationStatus", "traits": { - "smithy.api#documentation": "

The status. If the deletion fails, try to delete again.

" + "smithy.api#documentation": "

The status of the service network’s association with the service. If the deletion fails, try to delete again.

" } }, "arn": { @@ -9503,7 +9497,7 @@ "id": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ID of the target. If the target group type is INSTANCE, this is an instance\n ID. If the target group type is IP, this is an IP address. If the target group type\n is LAMBDA, this is the ARN of a Lambda function. If the target group type is\n ALB, this is the ARN of an Application Load Balancer.

", + "smithy.api#documentation": "

The ID of the target. If the target group type is INSTANCE, this is an instance ID. If the target group type is IP, this is an IP address. If the target group type is LAMBDA, this is the ARN of a Lambda function. If the target group type is ALB, this is the ARN of an Application Load Balancer.

", "smithy.api#length": { "min": 1, "max": 200 @@ -9514,7 +9508,7 @@ "port": { "target": "com.amazonaws.vpclattice#Port", "traits": { - "smithy.api#documentation": "

The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the\n default is 443.

" + "smithy.api#documentation": "

The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.

" } } }, @@ -9528,13 +9522,13 @@ "id": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ID of the target. If the target group type is INSTANCE, this is an instance\n ID. If the target group type is IP, this is an IP address. If the target group type\n is LAMBDA, this is the ARN of a Lambda function. If the target group type is\n ALB, this is the ARN of an Application Load Balancer.

" + "smithy.api#documentation": "

The ID of the target. If the target group type is INSTANCE, this is an instance ID. If the target group type is IP, this is an IP address. If the target group type is LAMBDA, this is the ARN of a Lambda function. If the target group type is ALB, this is the ARN of an Application Load Balancer.

" } }, "port": { "target": "com.amazonaws.vpclattice#Port", "traits": { - "smithy.api#documentation": "

The port on which the target is listening. This parameter doesn't apply if the target is a\n Lambda function.

" + "smithy.api#documentation": "

The port on which the target is listening. This parameter doesn't apply if the target is a Lambda function.

" } }, "failureCode": { @@ -9610,25 +9604,25 @@ "port": { "target": "com.amazonaws.vpclattice#Port", "traits": { - "smithy.api#documentation": "

The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the\n default is 443. Not supported if the target group type is LAMBDA.

" + "smithy.api#documentation": "

The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is LAMBDA.

" } }, "protocol": { "target": "com.amazonaws.vpclattice#TargetGroupProtocol", "traits": { - "smithy.api#documentation": "

The protocol to use for routing traffic to the targets. The default is the protocol of the\n target group. Not supported if the target group type is LAMBDA.

" + "smithy.api#documentation": "

The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is LAMBDA.

" } }, "protocolVersion": { "target": "com.amazonaws.vpclattice#TargetGroupProtocolVersion", "traits": { - "smithy.api#documentation": "

The protocol version. The default is HTTP1. Not supported if the target group\n type is LAMBDA.

" + "smithy.api#documentation": "

The protocol version. The default is HTTP1. Not supported if the target group type is LAMBDA.

" } }, "ipAddressType": { "target": "com.amazonaws.vpclattice#IpAddressType", "traits": { - "smithy.api#documentation": "

The type of IP address used for the target group. Supported only if the target group type is\n IP. The default is IPV4.

" + "smithy.api#documentation": "

The type of IP address used for the target group. Supported only if the target group type is IP. The default is IPV4.

" } }, "vpcIdentifier": { @@ -9640,18 +9634,18 @@ "healthCheck": { "target": "com.amazonaws.vpclattice#HealthCheckConfig", "traits": { - "smithy.api#documentation": "

The health check configuration. Not supported if the target group type is\n LAMBDA or ALB.

" + "smithy.api#documentation": "

The health check configuration. Not supported if the target group type is LAMBDA or ALB.

" } }, "lambdaEventStructureVersion": { "target": "com.amazonaws.vpclattice#LambdaEventStructureVersion", "traits": { - "smithy.api#documentation": "

The version of the event structure that your Lambda function receives. Supported only if the\n target group type is LAMBDA. The default is V1.

" + "smithy.api#documentation": "

The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA. The default is V1.

" } } }, "traits": { - "smithy.api#documentation": "

Describes the configuration of a target group.

\n

For more information, see Target groups in the\n Amazon VPC Lattice User Guide.

" + "smithy.api#documentation": "

Describes the configuration of a target group.

For more information, see Target groups in the Amazon VPC Lattice User Guide.

" } }, "com.amazonaws.vpclattice#TargetGroupId": { @@ -9814,7 +9808,7 @@ "ipAddressType": { "target": "com.amazonaws.vpclattice#IpAddressType", "traits": { - "smithy.api#documentation": "

The type of IP address used for the target group. The possible values are IPV4\n and IPV6. This is an optional parameter. If not specified, the default is\n IPV4.

" + "smithy.api#documentation": "

The type of IP address used for the target group. The possible values are IPV4 and IPV6. This is an optional parameter. If not specified, the default is IPV4.

" } }, "vpcIdentifier": { @@ -9844,12 +9838,12 @@ "lambdaEventStructureVersion": { "target": "com.amazonaws.vpclattice#LambdaEventStructureVersion", "traits": { - "smithy.api#documentation": "

The version of the event structure that your Lambda function receives. Supported only if the\n target group type is LAMBDA.

" + "smithy.api#documentation": "

The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA.

" } } }, "traits": { - "smithy.api#documentation": "

Summary information about a target group.

\n

For more information, see Target groups in the\n Amazon VPC Lattice User Guide.

" + "smithy.api#documentation": "

Summary information about a target group.

For more information, see Target groups in the Amazon VPC Lattice User Guide.

" } }, "com.amazonaws.vpclattice#TargetGroupType": { @@ -9937,7 +9931,7 @@ "id": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ID of the target. If the target group type is INSTANCE, this is an instance\n ID. If the target group type is IP, this is an IP address. If the target group type\n is LAMBDA, this is the ARN of a Lambda function. If the target type is\n ALB, this is the ARN of an Application Load Balancer.

" + "smithy.api#documentation": "

The ID of the target. If the target group type is INSTANCE, this is an instance ID. If the target group type is IP, this is an IP address. If the target group type is LAMBDA, this is the ARN of a Lambda function. If the target type is ALB, this is the ARN of an Application Load Balancer.

" } }, "port": { @@ -9949,7 +9943,7 @@ "status": { "target": "com.amazonaws.vpclattice#TargetStatus", "traits": { - "smithy.api#documentation": "

The status of the target.

\n
    \n
  • \n

    \n DRAINING: The target is being deregistered. No new connections are sent to\n this target while current connections are being drained. The default draining time is 5\n minutes.

    \n
  • \n
  • \n

    \n UNAVAILABLE: Health checks are unavailable for the target group.

    \n
  • \n
  • \n

    \n HEALTHY: The target is healthy.

    \n
  • \n
  • \n

    \n UNHEALTHY: The target is unhealthy.

    \n
  • \n
  • \n

    \n INITIAL: Initial health checks on the target are being performed.

    \n
  • \n
  • \n

    \n UNUSED: Target group is not used in a service.

    \n
  • \n
" + "smithy.api#documentation": "

The status of the target.

  • DRAINING: The target is being deregistered. No new connections are sent to this target while current connections are being drained. The default draining time is 5 minutes.

  • UNAVAILABLE: Health checks are unavailable for the target group.

  • HEALTHY: The target is healthy.

  • UNHEALTHY: The target is unhealthy.

  • INITIAL: Initial health checks on the target are being performed.

  • UNUSED: Target group is not used in a service.

" } }, "reasonCode": { @@ -10349,7 +10343,7 @@ "resourceConfigurationDefinition": { "target": "com.amazonaws.vpclattice#ResourceConfigurationDefinition", "traits": { - "smithy.api#documentation": "

The resource configuration.

" + "smithy.api#documentation": "

Identifies the resource configuration in one of the following ways:

  • Amazon Resource Name (ARN) - Supported resource-types that are provisioned by Amazon Web Services services, such as RDS databases, can be identified by their ARN.

  • Domain name - Any domain name that is publicly resolvable.

  • IP address - For IPv4 and IPv6, only IP addresses in the VPC are supported.

" } }, "allowAssociationToShareableServiceNetwork": { @@ -10405,7 +10399,7 @@ "type": { "target": "com.amazonaws.vpclattice#ResourceConfigurationType", "traits": { - "smithy.api#documentation": "

The type of resource configuration.

\n
    \n
  • \n

    \n SINGLE - A single resource.

    \n
  • \n
  • \n

    \n GROUP - A group of resources.

    \n
  • \n
  • \n

    \n CHILD - A single resource that is part of a group resource configuration.

    \n
  • \n
  • \n

    \n ARN - An Amazon Web Services resource.

    \n
  • \n
" + "smithy.api#documentation": "

The type of resource configuration.

  • SINGLE - A single resource.

  • GROUP - A group of resources.

  • CHILD - A single resource that is part of a group resource configuration.

  • ARN - An Amazon Web Services resource.

" } }, "portRanges": { @@ -10455,6 +10449,9 @@ { "target": "com.amazonaws.vpclattice#AccessDeniedException" }, + { + "target": "com.amazonaws.vpclattice#ConflictException" + }, { "target": "com.amazonaws.vpclattice#InternalServerException" }, @@ -10591,7 +10588,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a specified rule for the listener. You can't modify a default listener rule. To modify a\n default listener rule, use UpdateListener.

", + "smithy.api#documentation": "

Updates a specified rule for the listener. You can't modify a default listener rule. To modify a default listener rule, use UpdateListener.

", "smithy.api#http": { "code": 200, "method": "PATCH", @@ -10786,7 +10783,7 @@ "authType": { "target": "com.amazonaws.vpclattice#AuthType", "traits": { - "smithy.api#documentation": "

The type of IAM policy.

\n
    \n
  • \n

    \n NONE: The resource does not use an IAM policy. This is the default.

    \n
  • \n
  • \n

    \n AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

    \n
  • \n
", + "smithy.api#documentation": "

The type of IAM policy.

  • NONE: The resource does not use an IAM policy. This is the default.

  • AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

", "smithy.api#required": {} } } @@ -10850,7 +10847,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the service network and VPC association. If you add a security group to the service\n network and VPC association, the association must continue to have at least one security\n group. You can add or edit security groups at any time. However, to remove all security groups,\n you must first delete the association and then recreate it without security groups.

", + "smithy.api#documentation": "

Updates the service network and VPC association. If you add a security group to the service network and VPC association, the association must continue to have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and then recreate it without security groups.

", "smithy.api#http": { "code": 200, "uri": "/servicenetworkvpcassociations/{serviceNetworkVpcAssociationIdentifier}", @@ -10901,7 +10898,7 @@ "status": { "target": "com.amazonaws.vpclattice#ServiceNetworkVpcAssociationStatus", "traits": { - "smithy.api#documentation": "

The status. You can retry the operation if the status is DELETE_FAILED.\n However, if you retry it while the status is DELETE_IN_PROGRESS, there is no change\n in the status.

" + "smithy.api#documentation": "

The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it while the status is DELETE_IN_PROGRESS, there is no change in the status.

" } }, "createdBy": { @@ -10938,7 +10935,7 @@ "authType": { "target": "com.amazonaws.vpclattice#AuthType", "traits": { - "smithy.api#documentation": "

The type of IAM policy.

\n
    \n
  • \n

    \n NONE: The resource does not use an IAM policy. This is the default.

    \n
  • \n
  • \n

    \n AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

    \n
  • \n
" + "smithy.api#documentation": "

The type of IAM policy.

  • NONE: The resource does not use an IAM policy. This is the default.

  • AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

" } } } @@ -11110,7 +11107,7 @@ } }, "traits": { - "smithy.api#documentation": "

The input does not satisfy the constraints specified by an Amazon Web Services\n service.

", + "smithy.api#documentation": "

The input does not satisfy the constraints specified by an Amazon Web Services service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11209,7 +11206,7 @@ "weight": { "target": "com.amazonaws.vpclattice#TargetGroupWeight", "traits": { - "smithy.api#documentation": "

Only required if you specify multiple target groups for a forward action. The weight\n determines how requests are distributed to the target group. For example, if you specify two\n target groups, each with a weight of 10, each target group receives half the requests. If you\n specify two target groups, one with a weight of 10 and the other with a weight of 20, the target\n group with a weight of 20 receives twice as many requests as the other target group. If there's\n only one target group specified, then the default value is 100.

" + "smithy.api#documentation": "

Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

" } } }, diff --git a/codegen/sdk/aws-models/waf-regional.json b/codegen/sdk/aws-models/waf-regional.json index dc6128bc426..0163c39fd8c 100644 --- a/codegen/sdk/aws-models/waf-regional.json +++ b/codegen/sdk/aws-models/waf-regional.json @@ -1364,17 +1364,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1388,17 +1377,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1412,17 +1390,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1436,17 +1403,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/waf.json b/codegen/sdk/aws-models/waf.json index 197779e7fc9..7b0d21692d5 100644 --- a/codegen/sdk/aws-models/waf.json +++ b/codegen/sdk/aws-models/waf.json @@ -918,17 +918,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -942,17 +931,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -966,17 +944,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -990,17 +957,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/wafv2.json b/codegen/sdk/aws-models/wafv2.json index 2cd411ad967..b9d56246a57 100644 --- a/codegen/sdk/aws-models/wafv2.json +++ b/codegen/sdk/aws-models/wafv2.json @@ -1481,17 +1481,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1505,17 +1494,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1529,17 +1507,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1553,17 +1520,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1975,7 +1931,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 10 + "max": 50 } } }, @@ -11380,7 +11336,7 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the rule to override.

\n \n

Take care to verify the rule names in your overrides. If you provide a rule name that doesn't match the name of any rule in the rule group, WAF doesn't return an error and doesn't apply the override setting.

\n
", + "smithy.api#documentation": "

The name of the rule to override.

\n \n

Verify the rule names in your overrides carefully. With managed rule groups, WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.

\n
", "smithy.api#required": {} } }, @@ -11393,7 +11349,7 @@ } }, "traits": { - "smithy.api#documentation": "

Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.

\n \n

Take care to verify the rule names in your overrides. If you provide a rule name that doesn't match the name of any rule in the rule group, WAF doesn't return an error and doesn't apply the override setting.

\n
\n

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

" + "smithy.api#documentation": "

Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.

\n \n

Verify the rule names in your overrides carefully. With managed rule groups, WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.

\n
\n

You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

" } }, "com.amazonaws.wafv2#RuleActionOverrides": { @@ -13046,6 +13002,12 @@ "traits": { "smithy.api#documentation": "

Specifies the type of DDoS protection to apply to web request data for a web ACL. For most scenarios, it is recommended to use the default protection level, ACTIVE_UNDER_DDOS. \n If a web ACL is associated with multiple Application Load Balancers, the changes you make to DDoS protection in that web ACL will apply to all associated Application Load Balancers.

" } + }, + "ApplicationConfig": { + "target": "com.amazonaws.wafv2#ApplicationConfig", + "traits": { + "smithy.api#documentation": "

Configures the ability for the WAF console to store and retrieve application attributes. \n Application attributes help WAF give recommendations for protection packs.

\n

When using UpdateWebACL, ApplicationConfig follows these rules:

\n
    \n
  • \n

    If you omit ApplicationConfig from the request, all existing entries in the web ACL are retained.

    \n
  • \n
  • \n

    If you include ApplicationConfig, entries must match the existing values exactly. Any attempt to modify existing entries will result in an error.

    \n
  • \n
" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/wellarchitected.json b/codegen/sdk/aws-models/wellarchitected.json index f381759fc57..b9bee7f593c 100644 --- a/codegen/sdk/aws-models/wellarchitected.json +++ b/codegen/sdk/aws-models/wellarchitected.json @@ -10948,17 +10948,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -10972,17 +10961,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -10996,17 +10974,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -11020,17 +10987,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/wisdom.json b/codegen/sdk/aws-models/wisdom.json index a3fa3a916e0..f7e4f1bde9f 100644 --- a/codegen/sdk/aws-models/wisdom.json +++ b/codegen/sdk/aws-models/wisdom.json @@ -6840,17 +6840,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6864,17 +6853,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -6888,17 +6866,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -6912,17 +6879,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/workdocs.json b/codegen/sdk/aws-models/workdocs.json index 0a9214950f9..2940cf3825f 100644 --- a/codegen/sdk/aws-models/workdocs.json +++ b/codegen/sdk/aws-models/workdocs.json @@ -733,17 +733,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -757,17 +746,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -781,17 +759,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -805,17 +772,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/workmail.json b/codegen/sdk/aws-models/workmail.json index 65255777e12..aaf28d85151 100644 --- a/codegen/sdk/aws-models/workmail.json +++ b/codegen/sdk/aws-models/workmail.json @@ -7964,8 +7964,7 @@ "RoleArn": { "target": "com.amazonaws.workmail#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration. If absent, the IAM Role Arn of AWSServiceRoleForAmazonWorkMailEvents will be used.

" } }, "LogGroupArn": { @@ -8460,6 +8459,9 @@ }, { "target": "com.amazonaws.workmail#OrganizationStateException" + }, + { + "target": "com.amazonaws.workmail#UnsupportedOperationException" } ], "traits": { @@ -10979,17 +10981,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -11003,17 +10994,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -11027,17 +11007,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -11051,17 +11020,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/workmailmessageflow.json b/codegen/sdk/aws-models/workmailmessageflow.json index 8657fbca90a..09695f20a35 100644 --- a/codegen/sdk/aws-models/workmailmessageflow.json +++ b/codegen/sdk/aws-models/workmailmessageflow.json @@ -580,17 +580,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -604,17 +593,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -628,17 +606,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -652,17 +619,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/workspaces-instances.json b/codegen/sdk/aws-models/workspaces-instances.json index 4a7522a8580..299ba5eda1d 100644 --- a/codegen/sdk/aws-models/workspaces-instances.json +++ b/codegen/sdk/aws-models/workspaces-instances.json @@ -1184,102 +1184,6 @@ "UseFIPS": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://workspaces-instances-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://workspaces-instances.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://workspaces-instances-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://workspaces-instances.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://workspaces-instances-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://workspaces-instances.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://workspaces-instances-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://workspaces-instances.us-isof-south-1.csp.hci.ic.gov" - } - }, - "params": { - "Region": "us-isof-south-1", - "UseFIPS": false - } - }, { "documentation": "Missing region", "expect": { diff --git a/codegen/sdk/aws-models/workspaces-thin-client.json b/codegen/sdk/aws-models/workspaces-thin-client.json index d5aa4934853..b9930a82d35 100644 --- a/codegen/sdk/aws-models/workspaces-thin-client.json +++ b/codegen/sdk/aws-models/workspaces-thin-client.json @@ -2777,17 +2777,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2801,17 +2790,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -2825,17 +2803,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -2849,17 +2816,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/workspaces-web.json b/codegen/sdk/aws-models/workspaces-web.json index 2ec5f0fbaad..f79ce436190 100644 --- a/codegen/sdk/aws-models/workspaces-web.json +++ b/codegen/sdk/aws-models/workspaces-web.json @@ -579,17 +579,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -603,17 +592,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -627,17 +605,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -651,17 +618,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { diff --git a/codegen/sdk/aws-models/workspaces.json b/codegen/sdk/aws-models/workspaces.json index b16247fa732..9330f6c3d37 100644 --- a/codegen/sdk/aws-models/workspaces.json +++ b/codegen/sdk/aws-models/workspaces.json @@ -2785,6 +2785,84 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#CustomImageProtocol": { + "type": "enum", + "members": { + "PCOIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PCOIP" + } + }, + "DCV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DCV" + } + }, + "BYOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYOP" + } + } + } + }, + "com.amazonaws.workspaces#CustomWorkspaceImageImportErrorDetails": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.workspaces#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code that is returned for the image import.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.workspaces#ImageErrorMessage", + "traits": { + "smithy.api#documentation": "

The text of the error message that is returned for the image import.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes in-depth details about the error. These details include the\n possible causes of the error and troubleshooting information.

" + } + }, + "com.amazonaws.workspaces#CustomWorkspaceImageImportErrorDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#CustomWorkspaceImageImportErrorDetails" + } + }, + "com.amazonaws.workspaces#CustomWorkspaceImageImportState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, "com.amazonaws.workspaces#DataReplication": { "type": "enum", "members": { @@ -3698,6 +3776,12 @@ "traits": { "smithy.api#documentation": "

The type of linked account.

" } + }, + "Message": { + "target": "com.amazonaws.workspaces#Message", + "traits": { + "smithy.api#documentation": "

The text message to describe the status of BYOL.

" + } } }, "traits": { @@ -4310,6 +4394,97 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#DescribeCustomWorkspaceImageImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeCustomWorkspaceImageImportRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeCustomWorkspaceImageImportResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about a WorkSpace BYOL image being imported via ImportCustomWorkspaceImage.

" + } + }, + "com.amazonaws.workspaces#DescribeCustomWorkspaceImageImportRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

The identifier of the WorkSpace image.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#DescribeCustomWorkspaceImageImportResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

The identifier of the WorkSpace image.

" + } + }, + "InfrastructureConfigurationArn": { + "target": "com.amazonaws.workspaces#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The infrastructure configuration ARN that specifies how the WorkSpace image is built.

" + } + }, + "State": { + "target": "com.amazonaws.workspaces#CustomWorkspaceImageImportState", + "traits": { + "smithy.api#documentation": "

The state of the WorkSpace image.

" + } + }, + "Created": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the WorkSpace image import was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the WorkSpace image import was last updated.

" + } + }, + "ImageSource": { + "target": "com.amazonaws.workspaces#ImageSourceIdentifier", + "traits": { + "smithy.api#documentation": "

Describes the image import source.

" + } + }, + "ImageBuilderInstanceId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The image builder instance ID of the WorkSpace image.

" + } + }, + "ErrorDetails": { + "target": "com.amazonaws.workspaces#CustomWorkspaceImageImportErrorDetailsList", + "traits": { + "smithy.api#documentation": "

Describes in-depth details about the error. These details include the\n possible causes of the error and troubleshooting information.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#DescribeImageAssociations": { "type": "operation", "input": { @@ -5629,6 +5804,16 @@ "smithy.api#pattern": "^ami\\-([a-f0-9]{8}|[a-f0-9]{17})$" } }, + "com.amazonaws.workspaces#Ec2ImportTaskId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 19, + "max": 28 + }, + "smithy.api#pattern": "^import-ami\\-([a-zA-Z0-9]{8}|[a-zA-Z0-9]{17})$" + } + }, "com.amazonaws.workspaces#EndpointEncryptionMode": { "type": "enum", "members": { @@ -5646,6 +5831,15 @@ } } }, + "com.amazonaws.workspaces#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.workspaces#ErrorDetails": { "type": "structure", "members": { @@ -5952,6 +6146,42 @@ "target": "com.amazonaws.workspaces#ImageAssociatedResourceType" } }, + "com.amazonaws.workspaces#ImageBuildVersionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):image/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$" + } + }, + "com.amazonaws.workspaces#ImageComputeType": { + "type": "enum", + "members": { + "BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASE" + } + }, + "GRAPHICS_G4DN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRAPHICS_G4DN" + } + } + } + }, + "com.amazonaws.workspaces#ImageErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, "com.amazonaws.workspaces#ImagePermission": { "type": "structure", "members": { @@ -6028,6 +6258,32 @@ "target": "com.amazonaws.workspaces#ImageResourceAssociation" } }, + "com.amazonaws.workspaces#ImageSourceIdentifier": { + "type": "union", + "members": { + "Ec2ImportTaskId": { + "target": "com.amazonaws.workspaces#Ec2ImportTaskId", + "traits": { + "smithy.api#documentation": "

The EC2 import task ID to import the image from the Amazon EC2 VM import process.

" + } + }, + "ImageBuildVersionArn": { + "target": "com.amazonaws.workspaces#ImageBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the EC2 Image Builder image.

" + } + }, + "Ec2ImageId": { + "target": "com.amazonaws.workspaces#Ec2ImageId", + "traits": { + "smithy.api#documentation": "

The identifier of the EC2 image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the image import source.

" + } + }, "com.amazonaws.workspaces#ImageType": { "type": "enum", "members": { @@ -6166,6 +6422,128 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#ImportCustomWorkspaceImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#ImportCustomWorkspaceImageRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#ImportCustomWorkspaceImageResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL)\n image into Amazon WorkSpaces using EC2 Image Builder. The image must be an already licensed image that is\n in your Amazon Web Services account, and you must own the image. For more information about\n creating BYOL images, see Bring Your Own Windows\n Desktop Licenses.\n

" + } + }, + "com.amazonaws.workspaces#ImportCustomWorkspaceImageRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.workspaces#WorkspaceImageName", + "traits": { + "smithy.api#documentation": "

The name of the WorkSpace image.

", + "smithy.api#required": {} + } + }, + "ImageDescription": { + "target": "com.amazonaws.workspaces#WorkspaceImageDescription", + "traits": { + "smithy.api#documentation": "

The description of the WorkSpace image.

", + "smithy.api#required": {} + } + }, + "ComputeType": { + "target": "com.amazonaws.workspaces#ImageComputeType", + "traits": { + "smithy.api#documentation": "

The supported compute type for the WorkSpace image.

", + "smithy.api#required": {} + } + }, + "Protocol": { + "target": "com.amazonaws.workspaces#CustomImageProtocol", + "traits": { + "smithy.api#documentation": "

The supported protocol for the WorkSpace image. Windows 11 does not support PCOIP protocol.

", + "smithy.api#required": {} + } + }, + "ImageSource": { + "target": "com.amazonaws.workspaces#ImageSourceIdentifier", + "traits": { + "smithy.api#documentation": "

The options for image import source.

", + "smithy.api#required": {} + } + }, + "InfrastructureConfigurationArn": { + "target": "com.amazonaws.workspaces#InfrastructureConfigurationArn", + "traits": { + "smithy.api#documentation": "

The infrastructure configuration ARN that specifies how the WorkSpace image is built.

", + "smithy.api#required": {} + } + }, + "Platform": { + "target": "com.amazonaws.workspaces#Platform", + "traits": { + "smithy.api#documentation": "

The platform for the WorkSpace image source.

", + "smithy.api#required": {} + } + }, + "OsVersion": { + "target": "com.amazonaws.workspaces#OSVersion", + "traits": { + "smithy.api#documentation": "

The OS version for the WorkSpace image source.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "

The resource tags. Each WorkSpaces resource can have a maximum of 50 tags.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#ImportCustomWorkspaceImageResult": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.workspaces#WorkspaceImageId", + "traits": { + "smithy.api#documentation": "

The identifier of the WorkSpace image.

" + } + }, + "State": { + "target": "com.amazonaws.workspaces#CustomWorkspaceImageImportState", + "traits": { + "smithy.api#documentation": "

The state of the WorkSpace image.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#ImportWorkspaceImage": { "type": "operation", "input": { @@ -6268,6 +6646,16 @@ "smithy.api#error": "client" } }, + "com.amazonaws.workspaces#InfrastructureConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$" + } + }, "com.amazonaws.workspaces#InternalServerException": { "type": "structure", "members": { @@ -6755,6 +7143,9 @@ } } }, + "com.amazonaws.workspaces#Message": { + "type": "string" + }, "com.amazonaws.workspaces#MicrosoftEntraConfig": { "type": "structure", "members": { @@ -6972,7 +7363,14 @@ }, "com.amazonaws.workspaces#ModifyAccountResult": { "type": "structure", - "members": {}, + "members": { + "Message": { + "target": "com.amazonaws.workspaces#Message", + "traits": { + "smithy.api#documentation": "

The text message to describe the status of BYOL modification.

" + } + } + }, "traits": { "smithy.api#output": {} } @@ -7578,6 +7976,23 @@ } } }, + "com.amazonaws.workspaces#OSVersion": { + "type": "enum", + "members": { + "Windows_10": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows_10" + } + }, + "Windows_11": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Windows_11" + } + } + } + }, "com.amazonaws.workspaces#OperatingSystem": { "type": "structure", "members": { @@ -7786,6 +8201,17 @@ "target": "com.amazonaws.workspaces#PendingCreateStandbyWorkspacesRequest" } }, + "com.amazonaws.workspaces#Platform": { + "type": "enum", + "members": { + "WINDOWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS" + } + } + } + }, "com.amazonaws.workspaces#PoolsRunningMode": { "type": "enum", "members": { @@ -12452,6 +12878,9 @@ { "target": "com.amazonaws.workspaces#DescribeConnectionAliasPermissions" }, + { + "target": "com.amazonaws.workspaces#DescribeCustomWorkspaceImageImport" + }, { "target": "com.amazonaws.workspaces#DescribeImageAssociations" }, @@ -12506,6 +12935,9 @@ { "target": "com.amazonaws.workspaces#ImportClientBranding" }, + { + "target": "com.amazonaws.workspaces#ImportCustomWorkspaceImage" + }, { "target": "com.amazonaws.workspaces#ImportWorkspaceImage" }, @@ -13306,17 +13738,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -13330,17 +13751,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -13354,17 +13764,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -13378,17 +13777,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { diff --git a/codegen/sdk/aws-models/xray.json b/codegen/sdk/aws-models/xray.json index 20b242ea11b..979db066a07 100644 --- a/codegen/sdk/aws-models/xray.json +++ b/codegen/sdk/aws-models/xray.json @@ -985,17 +985,6 @@ "UseDualStack": true } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1009,17 +998,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1033,17 +1011,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { @@ -1057,17 +1024,6 @@ "UseDualStack": false } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -1245,6 +1201,15 @@ "target": "com.amazonaws.xray#AnomalousService" } }, + "com.amazonaws.xray#AnomalyCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.xray#AttributeKey": { "type": "string", "traits": { @@ -1487,6 +1452,15 @@ } } }, + "com.amazonaws.xray#CooldownWindowMinutes": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.xray#CreateGroup": { "type": "operation", "input": { @@ -3118,6 +3092,12 @@ "smithy.api#documentation": "

Information about rules that the service is using to sample requests.

", "smithy.api#required": {} } + }, + "SamplingBoostStatisticsDocuments": { + "target": "com.amazonaws.xray#SamplingBoostStatisticsDocumentList", + "traits": { + "smithy.api#documentation": "

Information about rules that the service is using to boost sampling rate.

" + } } }, "traits": { @@ -3144,6 +3124,12 @@ "traits": { "smithy.api#documentation": "

Information about SamplingStatisticsDocument that X-Ray could not\n process.

" } + }, + "UnprocessedBoostStatistics": { + "target": "com.amazonaws.xray#UnprocessedStatisticsList", + "traits": { + "smithy.api#documentation": "

Information about SamplingBoostStatisticsDocument that X-Ray could not\n process.

" + } } }, "traits": { @@ -3462,7 +3448,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Retrieves the current destination of data sent to PutTraceSegments and OpenTelemetry API. The Transaction Search feature requires a CloudWatchLogs destination. For more information, see Transaction Search and OpenTelemetry.\n

", + "smithy.api#documentation": "

\n Retrieves the current destination of data sent to PutTraceSegments and OpenTelemetry protocol (OTLP) endpoint. The Transaction Search feature requires a CloudWatchLogs destination. For more information, see Transaction Search and OpenTelemetry.\n

", "smithy.api#http": { "method": "POST", "uri": "/GetTraceSegmentDestination", @@ -4380,7 +4366,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Retrieves a list of traces for a given RetrievalToken from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see BatchGetTraces.\n

\n

This API does not initiate a retrieval job. To start a trace retrieval, use StartTraceRetrieval, which generates the required RetrievalToken.

\n

\n When the RetrievalStatus is not COMPLETE, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces.

\n

For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is the destination across relevant accounts. For more details, see CloudWatch cross-account observability.

\n

For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see BatchGetTraces.

", + "smithy.api#documentation": "

\n Retrieves a list of traces for a given RetrievalToken from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see BatchGetTraces.\n

\n

This API does not initiate a retrieval process. To start a trace retrieval, use StartTraceRetrieval, which generates the required RetrievalToken.

\n

\n When the RetrievalStatus is not COMPLETE, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces.

\n

For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is set as the destination across relevant accounts. For more details, see CloudWatch cross-account observability.

\n

For retrieving data from X-Ray directly as opposed to the Transaction Search generated log group, see BatchGetTraces.

", "smithy.api#http": { "method": "POST", "uri": "/ListRetrievedTraces", @@ -4547,6 +4533,16 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.xray#MaxRate": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.xray#NullableBoolean": { "type": "boolean" }, @@ -5301,6 +5297,15 @@ } } }, + "com.amazonaws.xray#SampledAnomalyCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.xray#SampledCount": { "type": "integer", "traits": { @@ -5310,6 +5315,118 @@ } } }, + "com.amazonaws.xray#SamplingBoost": { + "type": "structure", + "members": { + "BoostRate": { + "target": "com.amazonaws.xray#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The calculated sampling boost rate for this service

", + "smithy.api#required": {} + } + }, + "BoostRateTTL": { + "target": "com.amazonaws.xray#Timestamp", + "traits": { + "smithy.api#documentation": "

When the sampling boost expires.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Temporary boost sampling rate. X-Ray calculates sampling boost for each service based on the recent sampling boost stats of all services that called\n GetSamplingTargets.

" + } + }, + "com.amazonaws.xray#SamplingBoostStatisticsDocument": { + "type": "structure", + "members": { + "RuleName": { + "target": "com.amazonaws.xray#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the sampling rule.

", + "smithy.api#required": {} + } + }, + "ServiceName": { + "target": "com.amazonaws.xray#ServiceName", + "traits": { + "smithy.api#documentation": "

Matches the name that the service uses to identify itself in segments.

", + "smithy.api#required": {} + } + }, + "Timestamp": { + "target": "com.amazonaws.xray#Timestamp", + "traits": { + "smithy.api#documentation": "

The current time.

", + "smithy.api#required": {} + } + }, + "AnomalyCount": { + "target": "com.amazonaws.xray#AnomalyCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of requests with anomaly.

", + "smithy.api#required": {} + } + }, + "TotalCount": { + "target": "com.amazonaws.xray#TotalCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of requests that associated to the rule.

", + "smithy.api#required": {} + } + }, + "SampledAnomalyCount": { + "target": "com.amazonaws.xray#SampledAnomalyCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of requests with anomaly recorded.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Request anomaly stats for a single rule from a service. Results are for the last 10\n seconds unless the service has been assigned a longer reporting interval after a previous call\n to GetSamplingTargets.

" + } + }, + "com.amazonaws.xray#SamplingBoostStatisticsDocumentList": { + "type": "list", + "member": { + "target": "com.amazonaws.xray#SamplingBoostStatisticsDocument" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.xray#SamplingRateBoost": { + "type": "structure", + "members": { + "MaxRate": { + "target": "com.amazonaws.xray#MaxRate", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Defines max temporary sampling rate to apply when a boost is triggered.\n Calculated boost rate by X-Ray will be less than or equal to this max rate.

", + "smithy.api#required": {} + } + }, + "CooldownWindowMinutes": { + "target": "com.amazonaws.xray#CooldownWindowMinutes", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Sets the time window (in minutes) in which only one sampling rate boost can be triggered.\n After a boost occurs, no further boosts are allowed until the next window.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Enable temporary sampling rate increases when you detect anomalies to improve visibility.

" + } + }, "com.amazonaws.xray#SamplingRule": { "type": "structure", "members": { @@ -5402,6 +5519,12 @@ "traits": { "smithy.api#documentation": "

Matches attributes derived from the request.

" } + }, + "SamplingRateBoost": { + "target": "com.amazonaws.xray#SamplingRateBoost", + "traits": { + "smithy.api#documentation": "

Specifies the multiplier applied to the base sampling rate.\n This boost allows you to temporarily increase sampling without changing the rule's configuration.

" + } } }, "traits": { @@ -5514,6 +5637,12 @@ "traits": { "smithy.api#documentation": "

Matches attributes derived from the request.

" } + }, + "SamplingRateBoost": { + "target": "com.amazonaws.xray#SamplingRateBoost", + "traits": { + "smithy.api#documentation": "

Specifies the multiplier applied to the base sampling rate.\n This boost allows you to temporarily increase sampling without changing the rule's configuration.

" + } } }, "traits": { @@ -5701,6 +5830,12 @@ "traits": { "smithy.api#documentation": "

The number of seconds for the service to wait before getting sampling targets\n again.

" } + }, + "SamplingBoost": { + "target": "com.amazonaws.xray#SamplingBoost", + "traits": { + "smithy.api#documentation": "

The sampling boost that X-Ray allocated for this service.

" + } } }, "traits": { @@ -6012,7 +6147,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Initiates a trace retrieval process using the specified time range and for the give trace IDs on Transaction Search generated by the CloudWatch log group. For more information, see Transaction Search.\n

\n

API returns a RetrievalToken, which can be used with ListRetrievedTraces or GetRetrievedTracesGraph to fetch results. Retrievals will time out after 60 minutes. To execute long time ranges, consider segmenting into multiple retrievals.

\n

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to retrieve data from a linked source account, as long as both accounts have transaction search enabled.

\n

For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see BatchGetTraces.

", + "smithy.api#documentation": "

\n Initiates a trace retrieval process using the specified time range and for the given trace IDs in the Transaction Search generated CloudWatch log group. For more information, see Transaction Search.\n

\n

API returns a RetrievalToken, which can be used with ListRetrievedTraces or GetRetrievedTracesGraph to fetch results. Retrievals will time out after 60 minutes. To execute long time ranges, consider segmenting into multiple retrievals.

\n

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to retrieve data from a linked source account, as long as both accounts have transaction search enabled.

\n

For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see BatchGetTraces.

", "smithy.api#http": { "method": "POST", "uri": "/StartTraceRetrieval", @@ -6343,6 +6478,15 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.xray#TotalCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.xray#Trace": { "type": "structure", "members": { @@ -6355,7 +6499,7 @@ "Duration": { "target": "com.amazonaws.xray#NullableDouble", "traits": { - "smithy.api#documentation": "

The length of time in seconds between the start time of the root segment and the end\n time of the last segment that completed.

" + "smithy.api#documentation": "

The length of time in seconds between the start time of the earliest segment that started and the end time of the last segment that completed.

" } }, "LimitExceeded": { @@ -6516,7 +6660,7 @@ "Duration": { "target": "com.amazonaws.xray#NullableDouble", "traits": { - "smithy.api#documentation": "

The length of time in seconds between the start time of the root segment and the end\n time of the last segment that completed.

" + "smithy.api#documentation": "

The length of time in seconds between the start time of the earliest segment that started and the end time of the last segment that completed.

" } }, "ResponseTime": { diff --git a/codegen/sdk/packages.json b/codegen/sdk/packages.json index 6f83a7bddb9..b1b13fda0db 100644 --- a/codegen/sdk/packages.json +++ b/codegen/sdk/packages.json @@ -198,6 +198,12 @@ "artifactName": "autoscalingplans", "brazilName": "AwsSdkKotlinAutoScalingPlans" }, + { + "sdkId": "BCM Dashboards", + "namespace": "aws.sdk.kotlin.services.bcmdashboards", + "artifactName": "bcmdashboards", + "brazilName": "AwsSdkKotlinBcmDashboards" + }, { "sdkId": "BCM Data Exports", "namespace": "aws.sdk.kotlin.services.bcmdataexports", @@ -210,6 +216,12 @@ "artifactName": "bcmpricingcalculator", "brazilName": "AwsSdkKotlinBcmPricingCalculator" }, + { + "sdkId": "BCM Recommended Actions", + "namespace": "aws.sdk.kotlin.services.bcmrecommendedactions", + "artifactName": "bcmrecommendedactions", + "brazilName": "AwsSdkKotlinBcmRecommendedActions" + }, { "sdkId": "Backup", "namespace": "aws.sdk.kotlin.services.backup", @@ -1542,18 +1554,6 @@ "artifactName": "opensearchserverless", "brazilName": "AwsSdkKotlinOpensearchserverless" }, - { - "sdkId": "OpsWorks", - "namespace": "aws.sdk.kotlin.services.opsworks", - "artifactName": "opsworks", - "brazilName": "AwsSdkKotlinOpsworks" - }, - { - "sdkId": "OpsWorksCM", - "namespace": "aws.sdk.kotlin.services.opsworkscm", - "artifactName": "opsworkscm", - "brazilName": "AwsSdkKotlinOpsworkscm" - }, { "sdkId": "Organizations", "namespace": "aws.sdk.kotlin.services.organizations", @@ -1884,12 +1884,6 @@ "artifactName": "sfn", "brazilName": "AwsSdkKotlinSfn" }, - { - "sdkId": "SMS", - "namespace": "aws.sdk.kotlin.services.sms", - "artifactName": "sms", - "brazilName": "AwsSdkKotlinSms" - }, { "sdkId": "SNS", "namespace": "aws.sdk.kotlin.services.sns", diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md index 84f3b76bba7..b9e522def57 100644 --- a/docs/GettingStarted.md +++ b/docs/GettingStarted.md @@ -54,7 +54,7 @@ Consult the [stability guide](../VERSIONING.md#stability-of-the-aws-sdk-for-kotl ## Additional Resources -* [Additional examples](https://github.com/awslabs/aws-sdk-kotlin/tree/main/examples) -* [Getting started](https://github.com/awslabs/aws-sdk-kotlin#getting-started) +* [Additional examples](https://github.com/aws/aws-sdk-kotlin/tree/main/examples) +* [Getting started](https://github.com/aws/aws-sdk-kotlin#getting-started) * [Debugging](debugging.md) * [Android support](targets.md#android) diff --git a/docs/generate-sdk.md b/docs/generate-sdk.md index f2d0b8f8f38..0f280786fe2 100644 --- a/docs/generate-sdk.md +++ b/docs/generate-sdk.md @@ -18,7 +18,7 @@ In this example we'll build the AWS DynamoDB SDK. ### Clone this repo ```sh -git clone https://github.com/awslabs/aws-sdk-kotlin.git +git clone https://github.com/aws/aws-sdk-kotlin.git cd aws-sdk-kotlin ``` @@ -75,5 +75,5 @@ dependencies { ## Summary This page covers building an AWS SDK using the `aws-sdk-kotlin` SDK generator. If you experience problems please [file -an issue](https://github.com/awslabs/aws-sdk-kotlin/issues). If you have questions or ideas about how we can improve our -SDKs, please join [our discussions](https://github.com/awslabs/aws-sdk-kotlin/discussions). \ No newline at end of file +an issue](https://github.com/aws/aws-sdk-kotlin/issues). If you have questions or ideas about how we can improve our +SDKs, please join [our discussions](https://github.com/aws/aws-sdk-kotlin/discussions). \ No newline at end of file diff --git a/examples/cloudwatch-logs-graalvm/src/main/kotlin/Main.kt b/examples/cloudwatch-logs-graalvm/src/main/kotlin/Main.kt index 1b23bd43e36..5375a73eee5 100644 --- a/examples/cloudwatch-logs-graalvm/src/main/kotlin/Main.kt +++ b/examples/cloudwatch-logs-graalvm/src/main/kotlin/Main.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.example import aws.sdk.kotlin.services.cloudwatchlogs.CloudWatchLogsClient diff --git a/gradle.properties b/gradle.properties index c0b7cf3837b..d6a6809625e 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,10 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx10g -XX:MaxMetaspaceSize=2G # sdk -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/ +sdkVersion=1.5.53-SNAPSHOT # atomicfu kotlinx.atomicfu.enableJvmIrTransformation=true diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 93018447b1b..6bdb4049058 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -4,7 +4,7 @@ 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.30-kn" +aws-kotlin-repo-tools-version = "0.4.58" # libs coroutines-version = "1.10.2" @@ -12,8 +12,8 @@ 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.5.4-SNAPSHOT" -smithy-kotlin-codegen-version = "0.35.4-SNAPSHOT" +smithy-kotlin-runtime-version = "1.5.11" +smithy-kotlin-codegen-version = "0.35.11" # codegen smithy-version = "1.60.2" diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index bf3beeb7dd3..4ba2524eb95 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https://services.gradle.org/distributions/gradle-8.14.2-bin.zip +distributionUrl=https://services.gradle.org/distributions/gradle-9.0.0-bin.zip networkTimeout=10000 zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/hll/build.gradle.kts b/hll/build.gradle.kts index db502ca86e0..7b16a91885f 100644 --- a/hll/build.gradle.kts +++ b/hll/build.gradle.kts @@ -3,8 +3,9 @@ * SPDX-License-Identifier: Apache-2.0 */ -import aws.sdk.kotlin.gradle.dsl.configurePublishing -import aws.sdk.kotlin.gradle.kmp.* +import aws.sdk.kotlin.gradle.dsl.configureNexusPublishing +import aws.sdk.kotlin.gradle.kmp.kotlin +import aws.sdk.kotlin.gradle.kmp.needsKmpConfigured import org.jetbrains.kotlin.gradle.dsl.JvmTarget description = "High-level libraries for the AWS SDK for Kotlin" @@ -45,7 +46,8 @@ val hllPreviewVersion = if (sdkVersion.contains("-SNAPSHOT")) { // e.g. 1.3.29-b subprojects { group = "aws.sdk.kotlin" version = hllPreviewVersion - configurePublishing("aws-sdk-kotlin") + // TODO Use configurePublishing when migrating to Sonatype Publisher API / JReleaser + configureNexusPublishing("aws-sdk-kotlin") } subprojects { diff --git a/hll/dynamodb-mapper/dynamodb-mapper-codegen/src/main/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/codegen/model/MapperTypes.kt b/hll/dynamodb-mapper/dynamodb-mapper-codegen/src/main/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/codegen/model/MapperTypes.kt index 6b8d38c2fca..06860dbf113 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper-codegen/src/main/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/codegen/model/MapperTypes.kt +++ b/hll/dynamodb-mapper/dynamodb-mapper-codegen/src/main/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/codegen/model/MapperTypes.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.hll.dynamodbmapper.codegen.model import aws.sdk.kotlin.hll.codegen.model.Type diff --git a/hll/dynamodb-mapper/dynamodb-mapper-ops-codegen/build.gradle.kts b/hll/dynamodb-mapper/dynamodb-mapper-ops-codegen/build.gradle.kts index 32160f166e1..6806b439851 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper-ops-codegen/build.gradle.kts +++ b/hll/dynamodb-mapper/dynamodb-mapper-ops-codegen/build.gradle.kts @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + /* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0 diff --git a/hll/dynamodb-mapper/dynamodb-mapper-schema-codegen/build.gradle.kts b/hll/dynamodb-mapper/dynamodb-mapper-schema-codegen/build.gradle.kts index b5a14e2a01e..202f5a60899 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper-schema-codegen/build.gradle.kts +++ b/hll/dynamodb-mapper/dynamodb-mapper-schema-codegen/build.gradle.kts @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + /* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0 diff --git a/hll/dynamodb-mapper/dynamodb-mapper-schema-codegen/src/main/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/codegen/annotations/AnnotationsProcessorOptions.kt b/hll/dynamodb-mapper/dynamodb-mapper-schema-codegen/src/main/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/codegen/annotations/AnnotationsProcessorOptions.kt index aa8954422a9..308e29e4ff9 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper-schema-codegen/src/main/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/codegen/annotations/AnnotationsProcessorOptions.kt +++ b/hll/dynamodb-mapper/dynamodb-mapper-schema-codegen/src/main/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/codegen/annotations/AnnotationsProcessorOptions.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.hll.dynamodbmapper.codegen.annotations import aws.smithy.kotlin.runtime.collections.AttributeKey diff --git a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/build.gradle.kts b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/build.gradle.kts index 600a93c0929..f6ed5994105 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/build.gradle.kts +++ b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/build.gradle.kts @@ -33,8 +33,8 @@ dependencies { } gradlePlugin { - website = "https://github.com/awslabs/aws-sdk-kotlin" - vcsUrl = "https://github.com/awslabs/aws-sdk-kotlin.git" + website = "https://github.com/aws/aws-sdk-kotlin" + vcsUrl = "https://github.com/aws/aws-sdk-kotlin.git" plugins { create("dynamodb-mapper-schema-generator") { id = "aws.sdk.kotlin.hll.dynamodbmapper.schema.generator" diff --git a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/main/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPluginExtension.kt b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/main/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPluginExtension.kt index 590d848e463..ba317f015e9 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/main/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPluginExtension.kt +++ b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/main/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPluginExtension.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.hll.dynamodbmapper.plugins import aws.sdk.kotlin.hll.codegen.rendering.Visibility diff --git a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPluginTest.kt b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPluginTest.kt index 42601bebbeb..ac261b9fb4f 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPluginTest.kt +++ b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPluginTest.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.hll.dynamodbmapper.plugins import org.gradle.testkit.runner.GradleRunner diff --git a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/BuilderNotRequired.kt b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/BuilderNotRequired.kt index 2861b2c8f6d..b4901ccc67a 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/BuilderNotRequired.kt +++ b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/BuilderNotRequired.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package org.example import aws.sdk.kotlin.hll.dynamodbmapper.DynamoDbAttribute diff --git a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/IgnoredProperty.kt b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/IgnoredProperty.kt index ff9c091258a..28a3a5b7500 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/IgnoredProperty.kt +++ b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/IgnoredProperty.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package org.example import aws.sdk.kotlin.hll.dynamodbmapper.DynamoDbAttribute diff --git a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/RenamedPartitionKey.kt b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/RenamedPartitionKey.kt index e507c9af815..78a04a2cd49 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/RenamedPartitionKey.kt +++ b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/RenamedPartitionKey.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package org.example import aws.sdk.kotlin.hll.dynamodbmapper.DynamoDbAttribute diff --git a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/User.kt b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/User.kt index 65cbdea0620..1dfbc76281b 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/User.kt +++ b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/User.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package org.example import aws.sdk.kotlin.hll.dynamodbmapper.DynamoDbAttribute diff --git a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/custom-item-converter/CustomItemConverter.kt b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/custom-item-converter/CustomItemConverter.kt index abe58305992..0cbe80001a2 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/custom-item-converter/CustomItemConverter.kt +++ b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/custom-item-converter/CustomItemConverter.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package my.custom.item.converter import aws.sdk.kotlin.hll.dynamodbmapper.items.AttributeDescriptor diff --git a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/custom-item-converter/CustomUser.kt b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/custom-item-converter/CustomUser.kt index 75fe3234cdb..b47aca28c04 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/custom-item-converter/CustomUser.kt +++ b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/src/test/resources/custom-item-converter/CustomUser.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package org.example import aws.sdk.kotlin.hll.dynamodbmapper.DynamoDbItem diff --git a/hll/dynamodb-mapper/dynamodb-mapper/build.gradle.kts b/hll/dynamodb-mapper/dynamodb-mapper/build.gradle.kts index 53ad4cd2875..a8f3af51954 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper/build.gradle.kts +++ b/hll/dynamodb-mapper/dynamodb-mapper/build.gradle.kts @@ -113,7 +113,7 @@ if (project.NATIVE_ENABLED) { } } - listOf("jvmSourcesJar", "metadataSourcesJar").forEach { + listOf("jvmSourcesJar", "metadataSourcesJar", "jvmProcessResources").forEach { tasks.named(it) { dependsOn(moveGenSrc) } diff --git a/hll/dynamodb-mapper/dynamodb-mapper/jvm/test/aws/sdk/kotlin/hll/dynamodbmapper/operations/PaginatedScanTest.kt b/hll/dynamodb-mapper/dynamodb-mapper/jvm/test/aws/sdk/kotlin/hll/dynamodbmapper/operations/PaginatedScanTest.kt index 17870798ee9..71acfb4034d 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper/jvm/test/aws/sdk/kotlin/hll/dynamodbmapper/operations/PaginatedScanTest.kt +++ b/hll/dynamodb-mapper/dynamodb-mapper/jvm/test/aws/sdk/kotlin/hll/dynamodbmapper/operations/PaginatedScanTest.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.hll.dynamodbmapper.operations import aws.sdk.kotlin.hll.dynamodbmapper.items.* diff --git a/hll/hll-codegen/build.gradle.kts b/hll/hll-codegen/build.gradle.kts index 12769452a1f..19c65cade4b 100644 --- a/hll/hll-codegen/build.gradle.kts +++ b/hll/hll-codegen/build.gradle.kts @@ -30,11 +30,7 @@ dependencies { api(project(":aws-runtime:aws-core")) implementation(libs.ksp.api) implementation(libs.smithy.kotlin.runtime.core) - - testImplementation(libs.junit.jupiter) - testImplementation(libs.junit.jupiter.params) - testImplementation(libs.kotest.assertions.core.jvm) - testImplementation(libs.kotlin.test.junit5) + testImplementation(kotlin("test")) } val sourcesJar by tasks.creating(Jar::class) { diff --git a/hll/hll-codegen/src/main/kotlin/aws/sdk/kotlin/hll/codegen/model/Types.kt b/hll/hll-codegen/src/main/kotlin/aws/sdk/kotlin/hll/codegen/model/Types.kt index 64400b17a79..ec38a7405f3 100644 --- a/hll/hll-codegen/src/main/kotlin/aws/sdk/kotlin/hll/codegen/model/Types.kt +++ b/hll/hll-codegen/src/main/kotlin/aws/sdk/kotlin/hll/codegen/model/Types.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.hll.codegen.model import aws.sdk.kotlin.runtime.InternalSdkApi diff --git a/hll/hll-codegen/src/main/kotlin/aws/sdk/kotlin/hll/codegen/rendering/BuilderRenderer.kt b/hll/hll-codegen/src/main/kotlin/aws/sdk/kotlin/hll/codegen/rendering/BuilderRenderer.kt index d14733105f4..0bf676c1fb6 100644 --- a/hll/hll-codegen/src/main/kotlin/aws/sdk/kotlin/hll/codegen/rendering/BuilderRenderer.kt +++ b/hll/hll-codegen/src/main/kotlin/aws/sdk/kotlin/hll/codegen/rendering/BuilderRenderer.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.hll.codegen.rendering import aws.sdk.kotlin.hll.codegen.core.CodeGenerator @@ -65,7 +70,9 @@ public class BuilderRenderer( private fun renderProperty(member: Member) { val dslInfo = member.dslInfo - if (dslInfo != null) blankLine() + if (dslInfo != null) { + blankLine() + } write("#Lvar #L: #T = null", ctx.attributes.visibility, member.name, member.type.nullable()) diff --git a/hll/hll-codegen/src/main/kotlin/aws/sdk/kotlin/hll/codegen/rendering/RenderOptions.kt b/hll/hll-codegen/src/main/kotlin/aws/sdk/kotlin/hll/codegen/rendering/RenderOptions.kt index 514988feee5..fa062084e59 100644 --- a/hll/hll-codegen/src/main/kotlin/aws/sdk/kotlin/hll/codegen/rendering/RenderOptions.kt +++ b/hll/hll-codegen/src/main/kotlin/aws/sdk/kotlin/hll/codegen/rendering/RenderOptions.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.hll.codegen.rendering import aws.smithy.kotlin.runtime.collections.AttributeKey diff --git a/hll/hll-codegen/src/test/kotlin/aws/sdk/kotlin/hll/codegen/core/TemplateEngineTest.kt b/hll/hll-codegen/src/test/kotlin/aws/sdk/kotlin/hll/codegen/core/TemplateEngineTest.kt index c853b989f7f..d4c87b7ca40 100644 --- a/hll/hll-codegen/src/test/kotlin/aws/sdk/kotlin/hll/codegen/core/TemplateEngineTest.kt +++ b/hll/hll-codegen/src/test/kotlin/aws/sdk/kotlin/hll/codegen/core/TemplateEngineTest.kt @@ -4,8 +4,8 @@ */ package aws.sdk.kotlin.hll.codegen.core -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Test +import kotlin.test.Test +import kotlin.test.assertEquals import kotlin.test.assertFailsWith class TemplateEngineTest { diff --git a/hll/hll-codegen/src/test/kotlin/aws/sdk/kotlin/hll/codegen/core/TemplateProcessorTest.kt b/hll/hll-codegen/src/test/kotlin/aws/sdk/kotlin/hll/codegen/core/TemplateProcessorTest.kt index ffc793866f7..36beab13464 100644 --- a/hll/hll-codegen/src/test/kotlin/aws/sdk/kotlin/hll/codegen/core/TemplateProcessorTest.kt +++ b/hll/hll-codegen/src/test/kotlin/aws/sdk/kotlin/hll/codegen/core/TemplateProcessorTest.kt @@ -6,9 +6,9 @@ package aws.sdk.kotlin.hll.codegen.core import aws.sdk.kotlin.hll.codegen.model.TypeRef import aws.sdk.kotlin.hll.codegen.model.TypeVar -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Test +import kotlin.test.Test import kotlin.test.assertContains +import kotlin.test.assertEquals class TemplateProcessorTest { @Test diff --git a/hll/hll-codegen/src/test/kotlin/aws/sdk/kotlin/hll/codegen/util/StringsTest.kt b/hll/hll-codegen/src/test/kotlin/aws/sdk/kotlin/hll/codegen/util/StringsTest.kt index c2f85036c6d..b630ce18956 100644 --- a/hll/hll-codegen/src/test/kotlin/aws/sdk/kotlin/hll/codegen/util/StringsTest.kt +++ b/hll/hll-codegen/src/test/kotlin/aws/sdk/kotlin/hll/codegen/util/StringsTest.kt @@ -4,8 +4,8 @@ */ package aws.sdk.kotlin.hll.codegen.util -import org.junit.jupiter.api.Assertions.assertEquals -import org.junit.jupiter.api.Test +import kotlin.test.Test +import kotlin.test.assertEquals class StringsTest { @Test diff --git a/hll/hll-mapping-core/build.gradle.kts b/hll/hll-mapping-core/build.gradle.kts index b7c2dc41027..7f3f61454d1 100644 --- a/hll/hll-mapping-core/build.gradle.kts +++ b/hll/hll-mapping-core/build.gradle.kts @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + import aws.sdk.kotlin.gradle.kmp.kotlin /* diff --git a/services/bedrock/common/test/aws/sdk/kotlin/services/bedrock/BedrockEnvironmentBearerTokenTest.kt b/services/bedrock/common/test/aws/sdk/kotlin/services/bedrock/BedrockEnvironmentBearerTokenTest.kt index bd6f48f7b1f..28b12cb9bf4 100644 --- a/services/bedrock/common/test/aws/sdk/kotlin/services/bedrock/BedrockEnvironmentBearerTokenTest.kt +++ b/services/bedrock/common/test/aws/sdk/kotlin/services/bedrock/BedrockEnvironmentBearerTokenTest.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.services.bedrock import aws.sdk.kotlin.services.bedrock.auth.finalizeBearerTokenConfig @@ -15,17 +20,18 @@ import aws.smithy.kotlin.runtime.http.engine.HttpClientEngineBase import aws.smithy.kotlin.runtime.http.engine.HttpClientEngineConfig import aws.smithy.kotlin.runtime.http.request.HttpRequest import aws.smithy.kotlin.runtime.http.response.HttpResponse -import aws.smithy.kotlin.runtime.io.use import aws.smithy.kotlin.runtime.operation.ExecutionContext import aws.smithy.kotlin.runtime.time.Instant import aws.smithy.kotlin.runtime.util.TestPlatformProvider import kotlinx.coroutines.test.runTest +import kotlin.test.Test import kotlin.test.assertEquals import kotlin.test.assertNotNull +import kotlin.test.assertTrue class BedrockEnvironmentBearerTokenTest { - private fun mockHttpClient(handler: (HttpRequest) -> HttpResponse): HttpClientEngine { - return object : HttpClientEngineBase("test engine") { + private fun mockHttpClient(handler: (HttpRequest) -> HttpResponse): HttpClientEngine = + object : HttpClientEngineBase("test engine") { override val config: HttpClientEngineConfig = HttpClientEngineConfig.Default override suspend fun roundTrip(context: ExecutionContext, request: HttpRequest): HttpCall { @@ -33,41 +39,66 @@ class BedrockEnvironmentBearerTokenTest { return HttpCall(request, response, Instant.now(), Instant.now()) } } - } private val mockPlatformProvider = TestPlatformProvider( env = mapOf("AWS_BEARER_TOKEN_BEDROCK" to "bedrock-token"), ) + @Test fun testAuthSchemePreferenceConfigured() = runTest { - val builder = BedrockClient.Builder() val expectedAuthSchemePreference = listOf(AuthSchemeId.HttpBearer) + val builder = BedrockClient.Builder() + finalizeBearerTokenConfig(builder, mockPlatformProvider) + assertEquals(expectedAuthSchemePreference, builder.config.authSchemePreference) } + @Test fun testBearerAuthSchemePromotedToFirst() = runTest { + val expectedAuthSchemePreference = listOf(AuthSchemeId.HttpBearer, AuthSchemeId.AwsSigV4) val builder = BedrockClient.Builder() + builder.config.authSchemePreference = listOf(AuthSchemeId.AwsSigV4) finalizeBearerTokenConfig(builder, mockPlatformProvider) - val expectedAuthSchemePreference = listOf(AuthSchemeId.HttpBearer, AuthSchemeId.AwsSigV4) assertEquals(expectedAuthSchemePreference, builder.config.authSchemePreference) builder.config.authSchemePreference = listOf(AuthSchemeId.AwsSigV4, AuthSchemeId.HttpBearer) + finalizeBearerTokenConfig(builder, mockPlatformProvider) assertEquals(expectedAuthSchemePreference, builder.config.authSchemePreference) } + @Test fun testBearerTokenProviderConfigured() = runTest { val builder = BedrockClient.Builder() finalizeBearerTokenConfig(builder, mockPlatformProvider) + assertNotNull(builder.config.bearerTokenProvider) val token = builder.config.bearerTokenProvider!!.resolve() assertNotNull(token) assertEquals("bedrock-token", token.token) } + @Test + fun testBearerTokenSourcingPrecedence() = runTest { + val builder = BedrockClient.Builder() + + finalizeBearerTokenConfig( + builder, + TestPlatformProvider( + env = mapOf("AWS_BEARER_TOKEN_BEDROCK" to "env-bedrock-token"), + props = mapOf("aws.bearerTokenBedrock" to "sys-props-bedrock-token"), + ), + ) + + val token = builder.config.bearerTokenProvider!!.resolve() + assertEquals("sys-props-bedrock-token", token.token) + } + + @Test fun testExplicitProviderTakesPrecedence() = runTest { val builder = BedrockClient.Builder() + builder.config.bearerTokenProvider = object : BearerTokenProvider { override suspend fun resolve(attributes: Attributes): BearerToken = object : BearerToken { override val token: String = "different-bedrock-token" @@ -75,20 +106,22 @@ class BedrockEnvironmentBearerTokenTest { override val expiration: Instant? = null } } + finalizeBearerTokenConfig(builder, mockPlatformProvider) + assertNotNull(builder.config.bearerTokenProvider) val token = builder.config.bearerTokenProvider!!.resolve() assertNotNull(token) assertEquals("different-bedrock-token", token.token) } + @Test fun testBearerTokenProviderFunctionality() = runTest { var capturedAuthHeader: String? = null - BedrockClient.fromEnvironment { - region = "us-west-2" - httpClient = mockHttpClient { request -> - // Capture the Authorization header + val builder = BedrockClient.Builder().apply { + config.region = "us-west-2" + config.httpClient = mockHttpClient { request -> capturedAuthHeader = request.headers["Authorization"] HttpResponse( status = HttpStatusCode.OK, @@ -96,12 +129,44 @@ class BedrockEnvironmentBearerTokenTest { body = HttpBody.Empty, ) } - }.use { client -> - // Make an api call to capture Authorization header - client.listFoundationModels() + } + + finalizeBearerTokenConfig(builder, mockPlatformProvider) + + val testClient = builder.build() + // Make an api call to capture Authorization header + testClient.listFoundationModels() - assertNotNull(capturedAuthHeader) - assertEquals("Bearer bedrock-token", capturedAuthHeader) + assertNotNull(capturedAuthHeader) + assertEquals("Bearer bedrock-token", capturedAuthHeader) + } + + @Test + fun testBusinessMetricEmitted() = runTest { + var capturedUserAgent: String? = null + + val builder = BedrockClient.Builder().apply { + config.region = "us-west-2" + config.httpClient = mockHttpClient { request -> + capturedUserAgent = request.headers["User-Agent"] + HttpResponse( + status = HttpStatusCode.OK, + headers = Headers.Empty, + body = HttpBody.Empty, + ) + } } + + finalizeBearerTokenConfig(builder, mockPlatformProvider) + + val testClient = builder.build() + // Make an api call to capture User-Agent header + testClient.listFoundationModels() + + assertNotNull(capturedUserAgent) + val capturedBusinessMetrics = Regex("m/([^\\s]+)").find(capturedUserAgent!!)?.value + assertNotNull(capturedBusinessMetrics) + // Check User-Agent header contains the business metric + assertTrue(capturedBusinessMetrics.contains("3")) } } diff --git a/services/build.gradle.kts b/services/build.gradle.kts index 2f39727e29b..9f309d2b671 100644 --- a/services/build.gradle.kts +++ b/services/build.gradle.kts @@ -2,8 +2,8 @@ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0 */ -import aws.sdk.kotlin.gradle.dsl.configurePublishing -import aws.sdk.kotlin.gradle.kmp.kotlin +import aws.sdk.kotlin.gradle.dsl.configureNexusPublishing +import aws.sdk.kotlin.gradle.kmp.* import aws.sdk.kotlin.gradle.util.typedProp import org.jetbrains.kotlin.gradle.dsl.JvmTarget import java.time.LocalDateTime @@ -138,7 +138,9 @@ subprojects { } } - configurePublishing("aws-sdk-kotlin") + // TODO Use configurePublishing when migrating to Sonatype Publisher API / JReleaser + configureNexusPublishing("aws-sdk-kotlin") + publishing { publications.all { if (this !is MavenPublication) return@all diff --git a/services/route53/e2eTest/src/Route53UriTest.kt b/services/route53/e2eTest/src/Route53UriTest.kt index 6ec9e6ac25d..0d9de9b4a66 100644 --- a/services/route53/e2eTest/src/Route53UriTest.kt +++ b/services/route53/e2eTest/src/Route53UriTest.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.services.route53 import aws.sdk.kotlin.runtime.auth.credentials.StaticCredentialsProvider diff --git a/services/s3/e2eTest/src/S3ChecksumTest.kt b/services/s3/e2eTest/src/S3ChecksumTest.kt index cf0df9ba826..e5814d2dcc8 100644 --- a/services/s3/e2eTest/src/S3ChecksumTest.kt +++ b/services/s3/e2eTest/src/S3ChecksumTest.kt @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + package aws.sdk.kotlin.e2etest import aws.sdk.kotlin.e2etest.S3TestUtils.deleteBucketContents diff --git a/services/s3/e2eTest/src/S3IntegrationTest.kt b/services/s3/e2eTest/src/S3IntegrationTest.kt index 67a5bd75391..bc2ccb7af0e 100644 --- a/services/s3/e2eTest/src/S3IntegrationTest.kt +++ b/services/s3/e2eTest/src/S3IntegrationTest.kt @@ -244,60 +244,6 @@ class S3BucketOpsIntegrationTest { } } - @Test - fun testSelectObjectEventStream(): Unit = runBlocking { - // upload our content to select from - val objKey = "developers.csv" - - val content = """ - Name,PhoneNumber,City,Occupation - Sam,(949) 555-6701,Irvine,Solutions Architect - Vinod,(949) 555-6702,Los Angeles,Solutions Architect - Jeff,(949) 555-6703,Seattle,AWS Evangelist - Jane,(949) 555-6704,Chicago,Developer - Sean,(949) 555-6705,Indianapolis,Developer - Mary,(949) 555-6706,Detroit,Developer - Kate,(949) 555-6707,Boston,Solutions Architect - """.trimIndent() - - client.putObject { - bucket = testBucket - key = objKey - body = ByteStream.fromString(content) - } - - // select content as an event stream - val req = SelectObjectContentRequest { - bucket = testBucket - key = objKey - expressionType = ExpressionType.Sql - expression = """SELECT * FROM s3object s where s."Name" = 'Jane'""" - inputSerialization { - csv { - fileHeaderInfo = FileHeaderInfo.Use - } - compressionType = CompressionType.None - } - outputSerialization { - csv { } - } - } - - val events = client.selectObjectContent(req) { resp -> - // collect flow to list - resp.payload!!.toList() - } - - assertEquals(3, events.size) - - val records = assertIs(events[0]) - assertIs(events[1]) - assertIs(events[2]) - - val expectedRecord = "Jane,(949) 555-6704,Chicago,Developer\n" - assertEquals(expectedRecord, records.value.payload?.decodeToString()) - } - @Test fun testPutObjectWithChecksum(): Unit = runBlocking { val contents = "AAAAAAAAAA" diff --git a/settings.gradle.kts b/settings.gradle.kts index 6dc165db0f0..826adedd84d 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -30,6 +30,13 @@ dependencyResolutionManagement { repositories { mavenLocal() mavenCentral() + maven { + name = "kotlinRepoTools" + url = java.net.URI("https://d2gys1nrxnjnyg.cloudfront.net/releases") + content { + includeGroupByRegex("""aws\.sdk\.kotlin.*""") + } + } } } @@ -80,7 +87,6 @@ if ("dynamodb".isBootstrappedService) { include(":hll:dynamodb-mapper:dynamodb-mapper-schema-codegen") include(":hll:dynamodb-mapper:dynamodb-mapper-annotations") include(":hll:dynamodb-mapper:dynamodb-mapper-schema-generator-plugin") - include(":hll:dynamodb-mapper:tests:dynamodb-mapper-schema-generator-plugin-test") } else { logger.warn(":services:dynamodb is not bootstrapped, skipping :hll:dynamodb-mapper and subprojects") } diff --git a/tests/codegen/build.gradle.kts b/tests/codegen/build.gradle.kts index ecdae5f6ccc..c193c20c26d 100644 --- a/tests/codegen/build.gradle.kts +++ b/tests/codegen/build.gradle.kts @@ -1,3 +1,8 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ + import aws.sdk.kotlin.gradle.codegen.dsl.generateSmithyProjections plugins { diff --git a/tests/codegen/checksums/build.gradle.kts b/tests/codegen/checksums/build.gradle.kts index 6e7795fe4a6..a15cd29fe02 100644 --- a/tests/codegen/checksums/build.gradle.kts +++ b/tests/codegen/checksums/build.gradle.kts @@ -1,3 +1,7 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ import aws.sdk.kotlin.gradle.codegen.dsl.smithyKotlinPlugin import aws.sdk.kotlin.gradle.codegen.smithyKotlinProjectionSrcDir @@ -6,12 +10,10 @@ import aws.sdk.kotlin.tests.codegen.Model description = "AWS SDK for Kotlin's checksums codegen test suite" -val tests = listOf( - CodegenTest("checksums", Model("checksums.smithy"), "aws.sdk.kotlin.test#TestService"), -) - smithyBuild { - this@Build_gradle.tests.forEach { test -> + listOf( + CodegenTest("checksums", Model("checksums.smithy"), "aws.sdk.kotlin.test#TestService"), + ).forEach { test -> projections.register(test.name) { imports = listOf(layout.projectDirectory.file(test.model.path + test.model.fileName).asFile.absolutePath) smithyKotlinPlugin {